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

API Documentation #25

Open
ralf401 opened this issue Dec 16, 2024 · 0 comments
Open

API Documentation #25

ralf401 opened this issue Dec 16, 2024 · 0 comments
Labels
📚documentation📚 Improvements or additions to documentation New Docs

Comments

@ralf401
Copy link
Collaborator

ralf401 commented Dec 16, 2024

For the old docs, the REST API requests and responses are generated manually. After migrating them to the new docs, it turned out that these partially large JSON code blocks are included in the translation catalog. Is is not easily possible to exclude them from being extracted for translation. So the conclusion is to place them in separate files in the first step and include these files wherever needed. In the next step, these responses should be auto-generated based on the Zammad stack with the example data in this repository.

Another related topic is to have the GraphQL documented.

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 New Docs
Projects
None yet
Development

No branches or pull requests

1 participant