Skip to content

[DOCS]: Add descriptions to API tags #5098

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

Merged
merged 2 commits into from
Aug 11, 2025

Conversation

charlotte-hoblik
Copy link
Contributor

This PR adds descriptions to API tags.

Connected to:
elastic/docs-content#2416

Copy link
Contributor

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, thank you! Left one tiny suggestion about a missing .. LGTM!

@charlotte-hoblik charlotte-hoblik merged commit 98be5c3 into main Aug 11, 2025
8 checks passed
@charlotte-hoblik charlotte-hoblik deleted the charlotte-API-tag-descriptions branch August 11, 2025 11:51
github-actions bot pushed a commit that referenced this pull request Aug 11, 2025
* add descriptions

Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 98be5c3)
pquentin added a commit that referenced this pull request Aug 12, 2025
* add descriptions


(cherry picked from commit 98be5c3)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: Quentin Pradet <[email protected]>
github-actions bot pushed a commit that referenced this pull request Aug 12, 2025
* add descriptions

Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 98be5c3)
pquentin added a commit that referenced this pull request Aug 12, 2025
* add descriptions


(cherry picked from commit 98be5c3)

Co-authored-by: Charlotte Hoblik <[email protected]>
Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: Quentin Pradet <[email protected]>
szybia added a commit that referenced this pull request Aug 12, 2025
* origin/main:
  [DOCS] Fix typos in the shared overlays file (#5124)
  Update specification output
  Remove unused EIS types (#5107)
  No native utility types validation lint (#4567)
  Document reindexing failures (#5031)
  Add dangling types to validation-errors.json (#5106)
  Update specification output
  Change `KeyedPercentiles` value type from `long` to `double` (#5108)
  [DOCS]: Add descriptions to API tags (#5098)
  Bump form-data and @redocly/cli in /docs/examples (#5074)
  Update specification output
  Adds cat-h values (#5096)
  Bump @eslint/plugin-kit from 0.3.3 to 0.3.4 in /specification (#5053)
  Update specification output
  [DOCS] Adds Ruby bulk helper to BulkRequest documentation (#5057)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants