-
Notifications
You must be signed in to change notification settings - Fork 3
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
docs: generate OpenAPI specification #116
Draft
daniel-mader
wants to merge
64
commits into
beta
Choose a base branch
from
feat/generate-openapi
base: beta
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
+2,111
−324
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daniel-mader
force-pushed
the
feat/generate-openapi
branch
from
December 3, 2024 17:49
3e97659
to
7d24ad0
Compare
daniel-mader
force-pushed
the
feat/generate-openapi
branch
from
December 3, 2024 17:49
7d24ad0
to
93084d4
Compare
daniel-mader
force-pushed
the
feat/generate-openapi
branch
from
December 17, 2024 12:22
5ac63b2
to
62cb0cf
Compare
daniel-mader
force-pushed
the
feat/generate-openapi
branch
from
December 17, 2024 12:23
62cb0cf
to
0547da6
Compare
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
Enhancement
New feature or improvement to an existing feature
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of change
Generating a OpenAPI specification file
openapi.yaml
is faster, more convenient and less error-prone than having to edit it by hand for each change to the API.The
openapi.yaml
file is generated by executing a unit test.Links to any relevant issues
n/a
How the change has been tested
Generated
openapi.yaml
file provides a good DX when loaded into Swagger UI and Scalar.Definition of Done checklist
Add an
x
to the boxes that are relevant to your changes.