DOC-13120: Convert Search REST APIs to OpenAPI#165
Merged
Conversation
Contributor
Author
|
Adding @abhinavdangeti as a reviewer for visibility. The PR is still in draft. I'm currently filling in the payload and response descriptions where I can. |
Comment on lines
+474
to
+475
| # patternProperties: | ||
| # '(.*:.*:)?avg_grpc_internal_queries_latency': |
Contributor
Author
There was a problem hiding this comment.
As a reminder for future use. The BUCKET:INDEX: properties would be more accurately described using pattern properties. OpenAPI 3.0.3 doesn't support pattern properties, but JSON schema does, and I believe they are supported in a later version of OpenAPI.
simon-dew
added a commit
that referenced
this pull request
Aug 19, 2025
* Add Search Gradle files * Import Search specs * Add deprecation notice snippets * Add header attributes * Add CSS passthroughs * Add security partials * Externalize examples * Migrate examples from docs-server * Improve parameter descriptions and examples * Move nsstats for index into the Stats spec * Update description of partition APIs * Standardize API versions * Explain parameters in examples * Build output docs
simon-dew
added a commit
that referenced
this pull request
Aug 19, 2025
* Add Search Gradle files * Import Search specs * Add deprecation notice snippets * Add header attributes * Add CSS passthroughs * Add security partials * Externalize examples * Migrate examples from docs-server * Improve parameter descriptions and examples * Move nsstats for index into the Stats spec * Update description of partition APIs * Standardize API versions * Explain parameters in examples * Build output docs
simon-dew
added a commit
that referenced
this pull request
Sep 10, 2025
* Add Search Gradle files * Import Search specs * Add deprecation notice snippets * Add header attributes * Add CSS passthroughs * Add security partials * Externalize examples * Migrate examples from docs-server * Improve parameter descriptions and examples * Move nsstats for index into the Stats spec * Update description of partition APIs * Standardize API versions * Explain parameters in examples * Build output docs
dgnicholson
pushed a commit
that referenced
this pull request
Oct 21, 2025
* Add Search Gradle files * Import Search specs * Add deprecation notice snippets * Add header attributes * Add CSS passthroughs * Add security partials * Externalize examples * Migrate examples from docs-server * Improve parameter descriptions and examples * Move nsstats for index into the Stats spec * Update description of partition APIs * Standardize API versions * Explain parameters in examples * Build output docs
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
2 participants
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.
Docs issue: DOC-13120
Docs preview: Search API
Credentials: Preview docs for internal review
For @abhinavdangeti the important things to note are the OpenAPI specs: