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

Write more complete API documentation #31

Open
ErikBoesen opened this issue Feb 21, 2021 · 3 comments
Open

Write more complete API documentation #31

ErikBoesen opened this issue Feb 21, 2021 · 3 comments
Labels
api documentation Improvements or additions to documentation

Comments

@ErikBoesen
Copy link
Collaborator

ErikBoesen commented Feb 21, 2021

I think it would be really cool to have a Swagger docs system like this, where you can test the API in-browser and see what the responses are like. At minimum we should document the filters endpoint and add a list of fields Person has.

@ErikBoesen ErikBoesen added api documentation Improvements or additions to documentation labels Feb 21, 2021
@Redorhcs Redorhcs self-assigned this Nov 7, 2022
@Redorhcs
Copy link
Contributor

Redorhcs commented Nov 8, 2022

Hey Erik - was looking into this (and I think I've mentioned about wanting to pick this up) and had a few ideas at least for a v0 if we can't do something like swagger itself:

  • The current pageview has a lot of whitespace on non-mobile clients (where someone is likely to get api info from)

image

- It might make more sense to give examples beyond what we have already, something like "People" and give an example in JSON / js-yalies / python-yalies, and then dive further into the filters endpoint and fields that get returned
  • (continuing from ^ documenting how you can do multiple NetIDs at once would've been awesome to know!)

  • For groups, is yaleorgs.com still the endpoint or should we cut that over to yalies.io/api/groups ?

@ErikBoesen
Copy link
Collaborator Author

Agree with all of this. yaleorgs.com is deprecated, we need to fix the endpoint referenced in the docs, that's my mistake

@Redorhcs
Copy link
Contributor

Redorhcs commented Nov 8, 2022

That’s ok! I’ll get started on this and propose a branch by Sunday night.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants