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

Add a new resource to get the overview markdown content of an API #12942

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

AqeelMuhammad
Copy link
Contributor

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 is true in the GET /apis/{apiId} API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant