[Connector APIs] Update existing endpoints for 8.15 (#2675)

elastic · Jul 26, 2024 · 8ef6ecc · 8ef6ecc
1 parent 6ca2397
commit 8ef6ecc
Show file tree

Hide file tree

Showing 17 changed files with 582 additions and 880 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/connector/_types/Connector.ts b/specification/connector/_types/Connector.ts
@@ -24,7 +24,7 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 
 interface SelectOption {
   label: string
-  value: string
+  value: ScalarValue
 }
 
 interface Dependency {
@@ -67,12 +67,12 @@ export interface GreaterThanValidation {
 
 export interface ListTypeValidation {
   type: 'list_type'
-  constraint: ScalarValue[]
+  constraint: string
 }
 
 export interface IncludedInValidation {
   type: 'included_in'
-  constraint: string
+  constraint: ScalarValue[]
 }
 
 export interface RegexValidation {
@@ -91,11 +91,11 @@ export interface ConnectorConfigProperties {
   placeholder?: string
   required: boolean
   sensitive: boolean
-  tooltip?: string
+  tooltip?: string | null
   type: ConnectorFieldType
   ui_restrictions: string[]
   validations: Validation[]
-  value: ScalarValue
+  value: UserDefinedValue
 }
 
 export type ConnectorConfiguration = Dictionary<
@@ -208,7 +208,7 @@ export interface FilteringRules {
 
 export interface FilteringConfig {
   active: FilteringRules
-  domain: string
+  domain?: string
   draft: FilteringRules
 }
 
@@ -223,9 +223,8 @@ interface SyncRulesFeature {
 
 export interface ConnectorFeatures {
   document_level_security?: FeatureEnabled
-  filtering_advanced_config?: boolean
-  filtering_rules?: boolean
   incremental_sync?: FeatureEnabled
+  native_connector_api_keys?: FeatureEnabled
   sync_rules?: SyncRulesFeature
 }
 
@@ -237,14 +236,15 @@ export interface SchedulingConfiguration {
 
 export interface Connector {
   api_key_id?: string
+  api_key_secret_id?: string
   configuration: ConnectorConfiguration
   custom_scheduling: ConnectorCustomScheduling
   description?: string
-  error?: string
+  error?: string | null
   features?: ConnectorFeatures
   filtering: FilteringConfig[]
   id?: Id
-  index_name?: IndexName
+  index_name?: IndexName | null
   is_native: boolean
   language?: string
   last_access_control_sync_error?: string
@@ -261,7 +261,8 @@ export interface Connector {
   name?: string
   pipeline?: IngestPipelineParams
   scheduling: SchedulingConfiguration
-  service_type: string
+  service_type?: string
   status: ConnectorStatus
+  sync_cursor?: UserDefinedValue
   sync_now: boolean
 }
diff --git a/specification/connector/_types/SyncJob.ts b/specification/connector/_types/SyncJob.ts
@@ -36,6 +36,7 @@ interface SyncJobConnectorReference {
   language?: string
   pipeline?: IngestPipelineParams
   service_type: string
+  sync_cursor?: UserDefinedValue
 }
 
 export enum SyncJobType {

diff --git a/specification/connector/delete/ConnectorDeleteRequest.ts b/specification/connector/delete/ConnectorDeleteRequest.ts
@@ -34,6 +34,9 @@ export interface Request extends RequestBase {
     connector_id: Id
   }
   query_parameters: {
-    delete_sync_jobs: boolean
+    /**
+     * A flag indicating if associated sync jobs should be also removed. Defaults to false.
+     */
+    delete_sync_jobs?: boolean
   }
 }
diff --git a/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts b/specification/connector/last_sync/ConnectorUpdateLastSyncRequest.ts
@@ -18,16 +18,16 @@
  */
 import { RequestBase } from '@_types/Base'
 import { Id } from '@_types/common'
-import { SyncStatus } from '../_types/Connector'
 import { long } from '@_types/Numeric'
-import { WithNullValue } from '@spec_utils/utils'
 import { DateTime } from '@_types/Time'
+import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+import { SyncStatus } from '../_types/Connector'
 
 /**
  * Updates last sync stats in the connector document
  * @rest_spec_name connector.last_sync
  * @availability stack since=8.12.0 stability=experimental
- * @availability serverless stability=experimental visibility=public
+ * @availability serverless stability=experimental visibility=private
  * @doc_id connector-last-sync
  */
 export interface Request extends RequestBase {
@@ -41,16 +41,17 @@ export interface Request extends RequestBase {
    * Connector last sync stats
    */
   body: {
-    last_access_control_sync_error?: WithNullValue<string>
+    last_access_control_sync_error?: string
     last_access_control_sync_scheduled_at?: DateTime
     last_access_control_sync_status?: SyncStatus
     last_deleted_document_count?: long
     last_incremental_sync_scheduled_at?: DateTime
     last_indexed_document_count?: long
-    last_seen?: WithNullValue<DateTime>
-    last_sync_error?: WithNullValue<string>
+    last_seen?: DateTime
+    last_sync_error?: string
     last_sync_scheduled_at?: DateTime
     last_sync_status?: SyncStatus
     last_synced?: DateTime
+    sync_cursor?: UserDefinedValue
   }
 }
diff --git a/specification/connector/post/ConnectorPostRequest.ts b/specification/connector/post/ConnectorPostRequest.ts
@@ -18,7 +18,6 @@
  */
 import { RequestBase } from '@_types/Base'
 import { IndexName } from '@_types/common'
-import { WithNullValue } from '@spec_utils/utils'
 
 /**
  * Creates a connector.
@@ -32,9 +31,9 @@ export interface Request extends RequestBase {
    * The connector document to be created
    */
   /** @codegen_name connector */
-  body: {
+  body?: {
     description?: string
-    index_name: WithNullValue<IndexName>
+    index_name?: IndexName
     is_native?: boolean
     language?: string
     name?: string