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

Add API documentation for SCXA web app #461

Open
ke4 opened this issue Sep 16, 2024 · 0 comments
Open

Add API documentation for SCXA web app #461

ke4 opened this issue Sep 16, 2024 · 0 comments
Assignees
Labels
documentation Add/improve our documentation technical debt Technical debt

Comments

@ke4
Copy link
Contributor

ke4 commented Sep 16, 2024

Our API is currently not documented. We need to add documentation to our API.
We already had some user query about it.

Alfonso and Upendra was working on this topic already and there is a PR (#215), but as far as I know that PR contains implementation using OpenAPI. I think that PR can be closed.
We would like to use another approach that merges OpenAPI with RestDocs.
Here is the URL how to do that with a combined approach: https://github.com/ePages-de/restdocs-api-spec

@ke4 ke4 added technical debt Technical debt documentation Add/improve our documentation and removed scxa labels Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add/improve our documentation technical debt Technical debt
Projects
None yet
Development

No branches or pull requests

2 participants