Add a new resource to get the overview markdown content of an API #12942
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.
Purpose
A new resource
/apis/{apiId}/markdown-content
is created to fetch the overview markdown content of an API.In the current implementation, to obtain the markdown content, the
documentId
related to the overview document needs to be known. So, at least three APIs should be called, including the GET/apis/{apiId}
API, to fetch the markdown content.From the new resource, we can directly obtain the markdown content if
isMarkdownOverview
istrue
in the GET/apis/{apiId}
API.