Skip to content

Conversation

georgewallace
Copy link
Contributor

@georgewallace georgewallace commented Jul 25, 2025

Release notes

What does this PR do?

This PR updates the OpenAPI spec to add the x-metatags extension. This extension adds product_name metadata which during docs build time is converted to a meta tag on the HTML page, this tag is then parsed by our internal site search to add the API docs pages to the product facets on search.

Why is it important/What is the impact to the user?

This allows users to filter their search by logstash and only see logstash apis

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files (and/or docker env variables)
  • I have added tests that prove my fix is effective or that my feature works

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@github-actions
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@mergify
Copy link
Contributor

mergify bot commented Jul 25, 2025

This pull request does not have a backport label. Could you fix it @georgewallace? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit.
  • If no backport is necessary, please add the backport-skip label

@georgewallace georgewallace added backport-9.0 Automated backport to the 9.0 branch with mergify backport-8.18 Automated backport with mergify backport-8.19 Automated backport to the 8.19 branch backport-9.1 Automated backport to the 9.1 branch labels Jul 25, 2025
Copy link
Contributor

@kaisecheng kaisecheng left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

LGTM!

@georgewallace georgewallace merged commit bc4645c into main Aug 20, 2025
13 checks passed
@georgewallace georgewallace deleted the openapiupdates branch August 20, 2025 23:39
mergify bot pushed a commit that referenced this pull request Aug 20, 2025
(cherry picked from commit bc4645c)

# Conflicts:
#	docs/static/spec/openapi/logstash-api.yaml
mergify bot pushed a commit that referenced this pull request Aug 20, 2025
(cherry picked from commit bc4645c)

# Conflicts:
#	docs/static/spec/openapi/logstash-api.yaml
mergify bot pushed a commit that referenced this pull request Aug 20, 2025
(cherry picked from commit bc4645c)

# Conflicts:
#	docs/static/spec/openapi/logstash-api.yaml
mergify bot pushed a commit that referenced this pull request Aug 20, 2025
@jsvd
Copy link
Member

jsvd commented Oct 7, 2025

@georgewallace this PR spawned a few backport PRs that are still open, can you merge them too? thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-8.18 Automated backport with mergify backport-8.19 Automated backport to the 8.19 branch backport-9.0 Automated backport to the 9.0 branch with mergify backport-9.1 Automated backport to the 9.1 branch docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants