Skip to content
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

Add endpoint URLs to the API specification (phase 2) #3528

Merged
merged 1 commit into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
510 changes: 255 additions & 255 deletions output/schema/schema-serverless.json

Large diffs are not rendered by default.

1,042 changes: 521 additions & 521 deletions output/schema/schema.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ import { Id } from '@_types/common'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_pit'
methods: ['DELETE']
}
]
body: {
/**
* The ID of the point-in-time.
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/count/CountRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ import { Operator } from '@_types/query_dsl/Operator'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_count'
methods: ['POST', 'GET']
},
{
path: '/{index}/_count'
methods: ['POST', 'GET']
}
]
path_parts: {
/**
* Comma-separated list of data streams, indices, and aliases to search.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/create/CreateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ import { Duration } from '@_types/Time'
* @doc_tag document
*/
export interface Request<TDocument> extends RequestBase {
urls: [
{
path: '/{index}/_create/{id}'
methods: ['PUT', 'POST']
}
]
path_parts: {
/**
* Unique identifier for the document.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/delete/DeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ import { Duration } from '@_types/Time'
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_doc/{id}'
methods: ['DELETE']
}
]
path_parts: {
/**
* Unique identifier for the document.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/delete_by_query/DeleteByQueryRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ import { Duration } from '@_types/Time'
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_delete_by_query'
methods: ['POST']
}
]
path_parts: {
/**
* Comma-separated list of data streams, indices, and aliases to search.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ import { float } from '@_types/Numeric'
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_delete_by_query/{task_id}/_rethrottle'
methods: ['POST']
}
]
path_parts: {
/**
* The ID for the task.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/delete_script/DeleteScriptRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ import { Duration } from '@_types/Time'
* @doc_tag script
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_scripts/{id}'
methods: ['DELETE']
}
]
path_parts: {
/**
* Identifier for the stored script or search template.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/exists/DocumentExistsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ import {
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_doc/{id}'
methods: ['HEAD']
}
]
path_parts: {
/**
* Identifier of the document.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/exists_source/SourceExistsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ import {
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_source/{id}'
methods: ['HEAD']
}
]
path_parts: {
/**
* Identifier of the document.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/explain/ExplainRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ import { Operator } from '@_types/query_dsl/Operator'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_explain/{id}'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* Defines the document ID.
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/field_caps/FieldCapabilitiesRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,16 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_field_caps'
methods: ['GET', 'POST']
},
{
path: '/{index}/_field_caps'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/get/GetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ import {
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_doc/{id}'
methods: ['GET']
}
]
path_parts: {
/** Unique identifier of the document. */
id: Id
Expand Down
6 changes: 6 additions & 0 deletions specification/_global/get_script/GetScriptRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ import { Duration } from '@_types/Time'
* @doc_tag script
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_scripts/{id}'
methods: ['GET']
}
]
path_parts: {
/**
* Identifier for the stored script or search template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,11 @@ import { RequestBase } from '@_types/Base'
* @availability stack stability=stable
* @doc_tag script
*/
export interface Request extends RequestBase {}
export interface Request extends RequestBase {
urls: [
{
path: '/_script_context'
methods: ['GET']
}
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,11 @@ import { RequestBase } from '@_types/Base'
* @availability stack stability=stable
* @doc_tag script
*/
export interface Request extends RequestBase {}
export interface Request extends RequestBase {
urls: [
{
path: '/_script_language'
methods: ['GET']
}
]
}
6 changes: 6 additions & 0 deletions specification/_global/get_source/SourceRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ import {
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_source/{id}'
methods: ['GET']
}
]
path_parts: {
/** Unique identifier of the document. */
id: Id
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/health_report/Request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ import { Duration } from '@_types/Time'
* @availability serverless stability=stable visibility=private
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_health_report'
methods: ['GET']
},
{
path: '/_health_report/{feature}'
methods: ['GET']
}
]
path_parts: {
/**
* A feature of the cluster, as returned by the top-level health report API.
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/index/IndexRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ import { Duration } from '@_types/Time'
* @doc_tag document
*/
export interface Request<TDocument> extends RequestBase {
urls: [
{
path: '/{index}/_doc/{id}'
methods: ['PUT', 'POST']
},
{
path: '/{index}/_doc'
methods: ['POST']
}
]
path_parts: {
/**
* Unique identifier for the document.
Expand Down
9 changes: 8 additions & 1 deletion specification/_global/info/RootNodeInfoRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,11 @@ import { RequestBase } from '@_types/Base'
* @cluster_privileges monitor
* @doc_id api-root
*/
export interface Request extends RequestBase {}
export interface Request extends RequestBase {
urls: [
{
path: '/'
methods: ['GET']
}
]
}
6 changes: 6 additions & 0 deletions specification/_global/knn_search/KnnSearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ import { Query } from './_types/Knn'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_knn_search'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* A comma-separated list of index names to search;
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/mget/MultiGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ import { Operation } from './types'
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_mget'
methods: ['GET', 'POST']
},
{
path: '/{index}/_mget'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/msearch/MultiSearchRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ import { RequestItem } from './types'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_msearch'
methods: ['GET', 'POST']
},
{
path: '/{index}/_msearch'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* Comma-separated list of data streams, indices, and index aliases to search.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,16 @@ import { RequestItem } from './types'
* @ext_doc_id search-templates
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_msearch/template'
methods: ['GET', 'POST']
},
{
path: '/{index}/_msearch/template'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* Comma-separated list of data streams, indices, and aliases to search.
Expand Down
10 changes: 10 additions & 0 deletions specification/_global/mtermvectors/MultiTermVectorsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@ import { Operation } from './types'
* @doc_tag document
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_mtermvectors'
methods: ['GET', 'POST']
},
{
path: '/{index}/_mtermvectors'
methods: ['GET', 'POST']
}
]
path_parts: {
/**
* Name of the index that contains the documents.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ import { Duration } from '@_types/Time'
* @doc_tag search
*/
export interface Request extends RequestBase {
urls: [
{
path: '/{index}/_pit'
methods: ['POST']
}
]
path_parts: {
index: Indices
}
Expand Down
9 changes: 8 additions & 1 deletion specification/_global/ping/PingRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,11 @@ import { RequestBase } from '@_types/Base'
* @availability serverless stability=stable visibility=public
* @doc_tag cluster
*/
export interface Request extends RequestBase {}
export interface Request extends RequestBase {
urls: [
{
path: '/'
methods: ['HEAD']
}
]
}
10 changes: 10 additions & 0 deletions specification/_global/put_script/PutScriptRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ import { Duration } from '@_types/Time'
* @doc_tag script
*/
export interface Request extends RequestBase {
urls: [
{
path: '/_scripts/{id}'
methods: ['PUT', 'POST']
},
{
path: '/_scripts/{id}/{context}'
methods: ['PUT', 'POST']
}
]
path_parts: {
/**
* Identifier for the stored script or search template.
Expand Down
Loading
Loading