diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index 7c18a56ac9..59405876c5 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -727,6 +727,17 @@ actions: examples: getTasksResponseExample1: $ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml" +## Examples for transforms + - target: "$.paths['/_transform/_upgrade']['post']" + description: "Add examples for transform upgrade" + update: + responses: + 200: + content: + application/json: + examples: + transformUpgradeResponseExample1: + $ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml" ## Examples for watcher - target: "$.paths['/_watcher/settings']['put']" description: "Add request example for update watcher settings" diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 51fe42ff23..4d60caf242 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -2560,6 +2560,74 @@ actions: examples: updateTransformResponseExample1: $ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml" + - target: "$.paths['/_transform/{transform_id}/_stop']['post']" + description: "Add examples for transform stop" + update: + responses: + 200: + content: + application/json: + examples: + transformStopResponseExample1: + $ref: "../../specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml" + - target: "$.paths['/_transform/{transform_id}/_start']['post']" + description: "Add examples for transform start" + update: + responses: + 200: + content: + application/json: + examples: + transformStartResponseExample1: + $ref: "../../specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml" + - target: "$.paths['/_transform/{transform_id}/_schedule_now']['post']" + description: "Add examples for transform schedule now" + update: + responses: + 200: + content: + application/json: + examples: + transformScheduleNowResponseExample1: + $ref: "../../specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml" + - target: "$.paths['/_transform/{transform_id}/_reset']['post']" + description: "Add examples for transform reset" + update: + responses: + 200: + content: + application/json: + examples: + transformResetResponseExample1: + $ref: "../../specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml" + - target: "$.paths['/_transform/{transform_id}/_stats']['get']" + description: "Add examples for transform get stats" + update: + responses: + 200: + content: + application/json: + examples: + transformGetStatsResponseExample1: + $ref: "../../specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml" + - target: "$.paths['/_transform/{transform_id}']['delete']" + description: "Add examples for transform delete" + update: + responses: + 200: + content: + application/json: + examples: + transformDeleteResponseExample1: + $ref: "../../specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml" + - target: "$.components['transform.get_transform#200']" + description: "Add examples for transform get" + update: + content: + application/json: + examples: + transformGetResponseExample1: + $ref: "../../specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml" ## xCodeSamples - target: "$.paths['/{index}/_doc/{id}']['head']" description: "Add xCodeSamples for check document operation" diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index fd79fb2e36..027124bcc8 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -37956,7 +37956,7 @@ "transform" ], "summary": "Reset a transform", - "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "operationId": "transform-reset-transform", "parameters": [ { @@ -38012,7 +38012,7 @@ "transform" ], "summary": "Schedule a transform to start now", - "description": "Instantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "description": "Instantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", "operationId": "transform-schedule-now-transform", "parameters": [ { @@ -38058,7 +38058,7 @@ "transform" ], "summary": "Start a transform", - "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "operationId": "transform-start-transform", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 9cc9a4d648..be1caecbe7 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -19424,7 +19424,7 @@ "transform" ], "summary": "Reset a transform", - "description": "Resets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Before you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "operationId": "transform-reset-transform", "parameters": [ { @@ -19480,7 +19480,7 @@ "transform" ], "summary": "Schedule a transform to start now", - "description": "Instantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "description": "Instantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", "operationId": "transform-schedule-now-transform", "parameters": [ { @@ -19526,7 +19526,7 @@ "transform" ], "summary": "Start a transform", - "description": "Starts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "operationId": "transform-start-transform", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index b960202491..4425ab5a8a 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -21359,7 +21359,7 @@ "stability": "stable" } }, - "description": "Get transform stats.\nGet usage information for transforms.", + "description": "Get transform stats.\n\nGet usage information for transforms.", "docId": "get-transform-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-transform-stats.html", "name": "transform.get_transform_stats", @@ -21510,7 +21510,7 @@ "stability": "stable" } }, - "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "docId": "reset-transform", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/reset-transform.html", "name": "transform.reset_transform", @@ -21551,7 +21551,7 @@ "stability": "stable" } }, - "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "description": "Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", "docId": "schedule-now-transform", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/schedule-now-transform.html", "name": "transform.schedule_now_transform", @@ -21595,7 +21595,7 @@ "stability": "stable" } }, - "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "docId": "start-transform", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/start-transform.html", "name": "transform.start_transform", @@ -21730,7 +21730,7 @@ "stability": "stable" } }, - "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", + "description": "Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "docId": "upgrade-transforms", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/upgrade-transforms.html", "name": "transform.upgrade_transforms", @@ -219688,7 +219688,7 @@ "body": { "kind": "no_body" }, - "description": "Get transform stats.\nGet usage information for transforms.", + "description": "Get transform stats.\n\nGet usage information for transforms.", "inherits": { "type": { "name": "RequestBase", @@ -219766,7 +219766,7 @@ } } ], - "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L76" + "specLocation": "transform/get_transform_stats/GetTransformStatsRequest.ts#L25-L77" }, { "kind": "response", @@ -220641,7 +220641,7 @@ "body": { "kind": "no_body" }, - "description": "Reset a transform.\nResets a transform.\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", + "description": "Reset a transform.\n\nBefore you can reset it, you must stop it; alternatively, use the `force` query parameter.\nIf the destination index was created by the transform, it is deleted.", "inherits": { "type": { "name": "RequestBase", @@ -220722,7 +220722,7 @@ "body": { "kind": "no_body" }, - "description": "Schedule a transform to start now.\nInstantly runs a transform to process data.\n\nIf you _schedule_now a transform, it will process the new data instantly,\nwithout waiting for the configured frequency interval. After _schedule_now API is called,\nthe transform will be processed again at now + frequency unless _schedule_now API\nis called again in the meantime.", + "description": "Schedule a transform to start now.\n\nInstantly run a transform to process data.\nIf you run this API, the transform will process the new data instantly,\nwithout waiting for the configured frequency interval. After the API is called,\nthe transform will be processed again at `now + frequency` unless the API\nis called again in the meantime.", "inherits": { "type": { "name": "RequestBase", @@ -220790,7 +220790,7 @@ "body": { "kind": "no_body" }, - "description": "Start a transform.\nStarts a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", + "description": "Start a transform.\n\nWhen you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is\nset to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping\ndefinitions for the destination index from the source indices and the transform aggregations. If fields in the\ndestination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations),\nthe transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce\nmapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you\nstart the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings\nin a pivot transform.\n\nWhen the transform starts, a series of validations occur to ensure its success. If you deferred validation when you\ncreated the transform, they occur when you start the transform—​with the exception of privilege checks. When\nElasticsearch security features are enabled, the transform remembers which roles the user that created it had at the\ntime of creation and uses those same roles. If those roles do not have the required privileges on the source and\ndestination indices, the transform fails when it attempts unauthorized operations.", "inherits": { "type": { "name": "RequestBase", @@ -220842,7 +220842,7 @@ } } ], - "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L73" + "specLocation": "transform/start_transform/StartTransformRequest.ts#L24-L72" }, { "kind": "response", @@ -221330,7 +221330,7 @@ "body": { "kind": "no_body" }, - "description": "Upgrade all transforms.\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", + "description": "Upgrade all transforms.\n\nTransforms are compatible across minor versions and between supported major versions.\nHowever, over time, the format of transform configuration information may change.\nThis API identifies transforms that have a legacy configuration format and upgrades them to the latest version.\nIt also cleans up the internal data structures that store the transform state and checkpoints.\nThe upgrade does not affect the source and destination indices.\nThe upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged.\n\nIf a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue.\nResolve the issue then re-run the process again.\nA summary is returned when the upgrade is finished.\n\nTo ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster.\nYou may want to perform a recent cluster backup prior to the upgrade.", "inherits": { "type": { "name": "RequestBase", @@ -221370,7 +221370,7 @@ } } ], - "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L64" + "specLocation": "transform/upgrade_transforms/UpgradeTransformsRequest.ts#L23-L65" }, { "kind": "response", diff --git a/specification/transform/delete_transform/DeleteTransformResponseExample1.json b/specification/transform/delete_transform/DeleteTransformResponseExample1.json deleted file mode 100644 index 7cd49cf849..0000000000 --- a/specification/transform/delete_transform/DeleteTransformResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when the transform is deleted.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml b/specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml new file mode 100644 index 0000000000..6e48679023 --- /dev/null +++ b/specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when the transform is deleted. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/transform/get_transform/GetTransformResponseExample1.json b/specification/transform/get_transform/GetTransformResponseExample1.json deleted file mode 100644 index 0388996347..0000000000 --- a/specification/transform/get_transform/GetTransformResponseExample1.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "summary": "A successful response that contains configuration information for a transform.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "count": 1, - "transforms": [ - { - "id": "ecommerce_transform1", - "authorization": { - "roles": ["superuser"] - }, - "version": "8.4.0", - "create_time": 1656023416565, - "source": { - "index": ["kibana_sample_data_ecommerce"], - "query": { - "term": { - "geoip.continent_name": { - "value": "Asia" - } - } - } - }, - "dest": { - "index": "kibana_sample_data_ecommerce_transform1", - "pipeline": "add_timestamp_pipeline" - }, - "frequency": "5m", - "sync": { - "time": { - "field": "order_date", - "delay": "60s" - } - }, - "pivot": { - "group_by": { - "customer_id": { - "terms": { - "field": "customer_id" - } - } - }, - "aggregations": { - "max_price": { - "max": { - "field": "taxful_total_price" - } - } - } - }, - "description": "Maximum priced ecommerce data by customer_id in Asia", - "settings": {}, - "retention_policy": { - "time": { - "field": "order_date", - "max_age": "30d" - } - } - } - ] - } -} diff --git a/specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml b/specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml new file mode 100644 index 0000000000..d42b04b02a --- /dev/null +++ b/specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml @@ -0,0 +1,43 @@ +# summary: +description: A successful response that contains configuration information for a transform. +type: response +# response_code: 200 +value: + count: 1 + transforms: + - id: ecommerce_transform1 + authorization: + roles: + - superuser + version: 8.4.0 + create_time: 1656023416565 + source: + index: + - kibana_sample_data_ecommerce + query: + term: + geoip.continent_name: + value: Asia + dest: + index: kibana_sample_data_ecommerce_transform1 + pipeline: add_timestamp_pipeline + frequency: 5m + sync: + time: + field: order_date + delay: 60s + pivot: + group_by: + customer_id: + terms: + field: customer_id + aggregations: + max_price: + max: + field: taxful_total_price + description: Maximum priced ecommerce data by customer_id in Asia + settings: {} + retention_policy: + time: + field: order_date + max_age: 30d diff --git a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts index 5dbf3f7c13..c01aeffcd1 100644 --- a/specification/transform/get_transform_stats/GetTransformStatsRequest.ts +++ b/specification/transform/get_transform_stats/GetTransformStatsRequest.ts @@ -24,6 +24,7 @@ import { Duration } from '@_types/Time' /** * Get transform stats. + * * Get usage information for transforms. * @rest_spec_name transform.get_transform_stats * @availability stack since=7.5.0 stability=stable diff --git a/specification/transform/get_transform_stats/GetTransformStatsResponseExample1.json b/specification/transform/get_transform_stats/GetTransformStatsResponseExample1.json deleted file mode 100644 index 1ab1b5b33e..0000000000 --- a/specification/transform/get_transform_stats/GetTransformStatsResponseExample1.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "summary": "A successful response that contains usage information for a transform.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "count": 1, - "transforms": [ - { - "id": "ecommerce-customer-transform", - "state": "started", - "node": { - "id": "cpTIGMsVQ8Gqwqlxxxxxxx", - "name": "my.home", - "ephemeral_id": "5-L21nFsQxxxxxxxxxx-xx", - "transport_address": "127.0.0.1:9300", - "attributes": {} - }, - "stats": { - "pages_processed": 78, - "documents_processed": 6027, - "documents_indexed": 68, - "documents_deleted": 22, - "delete_time_in_ms": 214, - "trigger_count": 168, - "index_time_in_ms": 412, - "index_total": 20, - "index_failures": 0, - "search_time_in_ms": 353, - "search_total": 78, - "search_failures": 0, - "processing_time_in_ms": 8, - "processing_total": 78, - "exponential_avg_checkpoint_duration_ms": 97.30637923893185, - "exponential_avg_documents_indexed": 2.2064915040974062, - "exponential_avg_documents_processed": 179.89419945785045 - }, - "checkpointing": { - "last": { - "checkpoint": 20, - "timestamp_millis": 1585344558220, - "time_upper_bound_millis": 1585344498220 - }, - "changes_last_detected_at": 1585344558219 - }, - "health": { - "status": "green" - } - } - ] - } -} diff --git a/specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml b/specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml new file mode 100644 index 0000000000..10f2c6883f --- /dev/null +++ b/specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml @@ -0,0 +1,41 @@ +# summary: +description: A successful response that contains usage information for a transform. +# type: response +# response_code: 200 +value: + count: 1 + transforms: + - id: ecommerce-customer-transform + state: started + node: + id: cpTIGMsVQ8Gqwqlxxxxxxx + name: my.home + ephemeral_id: 5-L21nFsQxxxxxxxxxx-xx + transport_address: '127.0.0.1:9300' + attributes: {} + stats: + pages_processed: 78 + documents_processed: 6027 + documents_indexed: 68 + documents_deleted: 22 + delete_time_in_ms: 214 + trigger_count: 168 + index_time_in_ms: 412 + index_total: 20 + index_failures: 0 + search_time_in_ms: 353 + search_total: 78 + search_failures: 0 + processing_time_in_ms: 8 + processing_total: 78 + exponential_avg_checkpoint_duration_ms: 97.30637923893185 + exponential_avg_documents_indexed: 2.2064915040974062 + exponential_avg_documents_processed: 179.89419945785045 + checkpointing: + last: + checkpoint: 20 + timestamp_millis: 1585344558220 + time_upper_bound_millis: 1585344498220 + changes_last_detected_at: 1585344558219 + health: + status: green diff --git a/specification/transform/reset_transform/ResetTransformRequest.ts b/specification/transform/reset_transform/ResetTransformRequest.ts index cb1a21136c..5682d83237 100644 --- a/specification/transform/reset_transform/ResetTransformRequest.ts +++ b/specification/transform/reset_transform/ResetTransformRequest.ts @@ -23,7 +23,7 @@ import { Duration } from '@_types/Time' /** * Reset a transform. - * Resets a transform. + * * Before you can reset it, you must stop it; alternatively, use the `force` query parameter. * If the destination index was created by the transform, it is deleted. * @rest_spec_name transform.reset_transform diff --git a/specification/transform/reset_transform/ResetTransformResponseExample1.json b/specification/transform/reset_transform/ResetTransformResponseExample1.json deleted file mode 100644 index 80e457fe12..0000000000 --- a/specification/transform/reset_transform/ResetTransformResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when the transform is reset.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml b/specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml new file mode 100644 index 0000000000..abf2cd58fa --- /dev/null +++ b/specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when the transform is reset. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/transform/schedule_now_transform/ResetTransformResponseExample1.json b/specification/transform/schedule_now_transform/ResetTransformResponseExample1.json deleted file mode 100644 index 7bc34afe5c..0000000000 --- a/specification/transform/schedule_now_transform/ResetTransformResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when the transform is scheduled to run now.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts b/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts index a32f9fc74d..d5597e6cfa 100644 --- a/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts +++ b/specification/transform/schedule_now_transform/ScheduleNowTransformRequest.ts @@ -22,11 +22,11 @@ import { Duration } from '@_types/Time' /** * Schedule a transform to start now. - * Instantly runs a transform to process data. * - * If you _schedule_now a transform, it will process the new data instantly, - * without waiting for the configured frequency interval. After _schedule_now API is called, - * the transform will be processed again at now + frequency unless _schedule_now API + * Instantly run a transform to process data. + * If you run this API, the transform will process the new data instantly, + * without waiting for the configured frequency interval. After the API is called, + * the transform will be processed again at `now + frequency` unless the API * is called again in the meantime. * @rest_spec_name transform.schedule_now_transform * @availability stack since=8.7.0 stability=stable diff --git a/specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml b/specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml new file mode 100644 index 0000000000..1817ada01e --- /dev/null +++ b/specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when the transform is scheduled to run now. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/transform/start_transform/StartTransformRequest.ts b/specification/transform/start_transform/StartTransformRequest.ts index b471b44e93..5b3b630e9c 100644 --- a/specification/transform/start_transform/StartTransformRequest.ts +++ b/specification/transform/start_transform/StartTransformRequest.ts @@ -23,7 +23,6 @@ import { Duration } from '@_types/Time' /** * Start a transform. - * Starts a transform. * * When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is * set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping diff --git a/specification/transform/start_transform/StartTransformResponseExample1.json b/specification/transform/start_transform/StartTransformResponseExample1.json deleted file mode 100644 index 56ac7d36dc..0000000000 --- a/specification/transform/start_transform/StartTransformResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when a transform starts.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml b/specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml new file mode 100644 index 0000000000..0151957f00 --- /dev/null +++ b/specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when a transform starts. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/transform/stop_transform/StopTransformResponseExample1.json b/specification/transform/stop_transform/StopTransformResponseExample1.json deleted file mode 100644 index 577af96b33..0000000000 --- a/specification/transform/stop_transform/StopTransformResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when a transform stops.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml b/specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml new file mode 100644 index 0000000000..024221fa06 --- /dev/null +++ b/specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when a transform stops. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/transform/upgrade_transforms/UpgradeTransformResponseExample1.json b/specification/transform/upgrade_transforms/UpgradeTransformResponseExample1.json deleted file mode 100644 index 78dd76a16e..0000000000 --- a/specification/transform/upgrade_transforms/UpgradeTransformResponseExample1.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "summary": "A successful response contains a summary when all transforms are upgraded.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "needs_update": 0, - "updated": 2, - "no_action": 1 - } -} diff --git a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts index 19f5d67198..ac3675d7e8 100644 --- a/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts +++ b/specification/transform/upgrade_transforms/UpgradeTransformsRequest.ts @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time' /** * Upgrade all transforms. + * * Transforms are compatible across minor versions and between supported major versions. * However, over time, the format of transform configuration information may change. * This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. diff --git a/specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml b/specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml new file mode 100644 index 0000000000..b4461474e6 --- /dev/null +++ b/specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response contains a summary when all transforms are upgraded. +# type: response +# response_code: 200 +value: + needs_update: 0 + updated: 2 + no_action: 1