Add strict api: schema with product, repository, and children - #3804
Open
reakaleek wants to merge 2 commits into
Open
Add strict api: schema with product, repository, and children#3804reakaleek wants to merge 2 commits into
reakaleek wants to merge 2 commits into
Conversation
Replace legacy api: shapes with a single-entry sequence requiring product: and spec:, optional repository: for cross-repo index lookup, and children: under api/<key>/. Migrate docs/_docset.yml and wire children into ApiExplorer navigation. Skip APIs without a local spec until remote version-index resolution lands in #719. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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.
Why
Multi-version API docs need the
api:key decoupled from product id, bound toproducts.ymlviaproduct:, and able to reference specs published from a different repo than the docset checkout. The #711 pipeline ships a global rootindex.jsonkeyed byorg/repoand spec basename — the config layer must expose that before #719 can fetch specs remotely.What
api:shapes (string, object, intro/outro sequence) with a single-entry sequence requiringspec:andproduct:, plus optionalrepository:andchildren:.product:againstproducts.yml; resolveschildren:underapi/<key>/and prepends them in ApiExplorer navigation.docs/_docset.yml(breaking) and author docs for the new schema.Closes elastic/docs-eng-team#718
Test plan
dotnet test tests/Elastic.Documentation.Configuration.Tests/dotnet test tests/Elastic.ApiExplorer.Tests/(nav/reader)dotnet buildMade with Cursor