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

docs: generate OpenAPI specification #116

Draft
wants to merge 48 commits into
base: dev
Choose a base branch
from
Draft

Conversation

daniel-mader
Copy link
Contributor

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 file is generated by executing an automated 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.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have successfully tested this change in a docker environment

@daniel-mader daniel-mader added Documentation Improvements or additions to documentation Enhancement New feature or improvement to an existing feature labels Aug 30, 2024
@daniel-mader daniel-mader self-assigned this Aug 30, 2024
@daniel-mader daniel-mader changed the base branch from dev to feat/holder-init August 30, 2024 19:29
@daniel-mader daniel-mader mentioned this pull request Sep 17, 2024
7 tasks
@daniel-mader daniel-mader added the Blocked Something blocks the integration of this code. label Sep 17, 2024
Base automatically changed from feat/holder-init to dev September 20, 2024 14:15
@daniel-mader daniel-mader removed the Blocked Something blocks the integration of this code. label Sep 20, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants