Skip to content

Docs/07 openapi definition#41

Merged
FadyGergesRezk merged 15 commits into
mainfrom
docs/07-openapi-definition
May 28, 2026
Merged

Docs/07 openapi definition#41
FadyGergesRezk merged 15 commits into
mainfrom
docs/07-openapi-definition

Conversation

@raphael-frank
Copy link
Copy Markdown
Collaborator

I added the basic API. When using docker compose, the API documentation is available under port 8000. I didn't include extensive descriptions yet in case we change the API. I also need to add the generator scripts before closing this PR.

@raphael-frank raphael-frank requested a review from f-s-h May 24, 2026 14:49
@raphael-frank raphael-frank self-assigned this May 24, 2026
@raphael-frank raphael-frank added the documentation Improvements or additions to documentation label May 24, 2026
@raphael-frank raphael-frank linked an issue May 24, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Collaborator

@f-s-h f-s-h left a comment

Choose a reason for hiding this comment

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

lgtm

@raphael-frank raphael-frank force-pushed the docs/07-openapi-definition branch from 3500047 to 1cadd1f Compare May 25, 2026 17:45
@raphael-frank
Copy link
Copy Markdown
Collaborator Author

The generated documentation is available under /docs.

@FadyGergesRezk FadyGergesRezk merged commit 8553b17 into main May 28, 2026
15 checks passed
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenAPI Definition

3 participants