-
Notifications
You must be signed in to change notification settings - Fork 32
Index OpenAPI endpoints for Elasticsearch and Kibana #2236
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
Conversation
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
…arkdown exporters.
tests/Elastic.ApiExplorer.Tests/OpenApiDocumentExporterTests.cs
Dismissed
Show dismissed
Hide dismissed
src/Elastic.ApiExplorer/Elasticsearch/OpenApiDocumentExporter.cs
Dismissed
Show dismissed
Hide dismissed
src/Elastic.ApiExplorer/Elasticsearch/OpenApiDocumentExporter.cs
Dismissed
Show dismissed
Hide dismissed
reakaleek
approved these changes
Nov 19, 2025
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.
Summary
This PR adds support for indexing OpenAPI documentation from Elasticsearch and Kibana OpenAPI specification endpoints, making API reference documentation searchable alongside existing documentation.
This is using our OpenAPI Specification Mirror on S3/Cloudfront to ensure we always have the latest built ready to go.
NOTE this is temporary, once we have an OpenAPI explorer they will flow more naturally through our architecture.
Key Features
1. OpenAPI Document Exporter
OpenApiDocumentExporterthat fetches OpenAPI specs from CloudFront URLselasticsearch-openapi-docs.json) and Kibana (kibana-openapi.json)DocumentationDocument/docs/api/doc/{product}/operation/operation-{operationId}2. Version Filtering
x-stateextension from OpenAPI operations3. ApplicableTo Extraction
ApplicableToinstances4. HTML-to-Markdown Transformation
<div>and<span>elements to clean markdown lists- **VERB** \path``5. LLM-Ready Content
6. Type-Based Search Result Icons
typefield toDocumentationDocument(default: "doc", or "api" for API docs)NOTE: Will follow up with introducing dynamic styling based on type.
Testing