diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml index 3c2187e7..406225bd 100644 --- a/spec/namespaces/_core.yaml +++ b/spec/namespaces/_core.yaml @@ -76,6 +76,57 @@ paths: responses: '200': $ref: '#/components/responses/bulk@200' + /_bulk/stream: + post: + operationId: bulk.stream.0 + x-operation-group: bulk + x-version-added: '2.17.0' + description: Allows to perform multiple index/update/delete operations using request / response streaming + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ + parameters: + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.require_alias' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.batch_size' + - $ref: '#/components/parameters/bulk::query.batch_interval' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + put: + operationId: bulk.stream.1 + x-operation-group: bulk + x-version-added: '2.17.0' + description: Allows to perform multiple index/update/delete operations using request / response streaming + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk-streaming/ + parameters: + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.require_alias' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.batch_size' + - $ref: '#/components/parameters/bulk::query.batch_interval' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' /_count: get: operationId: count.0 @@ -3217,6 +3268,23 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form x-default: '1' + bulk::query.batch_size: + in: query + name: batch_size + description: |- + Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/BatchSize' + style: form + x-default: '1' + bulk::query.batch_interval: + in: query + name: batch_interval + description: |- + Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form clear_scroll::path.scroll_id: in: path name: scroll_id diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml index 14060078..d7d74260 100644 --- a/spec/schemas/_common.yaml +++ b/spec/schemas/_common.yaml @@ -2230,3 +2230,6 @@ components: required: - reason - status + BatchSize: + type: integer + format: int64