chore: Add Swagger docs for Platform APIs (#2349)

This commit is contained in:
Sojan Jose
2021-05-31 10:58:43 +05:30
committed by GitHub
parent cc75a668cb
commit 9d16e52e33
37 changed files with 2315 additions and 837 deletions

View 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

View 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

View 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