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.

Sign up for GitHub

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

Jump to bottom

API documentation updates #302

Open

7 tasks

ryscher opened this issue Oct 12, 2023 · 0 comments

Member

ryscher commented Oct 12, 2023 •

edited

Loading

Start with just a plain page that has a high-level description, then re-incorporate the swagger document.

Add the API docs to the search tools menu
remove dev server from listing
provide more detailed comments in the various sections
indicate which endpoints require authorization
provide more examples
update the swagger document to include Sanket's detailed specs
embed the swagger document in the new page

ryscher added this to CIC Technical Plan

ryscher converted this from a draft issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment