Docs: API Documentation (Swagger) guide#4
Merged
Conversation
New developer guide covering the Scramble-generated Swagger UI: viewing /docs/api and the per-module pages, exporting the OpenAPI JSON, the local-only access gate, and how to register docs for a new module. Linked from the Getting Started walkthrough.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a developer guide for the Scramble/Swagger API docs: viewing
/docs/apiand the per-module pages (hrm, support-ticket, taskly), exporting the OpenAPI JSON, the local-only access gate, and registering docs for a new module. Linked from Getting Started. Companion to zerp-pk/zerp#61.