chore: Add Swagger docs for Platform APIs (#2349)
This commit is contained in:
20
swagger/paths/platform/accounts/create.yml
Normal file
20
swagger/paths/platform/accounts/create.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: create-an-account
|
||||
summary: Create an Account
|
||||
description: Create an Account
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/account_create_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/platform_account'
|
||||
401:
|
||||
description: Unauthorized
|
||||
14
swagger/paths/platform/accounts/delete.yml
Normal file
14
swagger/paths/platform/accounts/delete.yml
Normal file
@@ -0,0 +1,14 @@
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: delete-an-account
|
||||
summary: Delete an Account
|
||||
description: Delete an Account
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The account does not exist
|
||||
16
swagger/paths/platform/accounts/show.yml
Normal file
16
swagger/paths/platform/accounts/show.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: get-details-of-an-account
|
||||
summary: Get an account details
|
||||
description: Get the details of an account
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/platform_account'
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The given account does not exist
|
||||
20
swagger/paths/platform/accounts/update.yml
Normal file
20
swagger/paths/platform/accounts/update.yml
Normal file
@@ -0,0 +1,20 @@
|
||||
tags:
|
||||
- Accounts
|
||||
operationId: update-an-account
|
||||
summary: Update an account
|
||||
description: Update an account's attributes
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/account_create_update_payload'
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
$ref: '#/definitions/platform_account'
|
||||
401:
|
||||
description: Unauthorized
|
||||
Reference in New Issue
Block a user