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

Better API Documentation #210

Merged
merged 20 commits into from
Sep 3, 2024
Merged

Better API Documentation #210

merged 20 commits into from
Sep 3, 2024

Conversation

bbengfort
Copy link
Collaborator

@bbengfort bbengfort commented Aug 22, 2024

Scope of changes

This PR replaces our generic SwaggerUI documentation with RapiDoc for a better user experience reading the documentation. It also updates the documentation to improve readability, ensure correctness for the current version of the API and add examples.

Type of change

  • bug fix
  • new feature
  • documentation
  • other (describe)

Acceptance criteria

https://www.awesomescreenshot.com/video/30767710?key=25af4033a72139a827b1c8394cb756fd

Author checklist

  • I have manually tested the change and/or added automation in the form of unit tests or integration tests
  • I have updated the dependencies list
  • I have added new test fixtures as needed to support added tests
  • I have added or updated the documentation
  • Check this box if a reviewer can merge this pull request after approval (leave it unchecked if you want to do it yourself)

Reviewer(s) checklist

  • Any new user-facing content that has been added for this PR has been QA'ed to ensure correct grammar, spelling, and understandability.
  • To the best of my ability, I believe that this PR represents a good solution to the specified problem and that it should be merged into the main code base.

@bbengfort bbengfort marked this pull request as draft August 22, 2024 22:17
@bbengfort bbengfort marked this pull request as ready for review September 3, 2024 02:09
@bbengfort bbengfort merged commit cdc8e56 into main Sep 3, 2024
4 checks passed
@bbengfort bbengfort deleted the sc-26743 branch September 3, 2024 02:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant