diff --git a/output/schema/schema.json b/output/schema/schema.json index 62f1eea61c..6bbac968fe 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -114379,6 +114379,17 @@ } } }, + { + "name": "deleted", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "name": "description", "required": false, @@ -114689,7 +114700,7 @@ } } ], - "specLocation": "connector/_types/Connector.ts#L252-L283" + "specLocation": "connector/_types/Connector.ts#L252-L284" }, { "kind": "interface", @@ -116502,9 +116513,22 @@ "namespace": "_builtins" } } + }, + { + "description": "A flag indicating if the connector should be hard deleted.", + "name": "hard", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } } ], - "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L53" + "specLocation": "connector/delete/ConnectorDeleteRequest.ts#L22-L58" }, { "kind": "response", @@ -116557,8 +116581,22 @@ } } ], - "query": [], - "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L44" + "query": [ + { + "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", + "name": "include_deleted", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "connector/get/ConnectorGetRequest.ts#L22-L51" }, { "kind": "response", @@ -116849,6 +116887,19 @@ } } }, + { + "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", + "name": "include_deleted", + "required": false, + "serverDefault": false, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "description": "A wildcard query string that filters connectors with matching name, description or index name", "name": "query", @@ -116862,7 +116913,7 @@ } } ], - "specLocation": "connector/list/ConnectorListRequest.ts#L23-L65" + "specLocation": "connector/list/ConnectorListRequest.ts#L23-L70" }, { "kind": "response", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index fbb7f81362..6970d5ed55 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -9721,6 +9721,7 @@ export interface ConnectorConnector { api_key_secret_id?: string configuration: ConnectorConnectorConfiguration custom_scheduling: ConnectorConnectorCustomScheduling + deleted: boolean description?: string error?: string | null features?: ConnectorConnectorFeatures @@ -9958,12 +9959,14 @@ export interface ConnectorCheckInResponse { export interface ConnectorDeleteRequest extends RequestBase { connector_id: Id delete_sync_jobs?: boolean + hard?: boolean } export type ConnectorDeleteResponse = AcknowledgedResponseBase export interface ConnectorGetRequest extends RequestBase { connector_id: Id + include_deleted?: boolean } export type ConnectorGetResponse = ConnectorConnector @@ -9996,6 +9999,7 @@ export interface ConnectorListRequest extends RequestBase { index_name?: Indices connector_name?: Names service_type?: Names + include_deleted?: boolean query?: string } diff --git a/specification/_json_spec/connector.delete.json b/specification/_json_spec/connector.delete.json index 4b542d15da..4fdbd5f511 100644 --- a/specification/_json_spec/connector.delete.json +++ b/specification/_json_spec/connector.delete.json @@ -28,6 +28,11 @@ "type": "boolean", "default": false, "description": "Determines whether associated sync jobs are also deleted." + }, + "hard": { + "type": "boolean", + "default": false, + "description": "A flag indicating if this should be a hard delete. Defaults to false." } } } diff --git a/specification/_json_spec/connector.get.json b/specification/_json_spec/connector.get.json index 372267f8d6..3678290745 100644 --- a/specification/_json_spec/connector.get.json +++ b/specification/_json_spec/connector.get.json @@ -22,6 +22,13 @@ } } ] + }, + "params": { + "include_deleted": { + "type": "boolean", + "default": false, + "description": "A flag to indicate if the desired connector should be fetched even if it was soft-deleted" + } } } } diff --git a/specification/_json_spec/connector.list.json b/specification/_json_spec/connector.list.json index 26670cb8e7..d8ebeb57a4 100644 --- a/specification/_json_spec/connector.list.json +++ b/specification/_json_spec/connector.list.json @@ -43,6 +43,11 @@ "query": { "type": "string", "description": "A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names" + }, + "include_deleted": { + "type": "boolean", + "default": false, + "description": "A flag that indicates whether a soft-deleted connectors will be fetched" } } } diff --git a/specification/connector/_types/Connector.ts b/specification/connector/_types/Connector.ts index 88df329997..570c8a213f 100644 --- a/specification/connector/_types/Connector.ts +++ b/specification/connector/_types/Connector.ts @@ -254,6 +254,7 @@ export interface Connector { api_key_secret_id?: string configuration: ConnectorConfiguration custom_scheduling: ConnectorCustomScheduling + deleted: boolean description?: string error?: string | null features?: ConnectorFeatures diff --git a/specification/connector/delete/ConnectorDeleteRequest.ts b/specification/connector/delete/ConnectorDeleteRequest.ts index dde7258838..3943378a02 100644 --- a/specification/connector/delete/ConnectorDeleteRequest.ts +++ b/specification/connector/delete/ConnectorDeleteRequest.ts @@ -49,5 +49,10 @@ export interface Request extends RequestBase { * A flag indicating if associated sync jobs should be also removed. Defaults to false. */ delete_sync_jobs?: boolean + /** + * A flag indicating if the connector should be hard deleted. + * @server_default false + */ + hard?: boolean } } diff --git a/specification/connector/get/ConnectorGetRequest.ts b/specification/connector/get/ConnectorGetRequest.ts index 1a529a6d4a..31d1f31ec4 100644 --- a/specification/connector/get/ConnectorGetRequest.ts +++ b/specification/connector/get/ConnectorGetRequest.ts @@ -41,4 +41,11 @@ export interface Request extends RequestBase { */ connector_id: Id } + query_parameters: { + /** + * A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. + * @server_default false + */ + include_deleted?: boolean + } } diff --git a/specification/connector/list/ConnectorListRequest.ts b/specification/connector/list/ConnectorListRequest.ts index 0e2b300d4f..572f2ea338 100644 --- a/specification/connector/list/ConnectorListRequest.ts +++ b/specification/connector/list/ConnectorListRequest.ts @@ -57,6 +57,11 @@ export interface Request extends RequestBase { * A comma-separated list of connector service types to fetch connector documents for */ service_type?: Names + /** + * A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. + * @server_default false + */ + include_deleted?: boolean /** * A wildcard query string that filters connectors with matching name, description or index name */