From a0aa1c4e43a34f4d9f88e0b7ca89829c837d6a10 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 24 Jun 2024 09:51:46 -0700 Subject: [PATCH 1/9] [OAS] Add APM operationIds --- .../plugins/observability_solution/apm/docs/openapi/apm.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml index 60c8a74d75b88..d37137302fd21 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml @@ -15,6 +15,7 @@ paths: post: summary: Create an APM agent key description: Create a new agent key for APM. + operationId: createAgentKey tags: - APM agent keys requestBody: @@ -56,6 +57,7 @@ paths: get: summary: Search for annotations description: Search for annotations related to a specific service. + operationId: getAnnotation tags: - APM annotations parameters: @@ -110,6 +112,7 @@ paths: post: summary: Create a service annotation description: Create a new annotation for a specific service. + operationId: createAnnotation tags: - APM annotations parameters: From a895a24a48980dd2acb60124bbef92f636d51e72 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 24 Jun 2024 09:53:07 -0700 Subject: [PATCH 2/9] Refresh joined bundle --- oas_docs/kibana.serverless.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/oas_docs/kibana.serverless.yaml b/oas_docs/kibana.serverless.yaml index 24cf6df24a4d4..37082573fc9a9 100644 --- a/oas_docs/kibana.serverless.yaml +++ b/oas_docs/kibana.serverless.yaml @@ -76,6 +76,7 @@ paths: post: summary: Create an APM agent key description: Create a new agent key for APM. + operationId: createAgentKey tags: - APM agent keys requestBody: @@ -117,6 +118,7 @@ paths: get: summary: Search for annotations description: Search for annotations related to a specific service. + operationId: getAnnotation tags: - APM annotations parameters: @@ -171,6 +173,7 @@ paths: post: summary: Create a service annotation description: Create a new annotation for a specific service. + operationId: createAnnotation tags: - APM annotations parameters: From 21a4ae08fe91f84071cec8a31c303f536d318e5a Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 24 Jun 2024 10:03:24 -0700 Subject: [PATCH 3/9] Enable operation ID linting rules --- oas_docs/.spectral.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/oas_docs/.spectral.yaml b/oas_docs/.spectral.yaml index b328e320e23eb..7ed4b0fe0d725 100644 --- a/oas_docs/.spectral.yaml +++ b/oas_docs/.spectral.yaml @@ -14,9 +14,9 @@ rules: oas3-valid-schema-example: false oas2-valid-media-example: false # Operations - operation-operationId: false - operation-operationId-unique: false - operation-operationId-valid-in-url: false + operation-operationId: warn + operation-operationId-unique: warn + operation-operationId-valid-in-url: warn operation-tag-defined: warn operation-tags: warn # Responses From d926ada6a4df870a1d982e75193c57fb94803742 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 24 Jun 2024 12:49:08 -0700 Subject: [PATCH 4/9] Refresh Gemini and Bedrock connector versions --- oas_docs/kibana.serverless.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/oas_docs/kibana.serverless.yaml b/oas_docs/kibana.serverless.yaml index 37082573fc9a9..1cb58495c3233 100644 --- a/oas_docs/kibana.serverless.yaml +++ b/oas_docs/kibana.serverless.yaml @@ -3327,7 +3327,7 @@ components: description: > The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models. - default: anthropic.claude-3-sonnet-20240229-v1:0 + default: anthropic.claude-3-5-sonnet-20240620-v1:0 Connectors_secrets_properties_bedrock: title: Connector secrets properties for an Amazon Bedrock connector description: Defines secrets for connectors when type is `.bedrock`. @@ -3359,7 +3359,7 @@ components: description: >- The generative artificial intelligence model for Google Gemini to use. - default: gemini-1.5-pro-preview-0409 + default: gemini-1.5-pro-001 gcpRegion: type: string description: The GCP region where the Vertex AI endpoint enabled. @@ -3597,7 +3597,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -3607,7 +3607,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -5275,7 +5275,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean From f3ac65b9d6a50064c057744a06418798b61f943c Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 24 Jun 2024 13:15:00 -0700 Subject: [PATCH 5/9] Remove apm.yaml changes --- .../plugins/observability_solution/apm/docs/openapi/apm.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml b/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml index d37137302fd21..60c8a74d75b88 100644 --- a/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml +++ b/x-pack/plugins/observability_solution/apm/docs/openapi/apm.yaml @@ -15,7 +15,6 @@ paths: post: summary: Create an APM agent key description: Create a new agent key for APM. - operationId: createAgentKey tags: - APM agent keys requestBody: @@ -57,7 +56,6 @@ paths: get: summary: Search for annotations description: Search for annotations related to a specific service. - operationId: getAnnotation tags: - APM annotations parameters: @@ -112,7 +110,6 @@ paths: post: summary: Create a service annotation description: Create a new annotation for a specific service. - operationId: createAnnotation tags: - APM annotations parameters: From e0377a551fe915b15f4edd184348e9a6ddd9cb74 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 16 Jul 2024 18:25:54 -0700 Subject: [PATCH 6/9] Add technical preview callout --- oas_docs/kibana.info.serverless.yaml | 4 ++ oas_docs/kibana.serverless.yaml | 67 +++++++++++++++++++++++----- 2 files changed, 59 insertions(+), 12 deletions(-) diff --git a/oas_docs/kibana.info.serverless.yaml b/oas_docs/kibana.info.serverless.yaml index c96325cf7c75d..09322f0851847 100644 --- a/oas_docs/kibana.info.serverless.yaml +++ b/oas_docs/kibana.info.serverless.yaml @@ -2,6 +2,10 @@ openapi: 3.0.3 info: title: Kibana Serverless APIs description: | + **Technical preview** + This functionality is in technical preview and may be changed or removed in a future release. + Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + The Kibana REST APIs for Elastic serverless enable you to manage resources such as connectors, data views, and saved objects. The API calls are stateless. Each request that you make happens in isolation from other calls diff --git a/oas_docs/kibana.serverless.yaml b/oas_docs/kibana.serverless.yaml index 1cb58495c3233..eb89ee566c709 100644 --- a/oas_docs/kibana.serverless.yaml +++ b/oas_docs/kibana.serverless.yaml @@ -1,26 +1,50 @@ openapi: 3.0.3 info: title: Kibana Serverless APIs - description: | + description: > + **Technical preview** + + This functionality is in technical preview and may be changed or removed in + a future release. + + Elastic will work to fix any issues, but features in technical preview are + not subject to the support SLA of official GA features. + + The Kibana REST APIs for Elastic serverless enable you to manage resources + such as connectors, data views, and saved objects. The API calls are + stateless. Each request that you make happens in isolation from other calls + and must include all of the necessary information for Kibana to fulfill the + request. API requests return JSON output, which is a format that is + machine-readable and works well for automation. + To interact with Kibana APIs, use the following operations: + - GET: Fetches the information. + - POST: Adds new information. + - PUT: Updates the existing information. + - DELETE: Removes the information. + You can prepend any Kibana API endpoint with `kbn:` and run the request in + **Dev Tools → Console**. For example: + ``` + GET kbn:/api/data_views + ``` version: 1.0.2 license: @@ -1249,13 +1273,13 @@ paths: summary: Update data view fields metadata in the default space operationId: updateFieldsMetadataDefault description: > - Update fields presentation metadata such as count, customLabel and - format. This functionality is in technical preview and may be changed or - removed in a future release. Elastic will work to fix any issues, but - features in technical preview are not subject to the support SLA of - official GA features. You can update multiple fields in one request. - Updates are merged with persisted metadata. To remove existing metadata, - specify null as the value. + Update fields presentation metadata such as count, customLabel, + customDescription, and format. This functionality is in technical + preview and may be changed or removed in a future release. Elastic will + work to fix any issues, but features in technical preview are not + subject to the support SLA of official GA features. You can update + multiple fields in one request. Updates are merged with persisted + metadata. To remove existing metadata, specify null as the value. tags: - data views parameters: @@ -5783,6 +5807,17 @@ components: Data_views_fieldattrs: type: object description: A map of field attributes by field name. + properties: + count: + type: integer + description: Popularity count for the field. + customDescription: + type: string + description: Custom description for the field. + maxLength: 300 + customLabel: + type: string + description: Custom label for the field. Data_views_fieldformats: type: object description: A map of field formats by field name. @@ -5838,7 +5873,9 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - $ref: '#/components/schemas/Data_views_fieldattrs' + type: object + additionalProperties: + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -5880,7 +5917,9 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - $ref: '#/components/schemas/Data_views_fieldattrs' + type: object + additionalProperties: + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -8597,11 +8636,15 @@ components: data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f force: true Data_views_update_field_metadata_request: - summary: Set popularity count for field foo. + summary: Update multiple metadata fields. value: fields: - foo: + field1: count: 123 + customLabel: Field 1 label + field2: + customLabel: Field 2 label + customDescription: Field 2 description Data_views_create_runtime_field_request: summary: Create a runtime field. value: From 4279aa76d5f7a82dd1bf437308662ace7e30179f Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 16 Jul 2024 19:10:53 -0700 Subject: [PATCH 7/9] Revert changes to output file --- oas_docs/kibana.serverless.yaml | 80 +++++++-------------------------- 1 file changed, 17 insertions(+), 63 deletions(-) diff --git a/oas_docs/kibana.serverless.yaml b/oas_docs/kibana.serverless.yaml index eb89ee566c709..24cf6df24a4d4 100644 --- a/oas_docs/kibana.serverless.yaml +++ b/oas_docs/kibana.serverless.yaml @@ -1,50 +1,26 @@ openapi: 3.0.3 info: title: Kibana Serverless APIs - description: > - **Technical preview** - - This functionality is in technical preview and may be changed or removed in - a future release. - - Elastic will work to fix any issues, but features in technical preview are - not subject to the support SLA of official GA features. - - + description: | The Kibana REST APIs for Elastic serverless enable you to manage resources - such as connectors, data views, and saved objects. The API calls are - stateless. Each request that you make happens in isolation from other calls - and must include all of the necessary information for Kibana to fulfill the - request. API requests return JSON output, which is a format that is - machine-readable and works well for automation. - To interact with Kibana APIs, use the following operations: - - GET: Fetches the information. - - POST: Adds new information. - - PUT: Updates the existing information. - - DELETE: Removes the information. - You can prepend any Kibana API endpoint with `kbn:` and run the request in - **Dev Tools → Console**. For example: - ``` - GET kbn:/api/data_views - ``` version: 1.0.2 license: @@ -100,7 +76,6 @@ paths: post: summary: Create an APM agent key description: Create a new agent key for APM. - operationId: createAgentKey tags: - APM agent keys requestBody: @@ -142,7 +117,6 @@ paths: get: summary: Search for annotations description: Search for annotations related to a specific service. - operationId: getAnnotation tags: - APM annotations parameters: @@ -197,7 +171,6 @@ paths: post: summary: Create a service annotation description: Create a new annotation for a specific service. - operationId: createAnnotation tags: - APM annotations parameters: @@ -1273,13 +1246,13 @@ paths: summary: Update data view fields metadata in the default space operationId: updateFieldsMetadataDefault description: > - Update fields presentation metadata such as count, customLabel, - customDescription, and format. This functionality is in technical - preview and may be changed or removed in a future release. Elastic will - work to fix any issues, but features in technical preview are not - subject to the support SLA of official GA features. You can update - multiple fields in one request. Updates are merged with persisted - metadata. To remove existing metadata, specify null as the value. + Update fields presentation metadata such as count, customLabel and + format. This functionality is in technical preview and may be changed or + removed in a future release. Elastic will work to fix any issues, but + features in technical preview are not subject to the support SLA of + official GA features. You can update multiple fields in one request. + Updates are merged with persisted metadata. To remove existing metadata, + specify null as the value. tags: - data views parameters: @@ -3351,7 +3324,7 @@ components: description: > The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models. - default: anthropic.claude-3-5-sonnet-20240620-v1:0 + default: anthropic.claude-3-sonnet-20240229-v1:0 Connectors_secrets_properties_bedrock: title: Connector secrets properties for an Amazon Bedrock connector description: Defines secrets for connectors when type is `.bedrock`. @@ -3383,7 +3356,7 @@ components: description: >- The generative artificial intelligence model for Google Gemini to use. - default: gemini-1.5-pro-001 + default: gemini-1.5-pro-preview-0409 gcpRegion: type: string description: The GCP region where the Vertex AI endpoint enabled. @@ -3621,7 +3594,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -3631,7 +3604,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -5299,7 +5272,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean @@ -5807,17 +5780,6 @@ components: Data_views_fieldattrs: type: object description: A map of field attributes by field name. - properties: - count: - type: integer - description: Popularity count for the field. - customDescription: - type: string - description: Custom description for the field. - maxLength: 300 - customLabel: - type: string - description: Custom label for the field. Data_views_fieldformats: type: object description: A map of field formats by field name. @@ -5873,9 +5835,7 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - type: object - additionalProperties: - $ref: '#/components/schemas/Data_views_fieldattrs' + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -5917,9 +5877,7 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - type: object - additionalProperties: - $ref: '#/components/schemas/Data_views_fieldattrs' + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -8636,15 +8594,11 @@ components: data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f force: true Data_views_update_field_metadata_request: - summary: Update multiple metadata fields. + summary: Set popularity count for field foo. value: fields: - field1: + foo: count: 123 - customLabel: Field 1 label - field2: - customLabel: Field 2 label - customDescription: Field 2 description Data_views_create_runtime_field_request: summary: Create a runtime field. value: From d9ceb37b8985ab532c0844819ae4d0144b7c175a Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 18 Jul 2024 07:47:00 -0700 Subject: [PATCH 8/9] Regenerate output file --- oas_docs/kibana.serverless.yaml | 80 ++++++++++++++++++++++++++------- 1 file changed, 63 insertions(+), 17 deletions(-) diff --git a/oas_docs/kibana.serverless.yaml b/oas_docs/kibana.serverless.yaml index 24cf6df24a4d4..eb89ee566c709 100644 --- a/oas_docs/kibana.serverless.yaml +++ b/oas_docs/kibana.serverless.yaml @@ -1,26 +1,50 @@ openapi: 3.0.3 info: title: Kibana Serverless APIs - description: | + description: > + **Technical preview** + + This functionality is in technical preview and may be changed or removed in + a future release. + + Elastic will work to fix any issues, but features in technical preview are + not subject to the support SLA of official GA features. + + The Kibana REST APIs for Elastic serverless enable you to manage resources + such as connectors, data views, and saved objects. The API calls are + stateless. Each request that you make happens in isolation from other calls + and must include all of the necessary information for Kibana to fulfill the + request. API requests return JSON output, which is a format that is + machine-readable and works well for automation. + To interact with Kibana APIs, use the following operations: + - GET: Fetches the information. + - POST: Adds new information. + - PUT: Updates the existing information. + - DELETE: Removes the information. + You can prepend any Kibana API endpoint with `kbn:` and run the request in + **Dev Tools → Console**. For example: + ``` + GET kbn:/api/data_views + ``` version: 1.0.2 license: @@ -76,6 +100,7 @@ paths: post: summary: Create an APM agent key description: Create a new agent key for APM. + operationId: createAgentKey tags: - APM agent keys requestBody: @@ -117,6 +142,7 @@ paths: get: summary: Search for annotations description: Search for annotations related to a specific service. + operationId: getAnnotation tags: - APM annotations parameters: @@ -171,6 +197,7 @@ paths: post: summary: Create a service annotation description: Create a new annotation for a specific service. + operationId: createAnnotation tags: - APM annotations parameters: @@ -1246,13 +1273,13 @@ paths: summary: Update data view fields metadata in the default space operationId: updateFieldsMetadataDefault description: > - Update fields presentation metadata such as count, customLabel and - format. This functionality is in technical preview and may be changed or - removed in a future release. Elastic will work to fix any issues, but - features in technical preview are not subject to the support SLA of - official GA features. You can update multiple fields in one request. - Updates are merged with persisted metadata. To remove existing metadata, - specify null as the value. + Update fields presentation metadata such as count, customLabel, + customDescription, and format. This functionality is in technical + preview and may be changed or removed in a future release. Elastic will + work to fix any issues, but features in technical preview are not + subject to the support SLA of official GA features. You can update + multiple fields in one request. Updates are merged with persisted + metadata. To remove existing metadata, specify null as the value. tags: - data views parameters: @@ -3324,7 +3351,7 @@ components: description: > The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models. - default: anthropic.claude-3-sonnet-20240229-v1:0 + default: anthropic.claude-3-5-sonnet-20240620-v1:0 Connectors_secrets_properties_bedrock: title: Connector secrets properties for an Amazon Bedrock connector description: Defines secrets for connectors when type is `.bedrock`. @@ -3356,7 +3383,7 @@ components: description: >- The generative artificial intelligence model for Google Gemini to use. - default: gemini-1.5-pro-preview-0409 + default: gemini-1.5-pro-001 gcpRegion: type: string description: The GCP region where the Vertex AI endpoint enabled. @@ -3594,7 +3621,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -3604,7 +3631,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -5272,7 +5299,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean @@ -5780,6 +5807,17 @@ components: Data_views_fieldattrs: type: object description: A map of field attributes by field name. + properties: + count: + type: integer + description: Popularity count for the field. + customDescription: + type: string + description: Custom description for the field. + maxLength: 300 + customLabel: + type: string + description: Custom label for the field. Data_views_fieldformats: type: object description: A map of field formats by field name. @@ -5835,7 +5873,9 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - $ref: '#/components/schemas/Data_views_fieldattrs' + type: object + additionalProperties: + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -5877,7 +5917,9 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - $ref: '#/components/schemas/Data_views_fieldattrs' + type: object + additionalProperties: + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -8594,11 +8636,15 @@ components: data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f force: true Data_views_update_field_metadata_request: - summary: Set popularity count for field foo. + summary: Update multiple metadata fields. value: fields: - foo: + field1: count: 123 + customLabel: Field 1 label + field2: + customLabel: Field 2 label + customDescription: Field 2 description Data_views_create_runtime_field_request: summary: Create a runtime field. value: From d81041820de620b7441df59d0afe17e839dba3c0 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 18 Jul 2024 07:53:34 -0700 Subject: [PATCH 9/9] Revert "Regenerate output file" This reverts commit d9ceb37b8985ab532c0844819ae4d0144b7c175a. --- oas_docs/kibana.serverless.yaml | 80 +++++++-------------------------- 1 file changed, 17 insertions(+), 63 deletions(-) diff --git a/oas_docs/kibana.serverless.yaml b/oas_docs/kibana.serverless.yaml index eb89ee566c709..24cf6df24a4d4 100644 --- a/oas_docs/kibana.serverless.yaml +++ b/oas_docs/kibana.serverless.yaml @@ -1,50 +1,26 @@ openapi: 3.0.3 info: title: Kibana Serverless APIs - description: > - **Technical preview** - - This functionality is in technical preview and may be changed or removed in - a future release. - - Elastic will work to fix any issues, but features in technical preview are - not subject to the support SLA of official GA features. - - + description: | The Kibana REST APIs for Elastic serverless enable you to manage resources - such as connectors, data views, and saved objects. The API calls are - stateless. Each request that you make happens in isolation from other calls - and must include all of the necessary information for Kibana to fulfill the - request. API requests return JSON output, which is a format that is - machine-readable and works well for automation. - To interact with Kibana APIs, use the following operations: - - GET: Fetches the information. - - POST: Adds new information. - - PUT: Updates the existing information. - - DELETE: Removes the information. - You can prepend any Kibana API endpoint with `kbn:` and run the request in - **Dev Tools → Console**. For example: - ``` - GET kbn:/api/data_views - ``` version: 1.0.2 license: @@ -100,7 +76,6 @@ paths: post: summary: Create an APM agent key description: Create a new agent key for APM. - operationId: createAgentKey tags: - APM agent keys requestBody: @@ -142,7 +117,6 @@ paths: get: summary: Search for annotations description: Search for annotations related to a specific service. - operationId: getAnnotation tags: - APM annotations parameters: @@ -197,7 +171,6 @@ paths: post: summary: Create a service annotation description: Create a new annotation for a specific service. - operationId: createAnnotation tags: - APM annotations parameters: @@ -1273,13 +1246,13 @@ paths: summary: Update data view fields metadata in the default space operationId: updateFieldsMetadataDefault description: > - Update fields presentation metadata such as count, customLabel, - customDescription, and format. This functionality is in technical - preview and may be changed or removed in a future release. Elastic will - work to fix any issues, but features in technical preview are not - subject to the support SLA of official GA features. You can update - multiple fields in one request. Updates are merged with persisted - metadata. To remove existing metadata, specify null as the value. + Update fields presentation metadata such as count, customLabel and + format. This functionality is in technical preview and may be changed or + removed in a future release. Elastic will work to fix any issues, but + features in technical preview are not subject to the support SLA of + official GA features. You can update multiple fields in one request. + Updates are merged with persisted metadata. To remove existing metadata, + specify null as the value. tags: - data views parameters: @@ -3351,7 +3324,7 @@ components: description: > The generative artificial intelligence model for Amazon Bedrock to use. Current support is for the Anthropic Claude models. - default: anthropic.claude-3-5-sonnet-20240620-v1:0 + default: anthropic.claude-3-sonnet-20240229-v1:0 Connectors_secrets_properties_bedrock: title: Connector secrets properties for an Amazon Bedrock connector description: Defines secrets for connectors when type is `.bedrock`. @@ -3383,7 +3356,7 @@ components: description: >- The generative artificial intelligence model for Google Gemini to use. - default: gemini-1.5-pro-001 + default: gemini-1.5-pro-preview-0409 gcpRegion: type: string description: The GCP region where the Vertex AI endpoint enabled. @@ -3621,7 +3594,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -3631,7 +3604,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -5299,7 +5272,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean @@ -5807,17 +5780,6 @@ components: Data_views_fieldattrs: type: object description: A map of field attributes by field name. - properties: - count: - type: integer - description: Popularity count for the field. - customDescription: - type: string - description: Custom description for the field. - maxLength: 300 - customLabel: - type: string - description: Custom label for the field. Data_views_fieldformats: type: object description: A map of field formats by field name. @@ -5873,9 +5835,7 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - type: object - additionalProperties: - $ref: '#/components/schemas/Data_views_fieldattrs' + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -5917,9 +5877,7 @@ components: allowNoIndex: $ref: '#/components/schemas/Data_views_allownoindex' fieldAttrs: - type: object - additionalProperties: - $ref: '#/components/schemas/Data_views_fieldattrs' + $ref: '#/components/schemas/Data_views_fieldattrs' fieldFormats: $ref: '#/components/schemas/Data_views_fieldformats' fields: @@ -8636,15 +8594,11 @@ components: data_view_id: ff959d40-b880-11e8-a6d9-e546fe2bba5f force: true Data_views_update_field_metadata_request: - summary: Update multiple metadata fields. + summary: Set popularity count for field foo. value: fields: - field1: + foo: count: 123 - customLabel: Field 1 label - field2: - customLabel: Field 2 label - customDescription: Field 2 description Data_views_create_runtime_field_request: summary: Create a runtime field. value: