Add HTTP API endpoint index in API Reference#342
Closed
xiaobo-gaga wants to merge 6 commits intomainfrom
Closed
Conversation
11 tasks
Collaborator
Author
|
Implemented as requested: introduced an OpenAPI-based validation pipeline baseline. Added:
Validated now:
Result:
|
Collaborator
Author
|
已补上 CI 验证流程:
可选 Secrets(用于鉴权接口验证增强):
当前即使未配置 secrets,也会执行基础与未授权场景校验,确保 CI 不空跑。 |
Collaborator
Author
|
Implemented based on the old
This makes each documented API an explicit unit for future per-API implementation and validation expansion. |
Collaborator
Author
|
Implemented a Mintlify-style API Reference catalog view (one-by-one API list) on docs pages. Added:
What it does:
Also added generator + CI wiring:
And made API Reference section expanded by default in sidebar ( |
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.
This starts rebuilding HTTP API discoverability in API Reference by reverse-mapping current SDK-linked docs.
Changes:
http-api-endpointspage under API Reference in:Why:
/docscurrently feels SDK-oriented; HTTP APIs are hard to find from the API Reference entry.Next step (follow-up PR):