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

Create API endpoint documentation #245

Closed
wants to merge 1 commit into from
Closed

Create API endpoint documentation #245

wants to merge 1 commit into from

Conversation

Justin-Fernbaugh
Copy link
Member

API Documentation

Description

Document all the currrent API Routes.

Fixes # (issue)

Additional Information

Checklist:

Before you submit your Pull Request, please make sure you have completed the following tasks:

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.
  • I have tagged my PR with the appropriate label(s).

@Justin-Fernbaugh Justin-Fernbaugh added the documentation Improvements or additions to documentation label Jun 1, 2024
@Justin-Fernbaugh Justin-Fernbaugh self-assigned this Jun 1, 2024
@Justin-Fernbaugh Justin-Fernbaugh requested a review from a team as a code owner June 1, 2024 18:32
Copy link
Member

@nilsstreedain nilsstreedain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like great info, including much that is missing in the current API Endpoints page, however I think it would make more sense to update the current endpoints page in the wiki, rather than create a new one, especially considering it already has parameters and example requests listed for many of the endpoints.

@Justin-Fernbaugh Justin-Fernbaugh deleted the api-docs branch June 1, 2024 22:10
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants