Repository navigation
Conversation
Viewer for OpenAPI docs: one page to browse all the docs the current user can see: `/openapi/docs`, w/ category and app selectors (also in Settings > Technical > API docs). Sources are filtered by their groups and the groups of their category (see `openapi_doc_base`).
Pending OCA#181 (openapi_doc_base). To be removed once merged.
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
Each module exposing docs would otherwise need its own page to browse them. This module gives one page to browse every documentation source the current user can see, so the modules built on
openapi_doc_basedon't need a controller just to be visible.Key features
/openapi/docs: one page listing every docs source, filterable by category and app/openapi/docs/<key>.json: the OpenAPI document of each source