Repository navigation
Show lifecycle badges on API group overview rows - #4520
Merged
Merged
Conversation
Group overview pages listed endpoints without their beta, preview or deprecated state, so readers had to open each operation to see it. Each row now shows the same badges as the operation page. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
![infra-vault-gh-plugin-prod[bot]](https://avatars.githubusercontent.com/u/6764390?s=60&v=4){kind=small}
Contributor
Docs preview (local build)Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4520/ |
The row is one link, and a tap on an interactive badge inside it opened the operation instead of the lifecycle popover. The row badge is now static, and tests cover the rendered badges for beta, deprecated and plain operations. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.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.
Endpoint rows on API group overview pages now show the same beta, preview and deprecated badges as the operation page.
Affects: API reference
Prompt summary: Fix elastic/docs-eng-team#1098 on this branch: group overview pages list endpoints without lifecycle badges, so readers cannot tell an endpoint is deprecated or experimental until they open it. Show each endpoint's badges in the overview list.
Why
A group overview such as Behavioral analytics lists "Get behavioral analytics collections" with no badges. The operation page shows it as experimental and deprecated. Readers only find out after they click through.
What
Badge data on overview rows
ApiOverviewRowcarries the operation's availability badge and its deprecated flag.ApiOverviewBuilderbuilds both withAvailabilityBadge.FromOperation, the helper the operation page uses, so the two pages agree.Row layout
The row partial renders the badges next to the title, using the existing
api-title-badgesmarkup. A small CSS rule lets the title and badges wrap on narrow rows.Verify
dotnet test tests/Elastic.ApiExplorer.TestsCheck on the preview