Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Grades Docs #119

Open
1 of 4 tasks
ramanxg opened this issue Nov 29, 2021 · 5 comments
Open
1 of 4 tasks

Update Grades Docs #119

ramanxg opened this issue Nov 29, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation good first task Good for newcomers help wanted Extra attention is needed Story Point 2 Small UI Change, or bugfix. No new tests are required.

Comments

@ramanxg
Copy link
Member

ramanxg commented Nov 29, 2021

At ZotHacks, a project used our API for the grades data. However, even though it might have been easier to use the calculated version, they used the raw version and calculated it themselves. It's a little unclear what the /grades/calculated endpoint does, and we could help it by adding more details about it, or even moving it to the top before the /grades/raw.

TODO:

  • move /grades/calculated above /grades/raw
  • Add to Exclude P/NP to be Exclude classes taken only P/NP.
  • Specify /grades/calculated creates sum aggregates for the numbers.
  • Repeat the list of parameters rather than saying it is elsewhere.
@ramanxg ramanxg added documentation Improvements or additions to documentation good first task Good for newcomers Story Point 2 Small UI Change, or bugfix. No new tests are required. labels Nov 29, 2021
@ileenf ileenf assigned ileenf and unassigned ileenf Jan 21, 2022
@ramanxg ramanxg added the help wanted Extra attention is needed label Jan 22, 2022
@snopachinda-gpi
Copy link

Hello! Would this be open to those outside of UCI? The API looks fun and I would be willing to help out with documentation.

@ramanxg
Copy link
Member Author

ramanxg commented Jan 27, 2022

If you could help out that would be awesome. Issues labeled help wanted are open to any developer.

@snopachinda-gpi
Copy link

Sure! Feel free to assign me. I will make a pull request over the weekend.

@ramanxg
Copy link
Member Author

ramanxg commented Jan 31, 2022

So sorry!!! Unfortunately, we want to have issues for some of our upcoming student developers at UCI, who are new to web dev and open source.

@snopachinda-gpi
Copy link

No problem! Let me know if you'd like my help on other issues like SQL and such. I develop APIs for big data so I'd be happy to take a look :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first task Good for newcomers help wanted Extra attention is needed Story Point 2 Small UI Change, or bugfix. No new tests are required.
Projects
Status: Fellowship Tasks
Development

No branches or pull requests

4 participants