Adding new URL params to Connector API endpoints + new type to Connector types (#3549)

* Adding new URL params to Connector API endpoints + new type to Connector types

* Fixed formatting issue

* Added @server_default flags, changed hard flag to required, and some typo fixes

Author: mattnowzari

output/schema/schema.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."
       }
     }
   }

output/typescript/types.ts

@@ -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"
+      }
     }
   }
 }

specification/_json_spec/connector.delete.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"
       }
     }
   }

specification/_json_spec/connector.get.json

@@ -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

specification/_json_spec/connector.list.json

@@ -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
   }
 }

specification/connector/_types/Connector.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
+  }
 }

specification/connector/delete/ConnectorDeleteRequest.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
      */