chore: Add Swagger docs for Platform APIs (#2349)
This commit is contained in:
40
swagger/paths/platform/account_users/create.yml
Normal file
40
swagger/paths/platform/account_users/create.yml
Normal file
@@ -0,0 +1,40 @@
|
||||
tags:
|
||||
- Account Users
|
||||
operationId: create-an-account-user
|
||||
summary: Create an Account User
|
||||
description: Create an Account User
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
user_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
required: true
|
||||
role:
|
||||
type: string
|
||||
description: whether user is an administrator or agent
|
||||
required: true
|
||||
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
properties:
|
||||
account_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
user_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
role:
|
||||
type: string
|
||||
description: whether user is an administrator or agent
|
||||
|
||||
401:
|
||||
description: Unauthorized
|
||||
26
swagger/paths/platform/account_users/delete.yml
Normal file
26
swagger/paths/platform/account_users/delete.yml
Normal file
@@ -0,0 +1,26 @@
|
||||
tags:
|
||||
- Account Users
|
||||
operationId: delete-an-account-user
|
||||
summary: Delete an Account User
|
||||
description: Delete an Account User
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
parameters:
|
||||
- name: data
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
user_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
required: true
|
||||
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The account does not exist
|
||||
28
swagger/paths/platform/account_users/index.yml
Normal file
28
swagger/paths/platform/account_users/index.yml
Normal file
@@ -0,0 +1,28 @@
|
||||
tags:
|
||||
- Account Users
|
||||
operationId: list-all-account-users
|
||||
summary: List all Account Users
|
||||
description: List all account users
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of account users'
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
account_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
user_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
role:
|
||||
type: string
|
||||
description: whether user is an administrator or agent
|
||||
|
||||
401:
|
||||
description: Unauthorized
|
||||
Reference in New Issue
Block a user