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 generate openapi schema for rest api #2923

Merged
merged 28 commits into from
Dec 13, 2023

Conversation

martmull
Copy link
Contributor

@martmull martmull commented Dec 11, 2023

close #2760

  • creates an endpoint /open-api
  • this endpoint returns a JSON that represents the open-api schema
  • open-api schema documents all CRUD metadata objects and /open-api route
  • go to https://editor.swagger.io/ and copy that JSON to see what the REST API playground could look like
image

@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 2a5244a to 9b5fdd9 Compare December 11, 2023 11:21
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 9b5fdd9 to 37c6251 Compare December 11, 2023 13:29
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 37c6251 to e637509 Compare December 11, 2023 13:36
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from c9d6eee to 677b7dc Compare December 11, 2023 14:36
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch 3 times, most recently from 6f82dae to 9a8a3b0 Compare December 12, 2023 07:32
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 9a8a3b0 to 1cb6174 Compare December 12, 2023 07:36
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 6b86d2e to c872700 Compare December 12, 2023 08:40
@martmull martmull marked this pull request as ready for review December 12, 2023 09:05
Copy link
Member

@magrinj magrinj left a comment

Choose a reason for hiding this comment

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

Few comments !

@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 920d85e to 62e9d10 Compare December 12, 2023 16:01
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 62e9d10 to 6aa2ab4 Compare December 12, 2023 16:04
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from ac67b6f to a6f7c46 Compare December 12, 2023 20:58
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from bb276f8 to 7c68ee1 Compare December 12, 2023 21:13
@martmull martmull force-pushed the 2760-generate-openapi-schema-for-rest-api-2 branch from 6e9bc05 to fbc22fb Compare December 12, 2023 21:38
Copy link
Member

@magrinj magrinj left a comment

Choose a reason for hiding this comment

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

Great job ! LGTM !

@martmull martmull merged commit e3e42be into main Dec 13, 2023
6 of 11 checks passed
@martmull martmull deleted the 2760-generate-openapi-schema-for-rest-api-2 branch December 13, 2023 13:58
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.

Generate OpenAPI schema for Rest API
2 participants