updating api doc

This commit is contained in:
Roland Osborne 2022-11-01 11:27:57 -07:00
parent fc3a84d94b
commit 32cfc7fa4d
2 changed files with 4746 additions and 2752 deletions

View File

@ -250,6 +250,12 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: accountId
in: path
description: specified account
required: true
schema:
type: string
responses: responses:
'201': '201':
description: generated description: generated
@ -366,6 +372,45 @@ paths:
'500': '500':
description: internal server error description: internal server error
/account/flag/{guid}:
get:
tags:
- account
description: Report record for admin review.
operationId: add-flag
parameters:
- name: guid
in: path
description: guid of account holder
required: true
schema:
type: string
- name: channel
in: query
description: channel of or reported record
required: false
schema:
type: string
- name: topic
in: query
description: topic id of reported record
required: false
schema:
type: string
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Profile'
'401':
description: permission denied
'500':
description: internal server error
/account/listing: /account/listing:
get: get:
tags: tags:
@ -373,9 +418,9 @@ paths:
description: Get profile of searchable accounts. Endpoint is publically accessible. description: Get profile of searchable accounts. Endpoint is publically accessible.
operationId: get-account-listing operationId: get-account-listing
parameters: parameters:
- name: guid - name: filter
in: query in: query
description: filter for specified guid description: filter handles by text
required: false required: false
schema: schema:
type: string type: string
@ -792,6 +837,25 @@ paths:
description: account disabled description: account disabled
'500': '500':
description: internal server error description: internal server error
delete:
tags:
- profile
description: Delete own account.
operationId: remove-profile
parameters:
- name: agent
in: query
description: agent token
required: false
schema:
type: string
responses:
'200':
description: success
'401':
description: permission denied
'500':
description: internal server error
/profile/data: /profile/data:
put: put:
@ -1167,6 +1231,39 @@ paths:
description: internal server error description: internal server error
/contact/cards/{cardId}: /contact/cards/{cardId}:
get:
tags:
- contact
description: Get specified card. Access granted to app tokens of account holder.
operationId: get-card
parameters:
- name: cardId
in: path
description: specified card id
required: true
schema:
type: string
- name: agent
in: query
description: agent token
required: false
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Card'
'401':
description: permission denied
'404':
description: card not found
'410':
description: account disabled
'500':
description: internal server error
delete: delete:
tags: tags:
- contact - contact
@ -3227,7 +3324,7 @@ components:
appToken: appToken:
type: string type: string
LoginAccess { LoginAccess:
type: object type: object
required: required:
- guid - guid
@ -3636,7 +3733,7 @@ components:
enableAudio: enableAudio:
type: boolean type: boolean
enableVideo: enableVideo:
type: video type: boolean
contacts: contacts:
$ref: '#/components/schemas/ChannelContacts' $ref: '#/components/schemas/ChannelContacts'
members: members:
@ -4006,3 +4103,4 @@ components:
scheme: bearer scheme: bearer

File diff suppressed because one or more lines are too long