From cf2796214266776e7fef2b2ddb87889064097fc1 Mon Sep 17 00:00:00 2001 From: Codat Pipeline Bot Date: Thu, 23 Jan 2025 12:14:47 +0000 Subject: [PATCH] Merged PR 86217: Removed deprecated rules endpoints --- json/Codat-Platform.json | 435 +-------------------------------------- yaml/Codat-Platform.yaml | 293 +------------------------- 2 files changed, 2 insertions(+), 726 deletions(-) diff --git a/json/Codat-Platform.json b/json/Codat-Platform.json index 6b0e3b5..5f19ab4 100644 --- a/json/Codat-Platform.json +++ b/json/Codat-Platform.json @@ -2106,303 +2106,6 @@ "description": "Retrieve information about a single dataset or pull operation." } }, - "/rules": { - "get": { - "summary": "List webhooks (legacy)", - "operationId": "list-rules", - "description": "Use the *List webhooks (legacy)* endpoint to retrieve all existing rule-based webhooks for your client.\n\n**Note:** This endpoint has been deprecated. Please use the [*List webhook consumers*](https://docs.codat.io/platform-api#/operations/list-webhook-consumers) endpoint for listing webhooks moving forward.", - "parameters": [ - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/pageSize" - }, - { - "$ref": "#/components/parameters/query" - }, - { - "$ref": "#/components/parameters/orderBy" - } - ], - "deprecated": true, - "tags": [ - "Webhooks" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Webhook/definitions/webhooks" - }, - "examples": { - "Example": { - "value": { - "results": [ - { - "id": "fcfbfe0b-fe73-47ed-a7fe-0018567f5da2", - "type": "DataConnectionStatusChanged", - "notifiers": { - "emails": [], - "webhook": "https://webhook.site/6d385ea9-bcf9-48e4-9103-1958ccb54997" - } - } - ], - "pageNumber": 1, - "pageSize": 100, - "totalResults": 1, - "_links": { - "current": { - "href": "/rules?page=1&pageSize=100" - }, - "self": { - "href": "/rules" - } - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/Malformed-Query" - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "402": { - "$ref": "#/components/responses/Payment-Required" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/Not-Found" - }, - "429": { - "$ref": "#/components/responses/Too-Many-Requests" - }, - "500": { - "$ref": "#/components/responses/Internal-Server-Error" - }, - "503": { - "$ref": "#/components/responses/Service-Unavailable" - } - } - }, - "post": { - "summary": "Create webhook (legacy)", - "description": "Use the *Create webhooks (legacy)* endpoint to create a rule-based webhook for your client.\n\n**Note:** This endpoint has been deprecated. Please use the [*Create webhook consumer*](https://docs.codat.io/platform-api#/operations/create-webhook-consumer) endpoint to create a webhook moving forward.", - "operationId": "create-rule", - "deprecated": true, - "tags": [ - "Webhooks" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Webhook" - } - } - } - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "402": { - "$ref": "#/components/responses/Payment-Required" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "429": { - "$ref": "#/components/responses/Too-Many-Requests" - }, - "500": { - "$ref": "#/components/responses/Internal-Server-Error" - }, - "503": { - "$ref": "#/components/responses/Service-Unavailable" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Webhook/definitions/createRule" - }, - "examples": { - "Company data connection status changed": { - "value": { - "type": "DataConnectionStatusChanged", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "New company synchronized": { - "value": { - "type": "New company synchronised", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Data sync completed": { - "value": { - "type": "Data sync completed", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Dataset data changed": { - "value": { - "type": "Dataset data changed", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Dataset status has changed to an error state": { - "value": { - "type": "Data Sync Status Changed To Error", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Push operation status has changed": { - "value": { - "type": "Push Operation Status Changed", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Push operation has timed out": { - "value": { - "type": "Push Operation Timed Out", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Account categories updated": { - "value": { - "type": "Account Categories Updated", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - }, - "Sync Connection Deleted": { - "value": { - "type": "Sync Connection Deleted", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - } - } - } - }, - "description": "Create a webhook with the given configuration." - } - } - }, - "/rules/{ruleId}": { - "parameters": [ - { - "$ref": "#/components/parameters/ruleId" - } - ], - "get": { - "summary": "Get webhook (legacy)", - "operationId": "get-webhook", - "description": "Use the *Get webhook (legacy)* endpoint to retrieve a specific webhook for your client.\n\n**Note:** This endpoint has been deprecated. Please use the [*List webhook consumers*](https://docs.codat.io/platform-api#/operations/list-webhook-consumers) endpoint for listing webhooks moving forward.", - "deprecated": true, - "tags": [ - "Webhooks" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Webhook" - }, - "examples": {} - } - } - }, - "401": { - "$ref": "#/components/responses/Unauthorized" - }, - "402": { - "$ref": "#/components/responses/Payment-Required" - }, - "403": { - "$ref": "#/components/responses/Forbidden" - }, - "404": { - "$ref": "#/components/responses/Not-Found" - }, - "429": { - "$ref": "#/components/responses/Too-Many-Requests" - }, - "500": { - "$ref": "#/components/responses/Internal-Server-Error" - }, - "503": { - "$ref": "#/components/responses/Service-Unavailable" - } - } - } - }, "/webhooks": { "get": { "summary": "List webhook consumers", @@ -7091,11 +6794,6 @@ "example": "sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB", "description": "The API key for this Codat instance." }, - "alertAuthHeader": { - "type": "string", - "example": "Bearer tXEiHiRK7XCtI8TNHbpGs1LI1pumdb4Cl1QIo7B2", - "description": "Alert or webhooks authorization header." - }, "confirmCompanyName": { "type": "boolean", "deprecated": true, @@ -7955,116 +7653,6 @@ }, "additionalProperties": false }, - "Webhook": { - "title": "Webhook", - "description": "Configuration to provide an event notification to a URL or list of email addresses based on the given type or condition.", - "type": "object", - "allOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "nullable": false, - "description": "Unique identifier for the configured notification.", - "example": "ff89c50e-a719-4ef5-a182-9917e53927b6" - } - } - }, - { - "$ref": "#/components/schemas/Webhook/definitions/createRule" - } - ], - "definitions": { - "createRule": { - "title": "Create webhook", - "description": "Create a message that notifies a URL of an event based on its given type or condition.", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of webhook." - }, - "companyId": { - "$ref": "#/components/parameters/companyId/schema" - }, - "notifiers": { - "$ref": "#/components/schemas/Webhook/definitions/webhookNotifier" - } - }, - "examples": [ - { - "type": "DataConnectionStatusChanged", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - ], - "required": [ - "type", - "notifiers" - ] - }, - "webhookNotifier": { - "type": "object", - "title": "Webhook notifiers", - "properties": { - "emails": { - "type": "array", - "items": { - "type": "string", - "format": "email", - "description": "Receiver's email address.", - "example": "info@client.com" - } - }, - "webhook": { - "type": "string", - "format": "uri", - "description": "The URI the webhook service will use to post events.", - "example": "https://webhook.client.com" - } - } - }, - "webhooks": { - "title": "Webhooks", - "allOf": [ - { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } - } - } - }, - { - "$ref": "#/components/schemas/PagingInfo" - } - ] - } - }, - "examples": [ - { - "id": "ff89c50e-a719-4ef5-a182-9917e53927b6", - "type": "DataConnectionStatusChanged", - "companyId": "39b73b17-cc2e-429e-915d-71654e9dcd1e", - "notifiers": { - "emails": [ - "info@client.com" - ], - "webhook": "https://webhook.client.com" - } - } - ] - }, "WebhookConsumer": { "title": "Webhook consumer", "type": "object", @@ -8096,20 +7684,13 @@ }, "companyTags": { "type": "array", + "nullable": true, "description": "Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format `tagKey:tagValue`.", "items": { "type": "string", "maxLength": 128 }, "maxItems": 10 - }, - "companyId": { - "deprecated": true, - "type": "string", - "format": "uuid", - "nullable": true, - "example": "8a210b68-6988-11ed-a1eb-0242ac120002", - "description": "Unique identifier of the company to indicate company-specific events. The associated webhook consumer will receive events only for the specified ID." } }, "definitions": { @@ -8128,9 +7709,6 @@ }, "companyTags": { "$ref": "#/components/schemas/WebhookConsumer/properties/companyTags" - }, - "companyId": { - "$ref": "#/components/schemas/WebhookConsumer/properties/companyId" } } }, @@ -8537,17 +8115,6 @@ "$ref": "#/components/schemas/DataType" } }, - "ruleId": { - "name": "ruleId", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "example": "7318949f-c008-4936-a8ff-10d7ab563fa6" - }, - "description": "Unique ID of the webhook or rule." - }, "datasetId": { "name": "datasetId", "in": "path", diff --git a/yaml/Codat-Platform.yaml b/yaml/Codat-Platform.yaml index 327d24f..e3498da 100644 --- a/yaml/Codat-Platform.yaml +++ b/yaml/Codat-Platform.yaml @@ -1460,205 +1460,6 @@ paths: '503': $ref: '#/components/responses/Service-Unavailable' description: Retrieve information about a single dataset or pull operation. - /rules: - get: - summary: List webhooks (legacy) - operationId: list-rules - description: |- - Use the *List webhooks (legacy)* endpoint to retrieve all existing rule-based webhooks for your client. - - **Note:** This endpoint has been deprecated. Please use the [*List webhook consumers*](https://docs.codat.io/platform-api#/operations/list-webhook-consumers) endpoint for listing webhooks moving forward. - parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' - deprecated: true - tags: - - Webhooks - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Webhook/definitions/webhooks' - examples: - Example: - value: - results: - - id: fcfbfe0b-fe73-47ed-a7fe-0018567f5da2 - type: DataConnectionStatusChanged - notifiers: - emails: [] - webhook: 'https://webhook.site/6d385ea9-bcf9-48e4-9103-1958ccb54997' - pageNumber: 1 - pageSize: 100 - totalResults: 1 - _links: - current: - href: /rules?page=1&pageSize=100 - self: - href: /rules - '400': - $ref: '#/components/responses/Malformed-Query' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - post: - summary: Create webhook (legacy) - description: |- - Use the *Create webhooks (legacy)* endpoint to create a rule-based webhook for your client. - - **Note:** This endpoint has been deprecated. Please use the [*Create webhook consumer*](https://docs.codat.io/platform-api#/operations/create-webhook-consumer) endpoint to create a webhook moving forward. - operationId: create-rule - deprecated: true - tags: - - Webhooks - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Webhook' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Webhook/definitions/createRule' - examples: - Company data connection status changed: - value: - type: DataConnectionStatusChanged - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - New company synchronized: - value: - type: New company synchronised - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Data sync completed: - value: - type: Data sync completed - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Dataset data changed: - value: - type: Dataset data changed - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Dataset status has changed to an error state: - value: - type: Data Sync Status Changed To Error - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Push operation status has changed: - value: - type: Push Operation Status Changed - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Push operation has timed out: - value: - type: Push Operation Timed Out - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Account categories updated: - value: - type: Account Categories Updated - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - Sync Connection Deleted: - value: - type: Sync Connection Deleted - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - description: Create a webhook with the given configuration. - '/rules/{ruleId}': - parameters: - - $ref: '#/components/parameters/ruleId' - get: - summary: Get webhook (legacy) - operationId: get-webhook - description: |- - Use the *Get webhook (legacy)* endpoint to retrieve a specific webhook for your client. - - **Note:** This endpoint has been deprecated. Please use the [*List webhook consumers*](https://docs.codat.io/platform-api#/operations/list-webhook-consumers) endpoint for listing webhooks moving forward. - deprecated: true - tags: - - Webhooks - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Webhook' - examples: {} - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' /webhooks: get: summary: List webhook consumers @@ -5070,10 +4871,6 @@ components: deprecated: true example: sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB description: The API key for this Codat instance. - alertAuthHeader: - type: string - example: Bearer tXEiHiRK7XCtI8TNHbpGs1LI1pumdb4Cl1QIo7B2 - description: Alert or webhooks authorization header. confirmCompanyName: type: boolean deprecated: true @@ -5705,77 +5502,6 @@ components: description: The current authorization status of the data connection. nullable: true additionalProperties: false - Webhook: - title: Webhook - description: Configuration to provide an event notification to a URL or list of email addresses based on the given type or condition. - type: object - allOf: - - type: object - properties: - id: - type: string - format: uuid - nullable: false - description: Unique identifier for the configured notification. - example: ff89c50e-a719-4ef5-a182-9917e53927b6 - - $ref: '#/components/schemas/Webhook/definitions/createRule' - definitions: - createRule: - title: Create webhook - description: Create a message that notifies a URL of an event based on its given type or condition. - type: object - properties: - type: - type: string - description: The type of webhook. - companyId: - $ref: '#/components/parameters/companyId/schema' - notifiers: - $ref: '#/components/schemas/Webhook/definitions/webhookNotifier' - examples: - - type: DataConnectionStatusChanged - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' - required: - - type - - notifiers - webhookNotifier: - type: object - title: Webhook notifiers - properties: - emails: - type: array - items: - type: string - format: email - description: Receiver's email address. - example: info@client.com - webhook: - type: string - format: uri - description: The URI the webhook service will use to post events. - example: 'https://webhook.client.com' - webhooks: - title: Webhooks - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Webhook' - - $ref: '#/components/schemas/PagingInfo' - examples: - - id: ff89c50e-a719-4ef5-a182-9917e53927b6 - type: DataConnectionStatusChanged - companyId: 39b73b17-cc2e-429e-915d-71654e9dcd1e - notifiers: - emails: - - info@client.com - webhook: 'https://webhook.client.com' WebhookConsumer: title: Webhook consumer type: object @@ -5802,18 +5528,12 @@ components: type: string companyTags: type: array + nullable: true description: 'Company tags provide an additional way to filter messages, independent of event types. Company tags are case-sensitive, and only messages from companies with matching tags will be sent to this endpoint. Use the format `tagKey:tagValue`.' items: type: string maxLength: 128 maxItems: 10 - companyId: - deprecated: true - type: string - format: uuid - nullable: true - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier of the company to indicate company-specific events. The associated webhook consumer will receive events only for the specified ID. definitions: webhookConsumerPrototype: title: Create webhook consumer @@ -5827,8 +5547,6 @@ components: $ref: '#/components/schemas/WebhookConsumer/properties/eventTypes' companyTags: $ref: '#/components/schemas/WebhookConsumer/properties/companyTags' - companyId: - $ref: '#/components/schemas/WebhookConsumer/properties/companyId' webhookConsumers: title: Webhook consumers type: object @@ -6124,15 +5842,6 @@ components: required: true schema: $ref: '#/components/schemas/DataType' - ruleId: - name: ruleId - in: path - required: true - schema: - type: string - format: uuid - example: 7318949f-c008-4936-a8ff-10d7ab563fa6 - description: Unique ID of the webhook or rule. datasetId: name: datasetId in: path