Skip to content

docs: add full OpenAPI 3.0 spec #918

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

Merged
merged 1 commit into from
Feb 1, 2023
Merged

docs: add full OpenAPI 3.0 spec #918

merged 1 commit into from
Feb 1, 2023

Conversation

hf
Copy link
Contributor

@hf hf commented Jan 29, 2023

Previously we used OpenAPI 2.0 which was automatically generated from Go code and did not capture many nuances of dealing with the API.

This adds a handcrafted OpenAPI spec that attempts to provide a comprehensive overview of the API with documentation on each request.

@hf hf requested a review from a team as a code owner January 29, 2023 12:46
Copy link
Contributor

@J0 J0 left a comment

Choose a reason for hiding this comment

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

Thanks for putting this together! Looks great 🔥

@hf hf merged commit 80fd432 into master Feb 1, 2023
@hf hf deleted the hf/add-openapi branch February 1, 2023 09:31
hf added a commit that referenced this pull request Feb 1, 2023
Previously we used OpenAPI 2.0 which was automatically generated from Go
code and did not capture many nuances of dealing with the API.

This adds a handcrafted OpenAPI spec that attempts to provide a
comprehensive overview of the API with documentation on each request.
@github-actions
Copy link
Contributor

github-actions bot commented Feb 1, 2023

🎉 This PR is included in version 2.43.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

uxodb pushed a commit to uxodb/auth that referenced this pull request Nov 13, 2024
Previously we used OpenAPI 2.0 which was automatically generated from Go
code and did not capture many nuances of dealing with the API.

This adds a handcrafted OpenAPI spec that attempts to provide a
comprehensive overview of the API with documentation on each request.
LashaJini pushed a commit to LashaJini/auth that referenced this pull request Nov 13, 2024
Previously we used OpenAPI 2.0 which was automatically generated from Go
code and did not capture many nuances of dealing with the API.

This adds a handcrafted OpenAPI spec that attempts to provide a
comprehensive overview of the API with documentation on each request.
LashaJini pushed a commit to LashaJini/auth that referenced this pull request Nov 15, 2024
Previously we used OpenAPI 2.0 which was automatically generated from Go
code and did not capture many nuances of dealing with the API.

This adds a handcrafted OpenAPI spec that attempts to provide a
comprehensive overview of the API with documentation on each request.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants