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

Add schemas to all /project/ routes #2356

Merged
merged 14 commits into from
Jun 29, 2023

Conversation

knolleary
Copy link
Member

Part of #1556

This targets the branch of #2351 - I've split this out to try to keep things reviewable.

This PR adds schemas to all of the routes/api/project* files.

Along the way it also:

  • modifies the swagger config to generate OpenAPI 3.x (rather than Swagger/OpenAPI 2.x)
  • Fixes a few tests that were passing in raw database indexes to the public API, rather than the expected hashids. Found them thanks to the tightened up schema validation - hurrah!
  • renames :projectId to :instanceId in all route definitions - as this gets included in generated api docs.

Add schemas to admin/settings/stack routes
Add schemas to Template, Types and UserInvitation routes
Add schemas to all teamDevices routes
@knolleary knolleary merged commit 75b8a5c into 1556-api-docs Jun 29, 2023
3 checks passed
@knolleary knolleary deleted the 1556-replace-project-routes branch June 29, 2023 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants