diff --git a/api/api.yaml b/api/api.yaml index 0bf06e3..5fdce75 100644 --- a/api/api.yaml +++ b/api/api.yaml @@ -2793,7 +2793,7 @@ paths: $ref: "../problem/problem.yaml#/components/schemas/ApiProblem" patch: summary: Update a connection. - description: Update an existing connection. + description: Rotate credentials or update metadata (such as the provider workspace reference) for an existing connection. operationId: updateConnection tags: ["Connection"] parameters: @@ -2802,19 +2802,42 @@ paths: required: true schema: type: string - description: Project ID or Name. + description: The Ampersand project ID or project name. + example: my-project - name: connectionId in: path required: true schema: type: string - description: Connection ID. + description: The ID of the connection to update. You can find this via the [list connections endpoint](https://docs.withampersand.com/reference/connection/list-connections). + example: connection-123 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConnectionRequest' + examples: + rotateApiKey: + summary: Rotate an API key + value: + updateMask: ["apiKey"] + connection: + apiKey: "new-api-key-value" + updateBasicAuth: + summary: Update basic auth credentials + value: + updateMask: ["basicAuth"] + connection: + basicAuth: + username: "new-username" + password: "new-password" + updateWorkspaceRef: + summary: Update provider workspace reference + value: + updateMask: ["providerWorkspaceRef"] + connection: + providerWorkspaceRef: "new-workspace-id" responses: '200': description: Connection updated successfully. @@ -2822,14 +2845,39 @@ paths: application/json: schema: $ref: '#/components/schemas/Connection' + example: + id: "c3a1f9d2-7b4e-4f8a-9e6d-2c5b8a3f1e7d" + projectId: "a1b2c3d4-e5f6-4789-a012-3456789abcde" + provider: "salesforce" + group: + groupRef: "8f2e4a6b-1c3d-4e5f-9a7b-0d8e6f2c4a1b" + groupName: "my-group" + consumer: + consumerRef: "d4e5f6a7-b8c9-4d0e-a1f2-3b4c5d6e7f8a" + consumerName: "my-consumer" + providerWorkspaceRef: "my-org.my.salesforce.com" + authScheme: "apiKey" + status: "working" + createTime: "2023-07-13T21:34:44.816354Z" + updateTime: "2024-01-15T10:22:33.000000Z" 400: - description: Bad request. + description: Invalid update mask or request body. The response includes the list of allowed mask values. content: application/problem+json: schema: $ref: "../problem/problem.yaml#/components/schemas/InputValidationProblem" + example: + type: "about:blank" + title: "Bad Request" + status: 400 + detail: "Invalid update mask" + subsystem: "api" + time: "2024-04-22T18:55:28.456076Z" + requestId: "89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715" + remedy: "Allowed masks: 'providerWorkspaceRef, providerMetadata, apiKey, basicAuth, oauth2ClientCredentials, oauth2PasswordCredentials'" + retryable: false default: - description: Error + description: Error (e.g. connection not found, auth scheme mismatch, or server error). content: application/problem+json: schema: @@ -5298,6 +5346,7 @@ components: description: The scopes for the tokens. UpdateConnectionRequest: title: Update Connection Request + description: Specify which fields to update in `updateMask` and provide corresponding values in `connection`. Fields in `connection` not listed in `updateMask` are ignored. type: object required: - updateMask @@ -5307,15 +5356,15 @@ components: type: array items: type: string - description: | - Array of field paths specifying which fields to update. Allowed values include: - - providerWorkspaceRef - - providerMetadata - - apiKey - - basicAuth - - oauth2ClientCredentials - - oauth2PasswordCredentials - example: ["providerWorkspaceRef", "providerMetadata"] + enum: + - providerWorkspaceRef + - providerMetadata + - apiKey + - basicAuth + - oauth2ClientCredentials + - oauth2PasswordCredentials + description: Fields to update. Each entry must have a corresponding value in `connection`. Credential fields (`apiKey`, `basicAuth`, `oauth2ClientCredentials`, `oauth2PasswordCredentials`) must match the connection's existing auth scheme. + example: ["apiKey"] connection: $ref: "#/components/schemas/ConnectionRequest" ConnectionRequest: diff --git a/api/generated/api.json b/api/generated/api.json index 129282f..440dc9b 100644 --- a/api/generated/api.json +++ b/api/generated/api.json @@ -12044,13 +12044,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -12191,13 +12191,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -12230,13 +12230,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -12254,13 +12254,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -14598,6 +14598,7 @@ "default": "api:create-installation" }, "content": { + "description": "The content of the config.", "title": "Config Content", "allOf": [ { @@ -16170,8 +16171,7 @@ } } } - ], - "description": "The content of the config." + ] } }, "description": "The config of the installation." @@ -16308,13 +16308,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -16455,13 +16455,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -16494,13 +16494,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -16518,13 +16518,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -19164,13 +19164,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -19311,13 +19311,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -19350,13 +19350,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -19374,13 +19374,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -22576,13 +22576,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -22723,13 +22723,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -22762,13 +22762,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -22786,13 +22786,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -25274,13 +25274,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -25421,13 +25421,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -25460,13 +25460,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -25484,13 +25484,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -28493,13 +28493,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -28640,13 +28640,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -28679,13 +28679,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -28703,13 +28703,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -33328,7 +33328,7 @@ "type": "string", "description": "The time the operation was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } } @@ -35009,7 +35009,7 @@ "type": "string", "description": "The time the operation was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -35281,7 +35281,7 @@ "timestamp": { "type": "string", "description": "The time the log was created.", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "message": { "type": "object", @@ -42106,13 +42106,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -42145,13 +42145,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -42169,13 +42169,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -43136,13 +43136,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -43175,13 +43175,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -43199,13 +43199,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -44297,13 +44297,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -44336,13 +44336,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -44360,13 +44360,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -44956,7 +44956,7 @@ }, "patch": { "summary": "Update a connection.", - "description": "Update an existing connection.", + "description": "Rotate credentials or update metadata (such as the provider workspace reference) for an existing connection.", "operationId": "updateConnection", "tags": [ "Connection" @@ -44969,7 +44969,8 @@ "schema": { "type": "string" }, - "description": "Project ID or Name." + "description": "The Ampersand project ID or project name.", + "example": "my-project" }, { "name": "connectionId", @@ -44978,7 +44979,8 @@ "schema": { "type": "string" }, - "description": "Connection ID." + "description": "The ID of the connection to update. You can find this via the [list connections endpoint](https://docs.withampersand.com/reference/connection/list-connections).", + "example": "connection-123" } ], "requestBody": { @@ -44987,6 +44989,7 @@ "application/json": { "schema": { "title": "Update Connection Request", + "description": "Specify which fields to update in `updateMask` and provide corresponding values in `connection`. Fields in `connection` not listed in `updateMask` are ignored.", "type": "object", "required": [ "updateMask", @@ -44996,12 +44999,19 @@ "updateMask": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "providerWorkspaceRef", + "providerMetadata", + "apiKey", + "basicAuth", + "oauth2ClientCredentials", + "oauth2PasswordCredentials" + ] }, - "description": "Array of field paths specifying which fields to update. Allowed values include:\n- providerWorkspaceRef\n- providerMetadata\n- apiKey\n- basicAuth\n- oauth2ClientCredentials\n- oauth2PasswordCredentials\n", + "description": "Fields to update. Each entry must have a corresponding value in `connection`. Credential fields (`apiKey`, `basicAuth`, `oauth2ClientCredentials`, `oauth2PasswordCredentials`) must match the connection's existing auth scheme.", "example": [ - "providerWorkspaceRef", - "providerMetadata" + "apiKey" ] }, "connection": { @@ -45214,6 +45224,44 @@ } } } + }, + "examples": { + "rotateApiKey": { + "summary": "Rotate an API key", + "value": { + "updateMask": [ + "apiKey" + ], + "connection": { + "apiKey": "new-api-key-value" + } + } + }, + "updateBasicAuth": { + "summary": "Update basic auth credentials", + "value": { + "updateMask": [ + "basicAuth" + ], + "connection": { + "basicAuth": { + "username": "new-username", + "password": "new-password" + } + } + } + }, + "updateWorkspaceRef": { + "summary": "Update provider workspace reference", + "value": { + "updateMask": [ + "providerWorkspaceRef" + ], + "connection": { + "providerWorkspaceRef": "new-workspace-id" + } + } + } } } } @@ -45341,13 +45389,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -45380,13 +45428,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -45404,13 +45452,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -45533,12 +45581,30 @@ } } } + }, + "example": { + "id": "c3a1f9d2-7b4e-4f8a-9e6d-2c5b8a3f1e7d", + "projectId": "a1b2c3d4-e5f6-4789-a012-3456789abcde", + "provider": "salesforce", + "group": { + "groupRef": "8f2e4a6b-1c3d-4e5f-9a7b-0d8e6f2c4a1b", + "groupName": "my-group" + }, + "consumer": { + "consumerRef": "d4e5f6a7-b8c9-4d0e-a1f2-3b4c5d6e7f8a", + "consumerName": "my-consumer" + }, + "providerWorkspaceRef": "my-org.my.salesforce.com", + "authScheme": "apiKey", + "status": "working", + "createTime": "2023-07-13T21:34:44.816354Z", + "updateTime": "2024-01-15T10:22:33.000000Z" } } } }, "400": { - "description": "Bad request.", + "description": "Invalid update mask or request body. The response includes the list of allowed mask values.", "content": { "application/problem+json": { "schema": { @@ -45857,12 +45923,23 @@ } ] } + }, + "example": { + "type": "about:blank", + "title": "Bad Request", + "status": 400, + "detail": "Invalid update mask", + "subsystem": "api", + "time": "2024-04-22T18:55:28.456076Z", + "requestId": "89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715", + "remedy": "Allowed masks: 'providerWorkspaceRef, providerMetadata, apiKey, basicAuth, oauth2ClientCredentials, oauth2PasswordCredentials'", + "retryable": false } } } }, "default": { - "description": "Error", + "description": "Error (e.g. connection not found, auth scheme mismatch, or server error).", "content": { "application/problem+json": { "schema": { @@ -66990,13 +67067,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -67137,13 +67214,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -67176,13 +67253,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -67200,13 +67277,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -70711,13 +70788,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -70750,13 +70827,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -70774,13 +70851,13 @@ "type": "string", "description": "The time the connection was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the connection was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "authScheme": { "type": "string", @@ -71016,6 +71093,7 @@ }, "UpdateConnectionRequest": { "title": "Update Connection Request", + "description": "Specify which fields to update in `updateMask` and provide corresponding values in `connection`. Fields in `connection` not listed in `updateMask` are ignored.", "type": "object", "required": [ "updateMask", @@ -71025,12 +71103,19 @@ "updateMask": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "providerWorkspaceRef", + "providerMetadata", + "apiKey", + "basicAuth", + "oauth2ClientCredentials", + "oauth2PasswordCredentials" + ] }, - "description": "Array of field paths specifying which fields to update. Allowed values include:\n- providerWorkspaceRef\n- providerMetadata\n- apiKey\n- basicAuth\n- oauth2ClientCredentials\n- oauth2PasswordCredentials\n", + "description": "Fields to update. Each entry must have a corresponding value in `connection`. Credential fields (`apiKey`, `basicAuth`, `oauth2ClientCredentials`, `oauth2PasswordCredentials`) must match the connection's existing auth scheme.", "example": [ - "providerWorkspaceRef", - "providerMetadata" + "apiKey" ] }, "connection": { @@ -71704,13 +71789,13 @@ "type": "string", "description": "The time the group was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the group was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -71743,13 +71828,13 @@ "type": "string", "description": "The time the consumer was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "updateTime": { "type": "string", "description": "The time the consumer was last updated.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -71876,7 +71961,7 @@ "type": "string", "description": "The time the operation was created.", "format": "date-time", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" } } }, @@ -71936,7 +72021,7 @@ "timestamp": { "type": "string", "description": "The time the log was created.", - "example": "2023-07-13T21:34:44.816354Z" + "example": "2023-07-13T21:34:44.816Z" }, "message": { "type": "object", diff --git a/catalog/generated/catalog.json b/catalog/generated/catalog.json index c4e90d7..a1f7747 100644 --- a/catalog/generated/catalog.json +++ b/catalog/generated/catalog.json @@ -2678,7 +2678,7 @@ "properties": { "timestamp": { "type": "string", - "example": "2024-07-30T15:14:51-07:00", + "example": "2024-07-30T22:14:51.000Z", "description": "An RFC3339 formatted timestamp of when the catalog was generated.", "x-oapi-codegen-extra-tags": { "validate": "required"