docs: Add documentation for integration APIs (#2300)

This commit is contained in:
Sojan Jose
2021-05-20 20:46:45 +05:30
committed by GitHub
parent c681e8a01b
commit 46356d0bf9
23 changed files with 421 additions and 22 deletions

View File

@@ -0,0 +1,19 @@
tags:
- Integrations
operationId: create-an-integration-hook
summary: Create an integration hook
description: Create an integration hook
parameters:
- $ref: '#/parameters/account_id'
- name: data
in: body
required: true
schema:
$ref: '#/definitions/integrations_hook_create_payload'
responses:
200:
description: Success
schema:
$ref: '#/definitions/integrations_hook'
401:
description: Unauthorized

View File

@@ -0,0 +1,15 @@
tags:
- Integrations
operationId: delete-an-integration-hook
summary: Delete an Integration Hook
description: Delete an Integration Hook
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/hook_id'
responses:
200:
description: Success
401:
description: Unauthorized
404:
description: The hook does not exist in the account

View File

@@ -0,0 +1,20 @@
tags:
- Integrations
operationId: update-an-integrations-hook
summary: Update an Integration Hook
description: Update an Integration Hook
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/hook_id'
- name: data
in: body
required: true
schema:
$ref: '#/definitions/integrations_hook_update_payload'
responses:
200:
description: Success
schema:
$ref: '#/definitions/integrations_hook'
401:
description: Unauthorized