From 48b76723e79f98b27721aa1cc966b5acada0cc35 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 23 Oct 2024 16:43:54 -0700 Subject: [PATCH] [Backport 8.16] [OpenAPI] Edits connector API summaries (#3072) --- .../elasticsearch-openapi-overlays.yaml | 2 +- .../elasticsearch-shared-overlays.yaml | 56 ++++---- output/openapi/elasticsearch-openapi.json | 70 +++++---- .../elasticsearch-serverless-openapi.json | 67 +++++---- output/schema/schema.json | 136 +++++++++--------- .../check_in/ConnectorCheckInRequest.ts | 4 +- .../delete/ConnectorDeleteRequest.ts | 7 +- .../connector/get/ConnectorGetRequest.ts | 4 +- .../ConnectorUpdateLastSyncRequest.ts | 5 +- .../connector/list/ConnectorListRequest.ts | 4 +- .../connector/post/ConnectorPostRequest.ts | 6 +- .../connector/put/ConnectorPutRequest.ts | 2 +- .../sync_job_cancel/SyncJobCancelRequest.ts | 5 +- .../sync_job_delete/SyncJobDeleteRequest.ts | 5 +- .../sync_job_get/SyncJobGetRequest.ts | 2 +- .../sync_job_list/SyncJobListRequest.ts | 4 +- .../sync_job_post/SyncJobPostRequest.ts | 4 +- .../ConnectorUpdateActiveFilteringRequest.ts | 2 + .../ConnectorUpdateAPIKeyIDRequest.ts | 7 +- .../ConnectorUpdateConfigurationRequest.ts | 4 +- .../ConnectorUpdateErrorRequest.ts | 6 +- .../ConnectorUpdateFilteringRequest.ts | 6 +- ...nnectorUpdateFilteringValidationRequest.ts | 4 +- .../ConnectorUpdateIndexNameRequest.ts | 4 +- .../update_name/ConnectorUpdateNameRequest.ts | 2 +- .../ConnectorUpdateNativeRequest.ts | 2 +- .../ConnectorUpdatePipelineRequest.ts | 4 +- .../ConnectorUpdateSchedulingRequest.ts | 2 +- .../ConnectorUpdateServiceTypeRequest.ts | 2 +- .../ConnectorUpdateStatusRequest.ts | 2 +- 30 files changed, 259 insertions(+), 171 deletions(-) diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index ffc1de32dd..b1dffe9c20 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -13,7 +13,7 @@ actions: ## Documentation source and versions - This documentation is derived from the `8.x` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository. + This documentation is derived from the `8.16` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository. It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/). x-doc-license: name: Attribution-NonCommercial-NoDerivatives 4.0 International diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index aa281bca6e..9eb8e34329 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -35,13 +35,15 @@ actions: Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure: - * Native connectors are a managed service on Elastic Cloud - * Connector clients are self-managed on your infrastructure + * Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud + + * Self-managed connectors (Connector clients) are self-managed on your infrastructure. + This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid. externalDocs: - url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html - description: To get started with Connector APIs, check out the tutorial. + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/es-connectors-tutorial-api.html + description: Connector API tutorial - name: ccr x-displayName: Cross-cluster replication # D @@ -49,12 +51,12 @@ actions: x-displayName: Data stream externalDocs: description: Data stream overview - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/data-streams.html - name: document x-displayName: Document externalDocs: description: Reading and writing documents - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-replication.html - name: mget x-displayName: Document - Multi get - name: mtermvectors @@ -71,14 +73,14 @@ actions: description: > Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql.html description: EQL search - name: esql x-displayName: ES|QL description: > The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql.html description: ES|QL overview and tutorials # F - name: features @@ -92,7 +94,7 @@ actions: description: > The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index. externalDocs: - url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html + url: https://www.elastic.co/guide/en/kibana/8.16/xpack-graph.html description: Getting started with Graph # I - name: indices @@ -104,7 +106,7 @@ actions: - name: ilm x-displayName: Index lifecycle management externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-lifecycle-management.html description: Manage the index lifecycle - name: inference x-displayName: Inference @@ -126,7 +128,7 @@ actions: description: > Logstash APIs enable you to manage pipelines that are used by Logstash Central Management. externalDocs: - url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html + url: https://www.elastic.co/guide/en/logstash/8.16/logstash-centralized-pipeline-management.html description: Centralized pipeline management # M - name: ml @@ -135,19 +137,19 @@ actions: x-displayName: Machine learning anomaly detection # description: externalDocs: - url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html + url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-ad-finding-anomalies.html description: Finding anomalies - name: ml data frame x-displayName: Machine learning data frame analytics # description: externalDocs: - url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html + url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-dfa-overview.html description: Data frame analytics overview - name: ml trained model x-displayName: Machine learning trained model # description: externalDocs: - url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html + url: https://www.elastic.co/guide/en/machine-learning/8.16/ml-nlp-overview.html description: Natural language processing overview - name: migration x-displayName: Migration @@ -167,7 +169,7 @@ actions: If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching. This allows pinning documents for only queries that match a specific term. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl-rule-query.html description: Rule query # R - name: rollup @@ -200,21 +202,21 @@ actions: description: > Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshot-restore.html description: Snapshot and restore - name: slm x-displayName: Snapshot lifecycle management description: > Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/snapshots-take-snapshot.html description: Create a snapshot - name: sql x-displayName: SQL description: > Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/xpack-sql.html description: An overview and tutorials for the Elasticsearch SQL features - name: synonyms x-displayName: Synonyms @@ -250,7 +252,7 @@ actions: description: > Character filters that are used to preprocess characters before they are passed to the tokenizer. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-charfilters.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-charfilters.html description: Character filters reference - target: "$.components['schemas']['_types.analysis:Tokenizer'].oneOf" description: Remove existing oneOf definition for tokenizer @@ -262,7 +264,7 @@ actions: description: > A tokenizer to use to convert text into tokens. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html description: Tokenizer reference - target: "$.components['schemas']['_types.analysis:TokenFilter'].oneOf" description: Remove existing oneOf definition for tokenfilter @@ -274,7 +276,7 @@ actions: description: > Token filters that are applied after the tokenizer. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenfilters.html description: Token filter reference - target: "$.components['schemas']['security._types:RoleTemplateScript']" description: Add x-model where recommended by Bump.sh @@ -282,7 +284,7 @@ actions: x-model: true externalDocs: description: Templating a role query - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/field-and-document-access-control.html#templating-role-query # Abbreviate and annotate items that are not shown in Bump.sh due to depth limits - target: "$.components['schemas']['ml._types:Datafeed'].properties.query" description: Remove query object from anomaly detection datafeed @@ -299,7 +301,7 @@ actions: All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: `{"match_all": {"boost": 1}}`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html description: Query DSL - target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer" description: Remove tokenizer object from ML anomaly detection analysis config @@ -320,7 +322,7 @@ actions: Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/analysis-tokenizers.html description: Tokenizer reference - target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query" description: Remove query object from data frame analytics source @@ -337,7 +339,7 @@ actions: All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: `{"match_all": {}}`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html description: Query DSL - target: "$.components['schemas']['transform._types:Source'].properties.query" description: Remove query object from transform source @@ -351,14 +353,14 @@ actions: description: > A query clause that retrieves a subset of data from the source index. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/query-dsl.html description: Query DSL - target: "$.components['schemas']['_global.search._types:FieldCollapse']" description: Add x-model and externalDocs update: x-model: true externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/master/collapse-search-results.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/8.16/collapse-search-results.html - target: "$.components['schemas']['_global.msearch:MultisearchBody'].properties" description: Add x-model update: diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index aac893e7f4..85ca1f13e4 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -4019,7 +4019,8 @@ "tags": [ "connector" ], - "summary": "Updates the last_seen field in the connector, and sets it to current timestamp", + "summary": "Check in a connector", + "description": "Update the `last_seen` field in the connector and set it to the current timestamp.", "operationId": "connector-check-in", "parameters": [ { @@ -4062,7 +4063,8 @@ "tags": [ "connector" ], - "summary": "Retrieves a connector", + "summary": "Get a connector", + "description": "Get the details about a connector.", "operationId": "connector-get", "parameters": [ { @@ -4095,7 +4097,7 @@ "tags": [ "connector" ], - "summary": "Creates or updates a connector", + "summary": "Create or update a connector", "operationId": "connector-put", "parameters": [ { @@ -4116,7 +4118,8 @@ "tags": [ "connector" ], - "summary": "Deletes a connector", + "summary": "Delete a connector", + "description": "Removes a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "operationId": "connector-delete", "parameters": [ { @@ -4161,7 +4164,8 @@ "tags": [ "connector" ], - "summary": "Updates last sync stats in the connector document", + "summary": "Update the connector last sync stats", + "description": "Update the fields related to the last sync of a connector.\nThis action is used for analytics and monitoring.", "operationId": "connector-last-sync", "parameters": [ { @@ -4252,7 +4256,8 @@ "tags": [ "connector" ], - "summary": "Returns existing connectors", + "summary": "Get all connectors", + "description": "Get information about all connectors.", "operationId": "connector-list", "parameters": [ { @@ -4349,7 +4354,7 @@ "tags": [ "connector" ], - "summary": "Creates or updates a connector", + "summary": "Create or update a connector", "operationId": "connector-put-1", "requestBody": { "$ref": "#/components/requestBodies/connector.put" @@ -4365,7 +4370,8 @@ "tags": [ "connector" ], - "summary": "Creates a connector", + "summary": "Create a connector", + "description": "Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "operationId": "connector-post", "requestBody": { "content": { @@ -4428,7 +4434,8 @@ "tags": [ "connector" ], - "summary": "Cancels a connector sync job", + "summary": "Cancel a connector sync job", + "description": "Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "operationId": "connector-sync-job-cancel", "parameters": [ { @@ -4471,7 +4478,7 @@ "tags": [ "connector" ], - "summary": "Retrieves a connector sync job", + "summary": "Get a connector sync job", "operationId": "connector-sync-job-get", "parameters": [ { @@ -4504,7 +4511,8 @@ "tags": [ "connector" ], - "summary": "Deletes a connector sync job", + "summary": "Delete a connector sync job", + "description": "Remove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "operationId": "connector-sync-job-delete", "parameters": [ { @@ -4539,7 +4547,8 @@ "tags": [ "connector" ], - "summary": "Lists connector sync jobs", + "summary": "Get all connector sync jobs", + "description": "Get information about all stored connector sync jobs listed by their creation date in ascending order.", "operationId": "connector-sync-job-list", "parameters": [ { @@ -4636,7 +4645,8 @@ "tags": [ "connector" ], - "summary": "Creates a connector sync job", + "summary": "Create a connector sync job", + "description": "Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "operationId": "connector-sync-job-post", "requestBody": { "content": { @@ -4690,7 +4700,8 @@ "tags": [ "connector" ], - "summary": "Activates the valid draft filtering for a connector", + "summary": "Activate the connector draft filter", + "description": "Activates the valid draft filtering for a connector.", "operationId": "connector-update-active-filtering", "parameters": [ { @@ -4733,7 +4744,8 @@ "tags": [ "connector" ], - "summary": "Updates the API key id in the connector document", + "summary": "Update the connector API key ID", + "description": "Update the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "operationId": "connector-update-api-key-id", "parameters": [ { @@ -4794,7 +4806,8 @@ "tags": [ "connector" ], - "summary": "Updates the configuration field in the connector document", + "summary": "Update the connector configuration", + "description": "Update the configuration field in the connector document.", "operationId": "connector-update-configuration", "parameters": [ { @@ -4858,7 +4871,8 @@ "tags": [ "connector" ], - "summary": "Updates the filtering field in the connector document", + "summary": "Update the connector error field", + "description": "Set the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "operationId": "connector-update-error", "parameters": [ { @@ -4926,7 +4940,8 @@ "tags": [ "connector" ], - "summary": "Updates the filtering field in the connector document", + "summary": "Update the connector filtering", + "description": "Update the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "operationId": "connector-update-filtering", "parameters": [ { @@ -4996,7 +5011,8 @@ "tags": [ "connector" ], - "summary": "Updates the draft filtering validation info for a connector", + "summary": "Update the connector draft filtering validation", + "description": "Update the draft filtering validation info for a connector.", "operationId": "connector-update-filtering-validation", "parameters": [ { @@ -5057,7 +5073,8 @@ "tags": [ "connector" ], - "summary": "Updates the index_name in the connector document", + "summary": "Update the connector index name", + "description": "Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "operationId": "connector-update-index-name", "parameters": [ { @@ -5125,7 +5142,7 @@ "tags": [ "connector" ], - "summary": "Updates the name and description fields in the connector document", + "summary": "Update the connector name and description", "operationId": "connector-update-name", "parameters": [ { @@ -5186,7 +5203,7 @@ "tags": [ "connector" ], - "summary": "Updates the is_native flag in the connector document", + "summary": "Update the connector is_native flag", "operationId": "connector-update-native", "parameters": [ { @@ -5247,7 +5264,8 @@ "tags": [ "connector" ], - "summary": "Updates the pipeline field in the connector document", + "summary": "Update the connector pipeline", + "description": "When you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "operationId": "connector-update-pipeline", "parameters": [ { @@ -5308,7 +5326,7 @@ "tags": [ "connector" ], - "summary": "Updates the scheduling field in the connector document", + "summary": "Update the connector scheduling", "operationId": "connector-update-scheduling", "parameters": [ { @@ -5369,7 +5387,7 @@ "tags": [ "connector" ], - "summary": "Updates the service type of the connector", + "summary": "Update the connector service type", "operationId": "connector-update-service-type", "parameters": [ { @@ -5430,7 +5448,7 @@ "tags": [ "connector" ], - "summary": "Updates the status of the connector", + "summary": "Update the connector status", "operationId": "connector-update-status", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 8d90f4b346..6a492e00a8 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -1707,7 +1707,8 @@ "tags": [ "connector" ], - "summary": "Updates the last_seen field in the connector, and sets it to current timestamp", + "summary": "Check in a connector", + "description": "Update the `last_seen` field in the connector and set it to the current timestamp.", "operationId": "connector-check-in", "parameters": [ { @@ -1750,7 +1751,8 @@ "tags": [ "connector" ], - "summary": "Retrieves a connector", + "summary": "Get a connector", + "description": "Get the details about a connector.", "operationId": "connector-get", "parameters": [ { @@ -1783,7 +1785,7 @@ "tags": [ "connector" ], - "summary": "Creates or updates a connector", + "summary": "Create or update a connector", "operationId": "connector-put", "parameters": [ { @@ -1804,7 +1806,8 @@ "tags": [ "connector" ], - "summary": "Deletes a connector", + "summary": "Delete a connector", + "description": "Removes a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "operationId": "connector-delete", "parameters": [ { @@ -1849,7 +1852,8 @@ "tags": [ "connector" ], - "summary": "Returns existing connectors", + "summary": "Get all connectors", + "description": "Get information about all connectors.", "operationId": "connector-list", "parameters": [ { @@ -1946,7 +1950,7 @@ "tags": [ "connector" ], - "summary": "Creates or updates a connector", + "summary": "Create or update a connector", "operationId": "connector-put-1", "requestBody": { "$ref": "#/components/requestBodies/connector.put" @@ -1962,7 +1966,8 @@ "tags": [ "connector" ], - "summary": "Creates a connector", + "summary": "Create a connector", + "description": "Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "operationId": "connector-post", "requestBody": { "content": { @@ -2025,7 +2030,8 @@ "tags": [ "connector" ], - "summary": "Cancels a connector sync job", + "summary": "Cancel a connector sync job", + "description": "Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "operationId": "connector-sync-job-cancel", "parameters": [ { @@ -2068,7 +2074,7 @@ "tags": [ "connector" ], - "summary": "Retrieves a connector sync job", + "summary": "Get a connector sync job", "operationId": "connector-sync-job-get", "parameters": [ { @@ -2101,7 +2107,8 @@ "tags": [ "connector" ], - "summary": "Deletes a connector sync job", + "summary": "Delete a connector sync job", + "description": "Remove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "operationId": "connector-sync-job-delete", "parameters": [ { @@ -2136,7 +2143,8 @@ "tags": [ "connector" ], - "summary": "Lists connector sync jobs", + "summary": "Get all connector sync jobs", + "description": "Get information about all stored connector sync jobs listed by their creation date in ascending order.", "operationId": "connector-sync-job-list", "parameters": [ { @@ -2233,7 +2241,8 @@ "tags": [ "connector" ], - "summary": "Creates a connector sync job", + "summary": "Create a connector sync job", + "description": "Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "operationId": "connector-sync-job-post", "requestBody": { "content": { @@ -2287,7 +2296,8 @@ "tags": [ "connector" ], - "summary": "Activates the valid draft filtering for a connector", + "summary": "Activate the connector draft filter", + "description": "Activates the valid draft filtering for a connector.", "operationId": "connector-update-active-filtering", "parameters": [ { @@ -2330,7 +2340,8 @@ "tags": [ "connector" ], - "summary": "Updates the API key id in the connector document", + "summary": "Update the connector API key ID", + "description": "Update the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "operationId": "connector-update-api-key-id", "parameters": [ { @@ -2391,7 +2402,8 @@ "tags": [ "connector" ], - "summary": "Updates the configuration field in the connector document", + "summary": "Update the connector configuration", + "description": "Update the configuration field in the connector document.", "operationId": "connector-update-configuration", "parameters": [ { @@ -2455,7 +2467,8 @@ "tags": [ "connector" ], - "summary": "Updates the filtering field in the connector document", + "summary": "Update the connector error field", + "description": "Set the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "operationId": "connector-update-error", "parameters": [ { @@ -2523,7 +2536,8 @@ "tags": [ "connector" ], - "summary": "Updates the filtering field in the connector document", + "summary": "Update the connector filtering", + "description": "Update the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "operationId": "connector-update-filtering", "parameters": [ { @@ -2593,7 +2607,8 @@ "tags": [ "connector" ], - "summary": "Updates the draft filtering validation info for a connector", + "summary": "Update the connector draft filtering validation", + "description": "Update the draft filtering validation info for a connector.", "operationId": "connector-update-filtering-validation", "parameters": [ { @@ -2654,7 +2669,8 @@ "tags": [ "connector" ], - "summary": "Updates the index_name in the connector document", + "summary": "Update the connector index name", + "description": "Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "operationId": "connector-update-index-name", "parameters": [ { @@ -2722,7 +2738,7 @@ "tags": [ "connector" ], - "summary": "Updates the name and description fields in the connector document", + "summary": "Update the connector name and description", "operationId": "connector-update-name", "parameters": [ { @@ -2783,7 +2799,7 @@ "tags": [ "connector" ], - "summary": "Updates the is_native flag in the connector document", + "summary": "Update the connector is_native flag", "operationId": "connector-update-native", "parameters": [ { @@ -2844,7 +2860,8 @@ "tags": [ "connector" ], - "summary": "Updates the pipeline field in the connector document", + "summary": "Update the connector pipeline", + "description": "When you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "operationId": "connector-update-pipeline", "parameters": [ { @@ -2905,7 +2922,7 @@ "tags": [ "connector" ], - "summary": "Updates the scheduling field in the connector document", + "summary": "Update the connector scheduling", "operationId": "connector-update-scheduling", "parameters": [ { @@ -2966,7 +2983,7 @@ "tags": [ "connector" ], - "summary": "Updates the service type of the connector", + "summary": "Update the connector service type", "operationId": "connector-update-service-type", "parameters": [ { @@ -3027,7 +3044,7 @@ "tags": [ "connector" ], - "summary": "Updates the status of the connector", + "summary": "Update the connector status", "operationId": "connector-update-status", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 8594ee1680..70f0fecccf 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -2890,7 +2890,7 @@ "stability": "experimental" } }, - "description": "Updates the last_seen field in the connector, and sets it to current timestamp", + "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "docId": "connector-checkin", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html", "name": "connector.check_in", @@ -2926,7 +2926,7 @@ "stability": "beta" } }, - "description": "Deletes a connector.", + "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "docId": "connector-delete", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html", "name": "connector.delete", @@ -2962,7 +2962,7 @@ "stability": "beta" } }, - "description": "Retrieves a connector.", + "description": "Get a connector.\n\nGet the details about a connector.", "docId": "connector-get", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html", "name": "connector.get", @@ -2999,7 +2999,7 @@ "visibility": "private" } }, - "description": "Updates last sync stats in the connector document", + "description": "Update the connector last sync stats.\n\nUpdate the fields related to the last sync of a connector.\nThis action is used for analytics and monitoring.", "docId": "connector-last-sync", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html", "name": "connector.last_sync", @@ -3038,7 +3038,7 @@ "stability": "beta" } }, - "description": "Returns existing connectors.", + "description": "Get all connectors.\n\nGet information about all connectors.", "docId": "connector-list", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html", "name": "connector.list", @@ -3074,7 +3074,7 @@ "stability": "beta" } }, - "description": "Creates a connector.", + "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "docId": "connector-post", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.post", @@ -3113,7 +3113,7 @@ "stability": "beta" } }, - "description": "Creates or updates a connector.", + "description": "Create or update a connector.", "docId": "connector-put", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-api.html", "name": "connector.put", @@ -3258,7 +3258,7 @@ "stability": "beta" } }, - "description": "Cancels a connector sync job.", + "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "docId": "connector-sync-job-cancel", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html", "name": "connector.sync_job_cancel", @@ -3347,7 +3347,7 @@ "stability": "beta" } }, - "description": "Deletes a connector sync job.", + "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "docId": "connector-sync-job-delete", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html", "name": "connector.sync_job_delete", @@ -3411,7 +3411,7 @@ "stability": "beta" } }, - "description": "Retrieves a connector sync job.", + "description": "Get a connector sync job.", "docId": "connector-sync-job-get", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html", "name": "connector.sync_job_get", @@ -3447,7 +3447,7 @@ "stability": "beta" } }, - "description": "Lists connector sync jobs.", + "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "docId": "connector-sync-job-list", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html", "name": "connector.sync_job_list", @@ -3483,7 +3483,7 @@ "stability": "beta" } }, - "description": "Creates a connector sync job.", + "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "docId": "connector-sync-job-post", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/create-connector-sync-job-api.html", "name": "connector.sync_job_post", @@ -3550,7 +3550,7 @@ "stability": "experimental" } }, - "description": "Activates the valid draft filtering for a connector.", + "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "docId": "connector-update-filtering", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_active_filtering", @@ -3589,7 +3589,7 @@ "stability": "beta" } }, - "description": "Updates the API key id in the connector document", + "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "docId": "connector-update-api-key-id", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-api-key-id-api.html", "name": "connector.update_api_key_id", @@ -3628,7 +3628,7 @@ "stability": "beta" } }, - "description": "Updates the configuration field in the connector document", + "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "docId": "connector-configuration", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-configuration-api.html", "name": "connector.update_configuration", @@ -3667,7 +3667,7 @@ "stability": "experimental" } }, - "description": "Updates the filtering field in the connector document", + "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "docId": "connector-update-error", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-error-api.html", "name": "connector.update_error", @@ -3734,7 +3734,7 @@ "stability": "beta" } }, - "description": "Updates the filtering field in the connector document", + "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "docId": "connector-update-filtering", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-api.html", "name": "connector.update_filtering", @@ -3773,7 +3773,7 @@ "stability": "experimental" } }, - "description": "Updates the draft filtering validation info for a connector.", + "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "docId": "connector-update-filtering-validation", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-filtering-validation-api.html", "name": "connector.update_filtering_validation", @@ -3812,7 +3812,7 @@ "stability": "beta" } }, - "description": "Updates the index_name in the connector document", + "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "docId": "connector-update-index-name", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-index-name-api.html", "name": "connector.update_index_name", @@ -3851,7 +3851,7 @@ "stability": "beta" } }, - "description": "Updates the name and description fields in the connector document", + "description": "Update the connector name and description.", "docId": "connector-update-name", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-name-description-api.html", "name": "connector.update_name", @@ -3890,7 +3890,7 @@ "stability": "beta" } }, - "description": "Updates the is_native flag in the connector document", + "description": "Update the connector is_native flag.", "docId": "connector-update-native", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-native-api.html", "name": "connector.update_native", @@ -3929,7 +3929,7 @@ "stability": "beta" } }, - "description": "Updates the pipeline field in the connector document", + "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "docId": "connector-update-pipeline", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-pipeline-api.html", "name": "connector.update_pipeline", @@ -3968,7 +3968,7 @@ "stability": "beta" } }, - "description": "Updates the scheduling field in the connector document", + "description": "Update the connector scheduling.", "docId": "connector-update-scheduling", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-scheduling-api.html", "name": "connector.update_scheduling", @@ -4007,7 +4007,7 @@ "stability": "beta" } }, - "description": "Updates the service type of the connector", + "description": "Update the connector service type.", "docId": "connector-update-service-type", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-service-type-api.html", "name": "connector.update_service_type", @@ -4046,7 +4046,7 @@ "stability": "experimental" } }, - "description": "Updates the status of the connector", + "description": "Update the connector status.", "docId": "connector-update-status", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-status-api.html", "name": "connector.update_status", @@ -112882,7 +112882,7 @@ "body": { "kind": "no_body" }, - "description": "Updates the last_seen field in the connector, and sets it to current timestamp", + "description": "Check in a connector.\n\nUpdate the `last_seen` field in the connector and set it to the current timestamp.", "inherits": { "type": { "name": "RequestBase", @@ -112908,7 +112908,7 @@ } ], "query": [], - "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L36" + "specLocation": "connector/check_in/ConnectorCheckInRequest.ts#L22-L38" }, { "kind": "response", @@ -112942,7 +112942,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a connector.", + "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually.", "inherits": { "type": { "name": "RequestBase", @@ -112981,7 +112981,7 @@ } } ], - "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L42" + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L47" }, { "kind": "response", @@ -113009,7 +113009,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a connector.", + "description": "Get a connector.\n\nGet the details about a connector.", "inherits": { "type": { "name": "RequestBase", @@ -113035,7 +113035,7 @@ } ], "query": [], - "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L36" + "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L38" }, { "kind": "response", @@ -113193,7 +113193,7 @@ } ] }, - "description": "Updates last sync stats in the connector document", + "description": "Update the connector last sync stats.\n\nUpdate the fields related to the last sync of a connector.\nThis action is used for analytics and monitoring.", "inherits": { "type": { "name": "RequestBase", @@ -113219,7 +113219,7 @@ } ], "query": [], - "specLocation": "connector/last_sync/ConnectorUpdateLastSyncRequest.ts#L26-L57" + "specLocation": "connector/last_sync/ConnectorUpdateLastSyncRequest.ts#L26-L60" }, { "kind": "response", @@ -113253,7 +113253,7 @@ "body": { "kind": "no_body" }, - "description": "Returns existing connectors.", + "description": "Get all connectors.\n\nGet information about all connectors.", "inherits": { "type": { "name": "RequestBase", @@ -113339,7 +113339,7 @@ } } ], - "specLocation": "connector/list/ConnectorListRequest.ts#L23-L57" + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L59" }, { "kind": "response", @@ -113455,7 +113455,7 @@ } ] }, - "description": "Creates a connector.", + "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "inherits": { "type": { "name": "RequestBase", @@ -113468,7 +113468,7 @@ }, "path": [], "query": [], - "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L42" + "specLocation": "connector/post/ConnectorPostRequest.ts#L22-L46" }, { "kind": "response", @@ -113581,7 +113581,7 @@ } ] }, - "description": "Creates or updates a connector.", + "description": "Create or update a connector.", "inherits": { "type": { "name": "RequestBase", @@ -113652,7 +113652,7 @@ "body": { "kind": "no_body" }, - "description": "Cancels a connector sync job.", + "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "inherits": { "type": { "name": "RequestBase", @@ -113678,7 +113678,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L36" + "specLocation": "connector/sync_job_cancel/SyncJobCancelRequest.ts#L22-L39" }, { "kind": "response", @@ -113712,7 +113712,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes a connector sync job.", + "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "inherits": { "type": { "name": "RequestBase", @@ -113738,7 +113738,7 @@ } ], "query": [], - "specLocation": "connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L36" + "specLocation": "connector/sync_job_delete/SyncJobDeleteRequest.ts#L22-L39" }, { "kind": "response", @@ -113766,7 +113766,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves a connector sync job.", + "description": "Get a connector sync job.", "inherits": { "type": { "name": "RequestBase", @@ -113820,7 +113820,7 @@ "body": { "kind": "no_body" }, - "description": "Lists connector sync jobs.", + "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "inherits": { "type": { "name": "RequestBase", @@ -113909,7 +113909,7 @@ } } ], - "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L55" + "specLocation": "connector/sync_job_list/SyncJobListRequest.ts#L25-L57" }, { "kind": "response", @@ -113993,7 +113993,7 @@ } ] }, - "description": "Creates a connector sync job.", + "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "inherits": { "type": { "name": "RequestBase", @@ -114006,7 +114006,7 @@ }, "path": [], "query": [], - "specLocation": "connector/sync_job_post/SyncJobPostRequest.ts#L23-L43" + "specLocation": "connector/sync_job_post/SyncJobPostRequest.ts#L23-L45" }, { "kind": "response", @@ -114040,7 +114040,7 @@ "body": { "kind": "no_body" }, - "description": "Activates the valid draft filtering for a connector.", + "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "inherits": { "type": { "name": "RequestBase", @@ -114066,7 +114066,7 @@ } ], "query": [], - "specLocation": "connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L36" + "specLocation": "connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts#L22-L38" }, { "kind": "response", @@ -114124,7 +114124,7 @@ } ] }, - "description": "Updates the API key id in the connector document", + "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field.", "inherits": { "type": { "name": "RequestBase", @@ -114150,7 +114150,7 @@ } ], "query": [], - "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L42" + "specLocation": "connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L47" }, { "kind": "response", @@ -114215,7 +114215,7 @@ } ] }, - "description": "Updates the configuration field in the connector document", + "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "inherits": { "type": { "name": "RequestBase", @@ -114241,7 +114241,7 @@ } ], "query": [], - "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L47" + "specLocation": "connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L49" }, { "kind": "response", @@ -114297,7 +114297,7 @@ } ] }, - "description": "Updates the filtering field in the connector document", + "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected.", "inherits": { "type": { "name": "RequestBase", @@ -114323,7 +114323,7 @@ } ], "query": [], - "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L44" + "specLocation": "connector/update_error/ConnectorUpdateErrorRequest.ts#L23-L48" }, { "kind": "response", @@ -114398,7 +114398,7 @@ } ] }, - "description": "Updates the filtering field in the connector document", + "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector.", "inherits": { "type": { "name": "RequestBase", @@ -114424,7 +114424,7 @@ } ], "query": [], - "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L50" + "specLocation": "connector/update_filtering/ConnectorUpdateFilteringRequest.ts#L27-L54" }, { "kind": "response", @@ -114471,7 +114471,7 @@ } ] }, - "description": "Updates the draft filtering validation info for a connector.", + "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "inherits": { "type": { "name": "RequestBase", @@ -114497,7 +114497,7 @@ } ], "query": [], - "specLocation": "connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L40" + "specLocation": "connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts#L23-L42" }, { "kind": "response", @@ -114553,7 +114553,7 @@ } ] }, - "description": "Updates the index_name in the connector document", + "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.", "inherits": { "type": { "name": "RequestBase", @@ -114579,7 +114579,7 @@ } ], "query": [], - "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L43" + "specLocation": "connector/update_index_name/ConnectorUpdateIndexNameRequest.ts#L23-L45" }, { "kind": "response", @@ -114637,7 +114637,7 @@ } ] }, - "description": "Updates the name and description fields in the connector document", + "description": "Update the connector name and description.", "inherits": { "type": { "name": "RequestBase", @@ -114710,7 +114710,7 @@ } ] }, - "description": "Updates the is_native flag in the connector document", + "description": "Update the connector is_native flag.", "inherits": { "type": { "name": "RequestBase", @@ -114783,7 +114783,7 @@ } ] }, - "description": "Updates the pipeline field in the connector document", + "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "inherits": { "type": { "name": "RequestBase", @@ -114809,7 +114809,7 @@ } ], "query": [], - "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L44" + "specLocation": "connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L46" }, { "kind": "response", @@ -114856,7 +114856,7 @@ } ] }, - "description": "Updates the scheduling field in the connector document", + "description": "Update the connector scheduling.", "inherits": { "type": { "name": "RequestBase", @@ -114929,7 +114929,7 @@ } ] }, - "description": "Updates the service type of the connector", + "description": "Update the connector service type.", "inherits": { "type": { "name": "RequestBase", @@ -115002,7 +115002,7 @@ } ] }, - "description": "Updates the status of the connector", + "description": "Update the connector status.", "inherits": { "type": { "name": "RequestBase", diff --git a/specification/connector/check_in/ConnectorCheckInRequest.ts b/specification/connector/check_in/ConnectorCheckInRequest.ts index 4c29b9c956..8a7e0628b8 100644 --- a/specification/connector/check_in/ConnectorCheckInRequest.ts +++ b/specification/connector/check_in/ConnectorCheckInRequest.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Updates the last_seen field in the connector, and sets it to current timestamp + * Check in a connector. + * + * Update the `last_seen` field in the connector and set it to the current timestamp. * @rest_spec_name connector.check_in * @availability stack since=8.12.0 stability=experimental * @availability serverless stability=experimental visibility=public diff --git a/specification/connector/delete/ConnectorDeleteRequest.ts b/specification/connector/delete/ConnectorDeleteRequest.ts index b3a9e6965e..d64153139b 100644 --- a/specification/connector/delete/ConnectorDeleteRequest.ts +++ b/specification/connector/delete/ConnectorDeleteRequest.ts @@ -20,7 +20,12 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a connector. + * Delete a connector. + * + * Removes a connector and associated sync jobs. + * This is a destructive action that is not recoverable. + * NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. + * These need to be removed manually. * @rest_spec_name connector.delete * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/get/ConnectorGetRequest.ts b/specification/connector/get/ConnectorGetRequest.ts index 23a3caf040..e357985489 100644 --- a/specification/connector/get/ConnectorGetRequest.ts +++ b/specification/connector/get/ConnectorGetRequest.ts @@ -20,7 +20,9 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Retrieves a connector. + * Get a connector. + * + * Get the details about a connector. * @rest_spec_name connector.get * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts b/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts index d243b5770e..701a621539 100644 --- a/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts +++ b/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts @@ -24,7 +24,10 @@ import { DateTime } from '@_types/Time' import { SyncStatus } from '../_types/Connector' /** - * Updates last sync stats in the connector document + * Update the connector last sync stats. + * + * Update the fields related to the last sync of a connector. + * This action is used for analytics and monitoring. * @rest_spec_name connector.last_sync * @availability stack since=8.12.0 stability=experimental visibility=private * @availability serverless stability=experimental visibility=private diff --git a/specification/connector/list/ConnectorListRequest.ts b/specification/connector/list/ConnectorListRequest.ts index ea44fe6e11..ca818c84b8 100644 --- a/specification/connector/list/ConnectorListRequest.ts +++ b/specification/connector/list/ConnectorListRequest.ts @@ -21,7 +21,9 @@ import { Indices, Names } from '@_types/common' import { integer } from '@_types/Numeric' /** - * Returns existing connectors. + * Get all connectors. + * + * Get information about all connectors. * @rest_spec_name connector.list * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/post/ConnectorPostRequest.ts b/specification/connector/post/ConnectorPostRequest.ts index c9d2d0816d..5062c10df5 100644 --- a/specification/connector/post/ConnectorPostRequest.ts +++ b/specification/connector/post/ConnectorPostRequest.ts @@ -20,7 +20,11 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' /** - * Creates a connector. + * Create a connector. + * + * Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. + * Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. + * Self-managed connectors (Connector clients) are self-managed on your infrastructure. * @rest_spec_name connector.post * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/put/ConnectorPutRequest.ts b/specification/connector/put/ConnectorPutRequest.ts index 10ce3fb8e9..579f47b31f 100644 --- a/specification/connector/put/ConnectorPutRequest.ts +++ b/specification/connector/put/ConnectorPutRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id, IndexName } from '@_types/common' /** - * Creates or updates a connector. + * Create or update a connector. * @rest_spec_name connector.put * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_cancel/SyncJobCancelRequest.ts b/specification/connector/sync_job_cancel/SyncJobCancelRequest.ts index 27a89047a6..ec5841760f 100644 --- a/specification/connector/sync_job_cancel/SyncJobCancelRequest.ts +++ b/specification/connector/sync_job_cancel/SyncJobCancelRequest.ts @@ -20,7 +20,10 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Cancels a connector sync job. + * Cancel a connector sync job. + * + * Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. + * The connector service is then responsible for setting the status of connector sync jobs to cancelled. * @rest_spec_name connector.sync_job_cancel * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_delete/SyncJobDeleteRequest.ts b/specification/connector/sync_job_delete/SyncJobDeleteRequest.ts index 19aad70b22..49b0edd1a2 100644 --- a/specification/connector/sync_job_delete/SyncJobDeleteRequest.ts +++ b/specification/connector/sync_job_delete/SyncJobDeleteRequest.ts @@ -20,7 +20,10 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes a connector sync job. + * Delete a connector sync job. + * + * Remove a connector sync job and its associated data. + * This is a destructive action that is not recoverable. * @rest_spec_name connector.sync_job_delete * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_get/SyncJobGetRequest.ts b/specification/connector/sync_job_get/SyncJobGetRequest.ts index cf2753871b..2310a95b57 100644 --- a/specification/connector/sync_job_get/SyncJobGetRequest.ts +++ b/specification/connector/sync_job_get/SyncJobGetRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Retrieves a connector sync job. + * Get a connector sync job. * @rest_spec_name connector.sync_job_get * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_list/SyncJobListRequest.ts b/specification/connector/sync_job_list/SyncJobListRequest.ts index ab2637233e..1693640a2d 100644 --- a/specification/connector/sync_job_list/SyncJobListRequest.ts +++ b/specification/connector/sync_job_list/SyncJobListRequest.ts @@ -23,7 +23,9 @@ import { SyncStatus } from '../_types/Connector' import { SyncJobType } from '../_types/SyncJob' /** - * Lists connector sync jobs. + * Get all connector sync jobs. + * + * Get information about all stored connector sync jobs listed by their creation date in ascending order. * @rest_spec_name connector.sync_job_list * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/sync_job_post/SyncJobPostRequest.ts b/specification/connector/sync_job_post/SyncJobPostRequest.ts index be386dbbb0..27b9bfca50 100644 --- a/specification/connector/sync_job_post/SyncJobPostRequest.ts +++ b/specification/connector/sync_job_post/SyncJobPostRequest.ts @@ -21,7 +21,9 @@ import { Id } from '@_types/common' import { SyncJobTriggerMethod, SyncJobType } from '../_types/SyncJob' /** - * Creates a connector sync job. + * Create a connector sync job. + * + * Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. * @rest_spec_name connector.sync_job_post * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts b/specification/connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts index a92fb2b7bc..d82acff0bb 100644 --- a/specification/connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts +++ b/specification/connector/update_active_filtering/ConnectorUpdateActiveFilteringRequest.ts @@ -20,6 +20,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** + * Activate the connector draft filter. + * * Activates the valid draft filtering for a connector. * @rest_spec_name connector.update_active_filtering * @availability stack since=8.12.0 stability=experimental diff --git a/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts b/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts index e7305bbc2d..6ef8fc506b 100644 --- a/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts +++ b/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts @@ -19,7 +19,12 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Updates the API key id in the connector document + * Update the connector API key ID. + * + * Update the `api_key_id` and `api_key_secret_id` fields of a connector. + * You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. + * The connector secret ID is required only for Elastic managed (native) connectors. + * Self-managed connectors (connector clients) do not use this field. * @rest_spec_name connector.update_api_key_id * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts b/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts index 06a2febc8f..531c8812d4 100644 --- a/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts +++ b/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts @@ -23,7 +23,9 @@ import { Id } from '@_types/common' import { ConnectorConfiguration } from '../_types/Connector' /** - * Updates the configuration field in the connector document + * Update the connector configuration. + * + * Update the configuration field in the connector document. * @rest_spec_name connector.update_configuration * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_error/ConnectorUpdateErrorRequest.ts b/specification/connector/update_error/ConnectorUpdateErrorRequest.ts index a7b81e52ea..99d268d026 100644 --- a/specification/connector/update_error/ConnectorUpdateErrorRequest.ts +++ b/specification/connector/update_error/ConnectorUpdateErrorRequest.ts @@ -21,7 +21,11 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Updates the filtering field in the connector document + * Update the connector error field. + * + * Set the error field for the connector. + * If the error provided in the request body is non-null, the connector’s status is updated to error. + * Otherwise, if the error is reset to null, the connector status is updated to connected. * @rest_spec_name connector.update_error * @availability stack since=8.12.0 stability=experimental * @availability serverless stability=experimental visibility=public diff --git a/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts b/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts index 198bb87320..db09904c15 100644 --- a/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts +++ b/specification/connector/update_filtering/ConnectorUpdateFilteringRequest.ts @@ -25,7 +25,11 @@ import { } from '../_types/Connector' /** - * Updates the filtering field in the connector document + * Update the connector filtering. + * + * Update the draft filtering configuration of a connector and marks the draft validation state as edited. + * The filtering draft is activated once validated by the running Elastic connector service. + * The filtering property is used to configure sync rules (both basic and advanced) for a connector. * @rest_spec_name connector.update_filtering * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts b/specification/connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts index bbdb80f4ac..4fe343e682 100644 --- a/specification/connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts +++ b/specification/connector/update_filtering_validation/ConnectorUpdateFilteringValidationRequest.ts @@ -21,7 +21,9 @@ import { Id } from '@_types/common' import { FilteringRulesValidation } from 'connector/_types/Connector' /** - * Updates the draft filtering validation info for a connector. + * Update the connector draft filtering validation. + * + * Update the draft filtering validation info for a connector. * @rest_spec_name connector.update_filtering_validation * @availability stack since=8.12.0 stability=experimental * @availability serverless stability=experimental visibility=public diff --git a/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts b/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts index 74dc1ca0bf..8e7b48593a 100644 --- a/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts +++ b/specification/connector/update_index_name/ConnectorUpdateIndexNameRequest.ts @@ -21,7 +21,9 @@ import { RequestBase } from '@_types/Base' import { Id, IndexName } from '@_types/common' /** - * Updates the index_name in the connector document + * Update the connector index name. + * + * Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. * @rest_spec_name connector.update_index_name * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_name/ConnectorUpdateNameRequest.ts b/specification/connector/update_name/ConnectorUpdateNameRequest.ts index a50fbd06ea..b381fc4d3c 100644 --- a/specification/connector/update_name/ConnectorUpdateNameRequest.ts +++ b/specification/connector/update_name/ConnectorUpdateNameRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Updates the name and description fields in the connector document + * Update the connector name and description. * @rest_spec_name connector.update_name * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_native/ConnectorUpdateNativeRequest.ts b/specification/connector/update_native/ConnectorUpdateNativeRequest.ts index 0c180055ca..0f9bbfb54c 100644 --- a/specification/connector/update_native/ConnectorUpdateNativeRequest.ts +++ b/specification/connector/update_native/ConnectorUpdateNativeRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Updates the is_native flag in the connector document + * Update the connector is_native flag. * @rest_spec_name connector.update_native * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts b/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts index bcd7f80638..cdeb6e8c1c 100644 --- a/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts +++ b/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts @@ -21,7 +21,9 @@ import { Id } from '@_types/common' import { IngestPipelineParams } from '../_types/Connector' /** - * Updates the pipeline field in the connector document + * Update the connector pipeline. + * + * When you create a new connector, the configuration of an ingest pipeline is populated with default settings. * @rest_spec_name connector.update_pipeline * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts b/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts index dfc368c874..2eba24d783 100644 --- a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts +++ b/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequest.ts @@ -21,7 +21,7 @@ import { Id } from '@_types/common' import { SchedulingConfiguration } from '../_types/Connector' /** - * Updates the scheduling field in the connector document + * Update the connector scheduling. * @rest_spec_name connector.update_scheduling * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts b/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts index 565c3821af..e8b29ea071 100644 --- a/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts +++ b/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequest.ts @@ -20,7 +20,7 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Updates the service type of the connector + * Update the connector service type. * @rest_spec_name connector.update_service_type * @availability stack since=8.12.0 stability=beta * @availability serverless stability=beta visibility=public diff --git a/specification/connector/update_status/ConnectorUpdateStatusRequest.ts b/specification/connector/update_status/ConnectorUpdateStatusRequest.ts index e1242c0e47..9d4cc8dd7b 100644 --- a/specification/connector/update_status/ConnectorUpdateStatusRequest.ts +++ b/specification/connector/update_status/ConnectorUpdateStatusRequest.ts @@ -21,7 +21,7 @@ import { Id } from '@_types/common' import { ConnectorStatus } from '../_types/Connector' /** - * Updates the status of the connector + * Update the connector status. * @rest_spec_name connector.update_status * @availability stack since=8.12.0 stability=experimental * @availability serverless stability=experimental visibility=public