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 64 commits into
base: beta
Choose a base branch
from
Draft

Conversation

daniel-mader
Copy link
Contributor

@daniel-mader daniel-mader commented Aug 30, 2024

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.

  • 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

Sorry, something went wrong.

@daniel-mader daniel-mader removed the Blocked Something blocks the integration of this code. label Sep 20, 2024
@daniel-mader daniel-mader changed the base branch from dev to beta December 2, 2024 08:43
@daniel-mader daniel-mader force-pushed the feat/generate-openapi branch from 3e97659 to 7d24ad0 Compare December 3, 2024 17:49
@daniel-mader daniel-mader force-pushed the feat/generate-openapi branch from 7d24ad0 to 93084d4 Compare December 3, 2024 17:49
@M-Adam-Hus
Copy link

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.

None yet

3 participants