Skip to content

[ENG-3808] chore: update customAuth type #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RajatPawar merged 1 commit into from
Apr 21, 2026
Merged

[ENG-3808] chore: update customAuth type #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 17 additions & 13 deletions api/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
94 changes: 47 additions & 47 deletions api/generated/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
Loading