martin/databag
1
0
Fork 0
mirror of https://github.com/balzack/databag.git synced 2025-02-12 03:29:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

updating contact module

Browse Source
This commit is contained in:
balzack 2022-01-02 12:11:51 -08:00
parent 684f120f5f
commit d28ca900be
1 changed files with 44 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
api.oa3
View File

@ -673,21 +673,21 @@ paths:
post: post:
tags: tags:
- contact - contact
description: Add a card entry description: Add a contact card. Access granted to app tokens of account holder.
operationId: add-contact-card operationId: add-card
security: security:
- bearerAuth: [] - bearerAuth: []
responses: responses:
'200': '200':
description: successful operation description: success
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DataMessage' $ref: '#/components/schemas/DataMessage'
'400':
description: invalid data message
'401': '401':
description: invalid password description: permission denied
'404':
description: not found
'500': '500':
description: internal server error description: internal server error
@ -695,8 +695,8 @@ paths:
get: get:
tags: tags:
- contact - contact
description: Get list of cards description: Get list of card views. Access granted to app tokens of account holder.
operationId: get-contact-cards operationId: get-card-view
security: security:
- bearerAuth: [] - bearerAuth: []
responses: responses:
@ -709,7 +709,7 @@ paths:
items: items:
$ref: '#/components/schemas/CardView' $ref: '#/components/schemas/CardView'
'401': '401':
description: invalid password description: permission denied
'500': '500':
description: internal server error description: internal server error
@ -717,8 +717,8 @@ paths:
get: get:
tags: tags:
- contact - contact
description: Get card entry description: Retieve card entry. Permission granted to app tokens for account holder.
operationId: get-contact-card operationId: get-card
security: security:
- bearerAuth: [] - bearerAuth: []
parameters: parameters:
@ -736,16 +736,16 @@ paths:
schema: schema:
$ref: '#/components/schemas/Card' $ref: '#/components/schemas/Card'
'401': '401':
description: invalid password description: permission denied
'404': '404':
description: not found description: card not found
'500': '500':
description: internal server error description: internal server error
delete: delete:
tags: tags:
- contact - contact
description: Remove card entry description: Remove card entry. Access granted to app tokens of account holder.
operationId: remove-contact-card operationId: remove-card
security: security:
- bearerAuth: [] - bearerAuth: []
parameters: parameters:
@ -757,11 +757,11 @@ paths:
type: string type: string
responses: responses:
'200': '200':
description: successful operation description: success
'401': '401':
description: invalid password description: permission denied
'404': '404':
description: not found description: card not found
'500': '500':
description: internal server error description: internal server error
@ -769,8 +769,8 @@ paths:
put: put:
tags: tags:
- contact - contact
description: Update card status description: Updated connected status of contact. Access granted to app tokens of account holder.
operationId: set-contact-card-status operationId: set-card-status
security: security:
- bearerAuth: [] - bearerAuth: []
parameters: parameters:
@ -783,20 +783,20 @@ paths:
- name: token - name: token
in: query in: query
description: token for accessing card description: token for accessing card
required: true required: false # required for connected
schema: schema:
type: string type: string
responses: responses:
'200': '200':
description: successful operation description: success
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CardData' $ref: '#/components/schemas/CardData'
'401': '401':
description: invalid password description: permission denied
'404': '404':
description: not found description: card not found
'500': '500':
description: internal server error description: internal server error
requestBody: requestBody:
@ -810,8 +810,8 @@ paths:
get: get:
tags: tags:
- contact - contact
description: Get message for opening card connection description: Get message for connecting to other contacts. Access granted to app tokens for account holder.
operationId: get-contact-open-message operationId: get-open-message
security: security:
- bearerAuth: [] - bearerAuth: []
parameters: parameters:
@ -823,22 +823,22 @@ paths:
type: string type: string
responses: responses:
'200': '200':
description: successful operation description: success
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/DataMessage' $ref: '#/components/schemas/DataMessage'
'401': '401':
description: invalid password description: permission denied
'404': '404':
description: not found description: card not found
'500': '500':
description: internal server error description: internal server error
put: put:
tags: tags:
- contact - contact
description: Set message for opening card connection description: Set message for connecting to a contact. If card has not already been added, the card will be created in the pending state. Access granted to public.
operationId: set-contact-open-message operationId: set-open-message
parameters: parameters:
- name: cardId - name: cardId
in: path in: path
@ -853,10 +853,8 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CardStatus' $ref: '#/components/schemas/CardStatus'
'401': '400':
description: invalid password description: invalid data message
'404':
description: not found
'500': '500':
description: internal server error description: internal server error
requestBody: requestBody:
@ -869,8 +867,8 @@ paths:
get: get:
tags: tags:
- contact - contact
description: Get message for closing card connection description: Get message for closing connection with contact. Access granted to app tokens for account holder.
operationId: get-contact-close-message operationId: get-close-message
security: security:
- bearerAuth: [] - bearerAuth: []
parameters: parameters:
@ -888,16 +886,16 @@ paths:
schema: schema:
$ref: '#/components/schemas/DataMessage' $ref: '#/components/schemas/DataMessage'
'401': '401':
description: invalid password description: permission denied
'404': '404':
description: not found description: card not found
'500': '500':
description: internal server error description: internal server error
put: put:
tags: tags:
- contact - contact
description: Set message for closing card connection description: Set message for closing card connection. Access granted to public.
operationId: set-contact-close-message operationId: set-close-message
parameters: parameters:
- name: cardId - name: cardId
in: path in: path
@ -912,10 +910,8 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CardStatus' $ref: '#/components/schemas/CardStatus'
'401': '400':
description: invalid password description: invalid data message
'404':
description: not found
'500': '500':
description: internal server error description: internal server error
requestBody: requestBody:
@ -928,7 +924,7 @@ paths:
get: get:
tags: tags:
- contact - contact
description: Get profile of card entry description: Get profile of card entry.
operationId: get-contact-profile operationId: get-contact-profile
security: security:
- bearerAuth: [] - bearerAuth: []
@ -947,7 +943,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/CardProfile' $ref: '#/components/schemas/CardProfile'
'401': '401':
description: invalid password description: permission denied
'404': '404':
description: not found description: not found
'500': '500':
@ -3752,7 +3748,7 @@ components:
properties: properties:
status: status:
type: string type: string
enum: [ pending, confirmed, connecting, connected ] enum: [ pending, confirmed, requested, connecting, connected ]
token: token:
type: string type: string