diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 5ca1a76e86..2b77b1656c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -17144,7 +17144,7 @@ "migration" ], "summary": "Get deprecation information", - "description": "Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", + "description": "Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "operationId": "migration-deprecations", "responses": { "200": { @@ -17160,7 +17160,7 @@ "migration" ], "summary": "Get deprecation information", - "description": "Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", + "description": "Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "operationId": "migration-deprecations-1", "parameters": [ { @@ -17181,7 +17181,7 @@ "migration" ], "summary": "Get feature migration information", - "description": "Version upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", + "description": "Version upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "operationId": "migration-get-feature-upgrade-status", "responses": { "200": { @@ -74032,15 +74032,18 @@ "type": "object", "properties": { "details": { + "description": "Optional details about the deprecation warning.", "type": "string" }, "level": { "$ref": "#/components/schemas/migration.deprecations:DeprecationLevel" }, "message": { + "description": "Descriptive information about the deprecation warning.", "type": "string" }, "url": { + "description": "A link to the breaking change documentation, where you can find more information about this change.", "type": "string" }, "resolve_during_rolling_upgrade": { @@ -92753,12 +92756,14 @@ "type": "object", "properties": { "cluster_settings": { + "description": "Cluster-level deprecation warnings.", "type": "array", "items": { "$ref": "#/components/schemas/migration.deprecations:Deprecation" } }, "index_settings": { + "description": "Index warnings are sectioned off per index and can be filtered using an index-pattern in the query.\nThis section includes warnings for the backing indices of data streams specified in the request path.", "type": "object", "additionalProperties": { "type": "array", @@ -92777,12 +92782,14 @@ } }, "node_settings": { + "description": "Node-level deprecation warnings.\nSince only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected.", "type": "array", "items": { "$ref": "#/components/schemas/migration.deprecations:Deprecation" } }, "ml_settings": { + "description": "Machine learning-related deprecation warnings.", "type": "array", "items": { "$ref": "#/components/schemas/migration.deprecations:Deprecation" diff --git a/output/schema/schema.json b/output/schema/schema.json index e698bc765b..2077d74088 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -9807,8 +9807,9 @@ "stability": "stable" } }, - "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html", + "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", + "docId": "migration-api-deprecation", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-deprecation.html", "name": "migration.deprecations", "privileges": { "cluster": [ @@ -9849,8 +9850,9 @@ "stability": "stable" } }, - "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", + "docId": "migration-api-feature-upgrade", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/feature-migration-api.html", "name": "migration.get_feature_upgrade_status", "privileges": { "cluster": [ @@ -9889,7 +9891,8 @@ } }, "description": "Start the feature migration.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nThis API starts the automatic migration process.\n\nSome functionality might be temporarily unavailable during the migration process.\n\nTIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html", + "docId": "migration-api-feature-upgrade", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/feature-migration-api.html", "name": "migration.post_feature_upgrade", "privileges": { "cluster": [ @@ -151086,6 +151089,7 @@ }, "properties": [ { + "description": "Optional details about the deprecation warning.", "name": "details", "required": false, "type": { @@ -151109,6 +151113,7 @@ } }, { + "description": "Descriptive information about the deprecation warning.", "name": "message", "required": true, "type": { @@ -151120,6 +151125,7 @@ } }, { + "description": "A link to the breaking change documentation, where you can find more information about this change.", "name": "url", "required": true, "type": { @@ -151160,7 +151166,7 @@ } } ], - "specLocation": "migration/deprecations/types.ts#L32-L40" + "specLocation": "migration/deprecations/types.ts#L32-L47" }, { "kind": "enum", @@ -151194,7 +151200,7 @@ "body": { "kind": "no_body" }, - "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.", + "description": "Get deprecation information.\nGet information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.\n\nTIP: This APIs is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -151220,7 +151226,7 @@ } ], "query": [], - "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L37" + "specLocation": "migration/deprecations/DeprecationInfoRequest.ts#L23-L39" }, { "kind": "response", @@ -151228,6 +151234,7 @@ "kind": "properties", "properties": [ { + "description": "Cluster-level deprecation warnings.", "name": "cluster_settings", "required": true, "type": { @@ -151242,6 +151249,7 @@ } }, { + "description": "Index warnings are sectioned off per index and can be filtered using an index-pattern in the query.\nThis section includes warnings for the backing indices of data streams specified in the request path.", "name": "index_settings", "required": true, "type": { @@ -151292,6 +151300,7 @@ } }, { + "description": "Node-level deprecation warnings.\nSince only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected.", "name": "node_settings", "required": true, "type": { @@ -151306,6 +151315,7 @@ } }, { + "description": "Machine learning-related deprecation warnings.", "name": "ml_settings", "required": true, "type": { @@ -151325,7 +151335,7 @@ "name": "Response", "namespace": "migration.deprecations" }, - "specLocation": "migration/deprecations/DeprecationInfoResponse.ts#L23-L31" + "specLocation": "migration/deprecations/DeprecationInfoResponse.ts#L23-L45" }, { "kind": "interface", @@ -151457,7 +151467,7 @@ "body": { "kind": "no_body" }, - "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nWe strongly recommend you use the Upgrade Assistant.", + "description": "Get feature migration information.\nVersion upgrades sometimes require changes to how features store configuration information and data in system indices.\nCheck which features need to be migrated and the status of any migrations that are in progress.\n\nTIP: This API is designed for indirect use by the Upgrade Assistant.\nYou are strongly recommended to use the Upgrade Assistant.", "inherits": { "type": { "name": "RequestBase", @@ -151470,7 +151480,7 @@ }, "path": [], "query": [], - "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L34" + "specLocation": "migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts#L22-L35" }, { "kind": "response", @@ -151552,7 +151562,7 @@ }, "path": [], "query": [], - "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L35" + "specLocation": "migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts#L22-L36" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index c603b6e420..bae8669d20 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -306,7 +306,7 @@ mapping,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/mapping mean-reciprocal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_mean_reciprocal_rank migrate-index-allocation-filters,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migrate-index-allocation-filters.html migration-api-deprecation,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-deprecation.html -migration-api-feature-upgrade,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/migration-api-feature-upgrade.html +migration-api-feature-upgrade,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/feature-migration-api.html ml-apis,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-apis.html ml-classification,https://www.elastic.co/guide/en/machine-learning/{branch}/ml-dfa-classification.html ml-close-job,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html diff --git a/specification/migration/deprecations/DeprecationInfoRequest.ts b/specification/migration/deprecations/DeprecationInfoRequest.ts index a750d93280..9f570e8a79 100644 --- a/specification/migration/deprecations/DeprecationInfoRequest.ts +++ b/specification/migration/deprecations/DeprecationInfoRequest.ts @@ -24,10 +24,12 @@ import { IndexName } from '@_types/common' * Get deprecation information. * Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. * - * TIP: This APIs is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. + * TIP: This APIs is designed for indirect use by the Upgrade Assistant. + * You are strongly recommended to use the Upgrade Assistant. * @rest_spec_name migration.deprecations * @availability stack since=6.1.0 stability=stable * @cluster_privileges manage + * @doc_id migration-api-deprecation */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/migration/deprecations/DeprecationInfoResponse.ts b/specification/migration/deprecations/DeprecationInfoResponse.ts index 38cdf5892b..beb24705f9 100644 --- a/specification/migration/deprecations/DeprecationInfoResponse.ts +++ b/specification/migration/deprecations/DeprecationInfoResponse.ts @@ -22,10 +22,24 @@ import { Deprecation } from './types' export class Response { body: { + /** + * Cluster-level deprecation warnings. + */ cluster_settings: Deprecation[] + /** + * Index warnings are sectioned off per index and can be filtered using an index-pattern in the query. + * This section includes warnings for the backing indices of data streams specified in the request path. + */ index_settings: Dictionary data_streams: Dictionary + /** + * Node-level deprecation warnings. + * Since only a subset of your nodes might incorporate these settings, it is important to read the details section for more information about which nodes are affected. + */ node_settings: Deprecation[] + /** + * Machine learning-related deprecation warnings. + */ ml_settings: Deprecation[] } } diff --git a/specification/migration/deprecations/DeprecationInfoResponseExample1.yaml b/specification/migration/deprecations/DeprecationInfoResponseExample1.yaml new file mode 100644 index 0000000000..3c71c91c27 --- /dev/null +++ b/specification/migration/deprecations/DeprecationInfoResponseExample1.yaml @@ -0,0 +1,19 @@ +# summary: +description: > + An abbreviated response from `GET /_migration/deprecations`. +# type: "response" +# response_code: 200 +value: + cluster_settings: + - level: critical + message: "Cluster name cannot contain ':'" + url: 'https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name' + details: "This cluster is named [mycompany:logging], which contains the illegal character ':'." + node_settings: [] + index_settings: + 'logs:apache': + - level: warning + message: "Index name cannot contain ':'" + url: 'https://www.elastic.co/guide/en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name' + details: "This index is named [logs:apache], which contains the illegal character ':'." + ml_settings: [] diff --git a/specification/migration/deprecations/types.ts b/specification/migration/deprecations/types.ts index 4bf5fc7e07..a99c37bf64 100644 --- a/specification/migration/deprecations/types.ts +++ b/specification/migration/deprecations/types.ts @@ -30,10 +30,17 @@ export enum DeprecationLevel { } export class Deprecation { + /** + * Optional details about the deprecation warning. + */ details?: string /** The level property describes the significance of the issue. */ level: DeprecationLevel + /** Descriptive information about the deprecation warning. */ message: string + /** + * A link to the breaking change documentation, where you can find more information about this change. + */ url: string resolve_during_rolling_upgrade: boolean _meta?: Dictionary diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts index e953f6b4a5..907eab12de 100644 --- a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusRequest.ts @@ -25,10 +25,11 @@ import { RequestBase } from '@_types/Base' * Check which features need to be migrated and the status of any migrations that are in progress. * * TIP: This API is designed for indirect use by the Upgrade Assistant. - * We strongly recommend you use the Upgrade Assistant. + * You are strongly recommended to use the Upgrade Assistant. * @rest_spec_name migration.get_feature_upgrade_status * @availability stack since=7.16.0 stability=stable * @index_privileges manage * @cluster_privileges manage + * @doc_id migration-api-feature-upgrade */ export interface Request extends RequestBase {} diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponseExample1.yaml b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponseExample1.yaml new file mode 100644 index 0000000000..8e2bc93fde --- /dev/null +++ b/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponseExample1.yaml @@ -0,0 +1,36 @@ +# summary: +description: A successful response from `GET /_migration/system_features`. +# type: response +# response_code: '' +value: + "{\n \"features\" : [\n {\n \"feature_name\" : \"async_search\",\n\ + \ \"minimum_index_version\" : \"8100099\",\n \"migration_status\" : \"\ + NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"enrich\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"ent_search\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"fleet\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"geoip\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"kibana\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"logstash_management\",\n \"minimum_index_version\" : \"8100099\",\n \ + \ \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n\ + \ },\n {\n \"feature_name\" : \"machine_learning\",\n \"minimum_index_version\"\ + \ : \"8100099\",\n \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n \"\ + indices\" : [ ]\n },\n {\n \"feature_name\" : \"searchable_snapshots\"\ + ,\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\" :\ + \ \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"security\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"synonyms\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"tasks\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"transform\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n },\n {\n \"feature_name\"\ + \ : \"watcher\",\n \"minimum_index_version\" : \"8100099\",\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\",\n \"indices\" : [ ]\n }\n ],\n \"migration_status\"\ + \ : \"NO_MIGRATION_NEEDED\"\n}" diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts index 822ecc610d..33012d29f3 100644 --- a/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeRequest.ts @@ -31,5 +31,6 @@ import { RequestBase } from '@_types/Base' * @availability stack since=7.16.0 stability=stable * @index_privileges manage * @cluster_privileges manage + * @doc_id migration-api-feature-upgrade */ export interface Request extends RequestBase {} diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponseExample1.yaml b/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponseExample1.yaml new file mode 100644 index 0000000000..fe0975bb42 --- /dev/null +++ b/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: > + When you run `POST /_migration/system_features` to start the migration process, the response lists the features that will be migrated. +# type: response +# response_code: '' +value: + "{\n \"accepted\" : true,\n \"features\" : [\n {\n \"feature_name\"\ + \ : \"security\"\n }\n ]\n}"