diff --git a/api/api.yaml b/api/api.yaml index aaf0400..56986fa 100644 --- a/api/api.yaml +++ b/api/api.yaml @@ -183,7 +183,7 @@ paths: $ref: "../problem/problem.yaml#/components/schemas/ApiProblem" post: summary: Create a new project - description: Creates a new project within an organization. A project is a container for provider apps, integrations, and connections. + description: Creates a new project within an organization. A project is a container for provider apps, integrations, and connections. operationId: createProject tags: ["Project"] security: # Only bearer auth works for this endpoint @@ -1587,7 +1587,7 @@ paths: - name: groupRef in: query required: true - description: The ID of the user group that has access to this installation. + description: The ID of the user group that has access to this installation. example: group-123 schema: type: string @@ -2146,7 +2146,7 @@ paths: $ref: "../problem/problem.yaml#/components/schemas/ApiProblem" /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/objects/{objectName}/backfill-progress: get: - summary: Get backfill progress + summary: Get backfill progress operationId: getBackfillProgress tags: ["Operation"] description: Retrieve backfill progress (records processed, estimated total) for an object. Use to track progress of an initial data sync. @@ -2216,7 +2216,7 @@ paths: get: summary: Get an operation description: | - Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details. + Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details. operationId: getOperation tags: ["Operation"] parameters: @@ -5205,7 +5205,7 @@ components: revisionId: type: string description: > - The ID of the revision that was current when this config was created or last updated. + The ID of the revision that was current when this config was created or last updated. example: revision-123 createTime: type: string @@ -5432,13 +5432,17 @@ components: description: The API key to use for the connection. customAuth: type: object - description: Values used for custom auth input variables. - additionalProperties: - type: string - nullable: false + description: + Values used for custom auth input variables. Most values are strings + (API keys, tokens, etc.), but structured values like arrays are also + accepted — for example, googleWorkspaceDelegation sends a `scopes` + array alongside the service account key. + additionalProperties: true example: - apiKey: "abcd1234" - password: "secret" + serviceAccountKey: "base64encodedkey" + scopes: + - "https://www.googleapis.com/auth/calendar" + - "https://mail.google.com/" basicAuth: type: object required: @@ -5600,13 +5604,13 @@ components: description: Unique identifier for this operation. Use this to fetch operation details or list logs for debugging. installationId: type: string - description: The Ampersand installation ID (customer instance) that this operation ran for. + description: The Ampersand installation ID (customer instance) that this operation ran for. status: type: string description: | The status of the operation. - `success`: The operation completed successfully - - `failure`: The operation failed + - `failure`: The operation failed - `in_progress`: The operation is currently running example: success result: diff --git a/api/generated/api.json b/api/generated/api.json index e569d8d..12dc5b5 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -12626,7 +12626,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -16924,7 +16924,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -19814,7 +19814,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -23260,7 +23260,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -25992,7 +25992,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -29245,7 +29245,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -33626,7 +33626,7 @@ }, "status": { "type": "string", - "description": "The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed \n- `in_progress`: The operation is currently running\n", + "description": "The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed\n- `in_progress`: The operation is currently running\n", "example": "success" }, "result": { @@ -35233,7 +35233,7 @@ "/projects/{projectIdOrName}/operations/{operationId}": { "get": { "summary": "Get an operation", - "description": "Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details. \n", + "description": "Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details.\n", "operationId": "getOperation", "tags": [ "Operation" @@ -35307,7 +35307,7 @@ }, "status": { "type": "string", - "description": "The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed \n- `in_progress`: The operation is currently running\n", + "description": "The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed\n- `in_progress`: The operation is currently running\n", "example": "success" }, "result": { @@ -43473,14 +43473,14 @@ }, "customAuth": { "type": "object", - "description": "Values used for custom auth input variables.", - "additionalProperties": { - "type": "string", - "nullable": false - }, + "description": "Values used for custom auth input variables. Most values are strings (API keys, tokens, etc.), but structured values like arrays are also accepted — for example, googleWorkspaceDelegation sends a `scopes` array alongside the service account key.", + "additionalProperties": true, "example": { - "apiKey": "abcd1234", - "password": "secret" + "serviceAccountKey": "base64encodedkey", + "scopes": [ + "https://www.googleapis.com/auth/calendar", + "https://mail.google.com/" + ] } }, "basicAuth": { @@ -45764,14 +45764,14 @@ }, "customAuth": { "type": "object", - "description": "Values used for custom auth input variables.", - "additionalProperties": { - "type": "string", - "nullable": false - }, + "description": "Values used for custom auth input variables. Most values are strings (API keys, tokens, etc.), but structured values like arrays are also accepted — for example, googleWorkspaceDelegation sends a `scopes` array alongside the service account key.", + "additionalProperties": true, "example": { - "apiKey": "abcd1234", - "password": "secret" + "serviceAccountKey": "base64encodedkey", + "scopes": [ + "https://www.googleapis.com/auth/calendar", + "https://mail.google.com/" + ] } }, "basicAuth": { @@ -68265,7 +68265,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -69905,7 +69905,7 @@ }, "revisionId": { "type": "string", - "description": "The ID of the revision that was current when this config was created or last updated. \n", + "description": "The ID of the revision that was current when this config was created or last updated.\n", "example": "revision-123" }, "createTime": { @@ -72046,14 +72046,14 @@ }, "customAuth": { "type": "object", - "description": "Values used for custom auth input variables.", - "additionalProperties": { - "type": "string", - "nullable": false - }, + "description": "Values used for custom auth input variables. Most values are strings (API keys, tokens, etc.), but structured values like arrays are also accepted — for example, googleWorkspaceDelegation sends a `scopes` array alongside the service account key.", + "additionalProperties": true, "example": { - "apiKey": "abcd1234", - "password": "secret" + "serviceAccountKey": "base64encodedkey", + "scopes": [ + "https://www.googleapis.com/auth/calendar", + "https://mail.google.com/" + ] } }, "basicAuth": { @@ -72257,14 +72257,14 @@ }, "customAuth": { "type": "object", - "description": "Values used for custom auth input variables.", - "additionalProperties": { - "type": "string", - "nullable": false - }, + "description": "Values used for custom auth input variables. Most values are strings (API keys, tokens, etc.), but structured values like arrays are also accepted — for example, googleWorkspaceDelegation sends a `scopes` array alongside the service account key.", + "additionalProperties": true, "example": { - "apiKey": "abcd1234", - "password": "secret" + "serviceAccountKey": "base64encodedkey", + "scopes": [ + "https://www.googleapis.com/auth/calendar", + "https://mail.google.com/" + ] } }, "basicAuth": { @@ -72469,14 +72469,14 @@ }, "customAuth": { "type": "object", - "description": "Values used for custom auth input variables.", - "additionalProperties": { - "type": "string", - "nullable": false - }, + "description": "Values used for custom auth input variables. Most values are strings (API keys, tokens, etc.), but structured values like arrays are also accepted — for example, googleWorkspaceDelegation sends a `scopes` array alongside the service account key.", + "additionalProperties": true, "example": { - "apiKey": "abcd1234", - "password": "secret" + "serviceAccountKey": "base64encodedkey", + "scopes": [ + "https://www.googleapis.com/auth/calendar", + "https://mail.google.com/" + ] } }, "basicAuth": { @@ -72739,7 +72739,7 @@ }, "status": { "type": "string", - "description": "The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed \n- `in_progress`: The operation is currently running\n", + "description": "The status of the operation.\n- `success`: The operation completed successfully\n- `failure`: The operation failed\n- `in_progress`: The operation is currently running\n", "example": "success" }, "result": {