Repository navigation
Conversation
OpenAPI docs for configurable endpoints (any model using `endpoint.mixin`). * opt-in per endpoint, w/ description, tags and input/output JSON schemas (via `openapi.doc.mixin`) * one docs source per model (category) and route group (app), browsable from `/openapi/docs` (`openapi_doc_viewer`)
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
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.
Depends on
Motivation
Configurable endpoints (
endpoint.endpoint,edi.endpoint...) are not documented today, so consumers have to read the code or the records to know what they expose. This module documents them with OpenAPI, from the records themselves, and lists them in the docs viewer. Only enabled endpoints are documented, since some are meant for internal use only.Key features
endpoint.endpointand any model usingendpoint.mixin(eg:edi.endpoint)/openapi/docsopenapi_doc_viewer