mirror of
https://github.com/balzack/databag.git
synced 2025-02-12 03:29:16 +00:00
adding description to content module
This commit is contained in:
balzack
parent
427966d5c4
commit
2ec7febbe6
76
api.oa3
76
api.oa3
@ -1238,7 +1238,7 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Get view of content blocks
|
description: Get article block views. Acess granted to account token or contact token. When the request is made with a contact token the account view revision will be added to the block revision.
|
||||||
operationId: get-article-block-view
|
operationId: get-article-block-view
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
@ -1258,7 +1258,7 @@ paths:
|
|||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
'401':
|
'401':
|
||||||
description: invalid password
|
description: permission denied
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
|
|
||||||
@ -1266,8 +1266,8 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Get articles from specified block
|
description: Get articles within specified block. Access granted for app token or contact token. All of the articles are returned for the app token, but only the shared articles are returned for the contact token.
|
||||||
operationId: get-article-block
|
operationId: get-articles
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
parameters:
|
parameters:
|
||||||
@ -1287,7 +1287,9 @@ paths:
|
|||||||
items:
|
items:
|
||||||
$ref: '#/components/schemas/Article'
|
$ref: '#/components/schemas/Article'
|
||||||
'401':
|
'401':
|
||||||
description: invalid password
|
description: permission denied
|
||||||
|
'404':
|
||||||
|
description: block not found
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
|
|
||||||
@ -1295,8 +1297,8 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Get view articles in content block
|
description: Get article views within specified block. Access granted for app token or contact token. All of the articles are returned for the app token, but only the shared articles are returned for the contact token.
|
||||||
operationId: get-article-view
|
operationId: get-article-views
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
parameters:
|
parameters:
|
||||||
@ -1322,7 +1324,9 @@ paths:
|
|||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
'401':
|
'401':
|
||||||
description: invalid password
|
description: permission denied
|
||||||
|
'404':
|
||||||
|
description: block not found
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
|
|
||||||
@ -1330,7 +1334,7 @@ paths:
|
|||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Add an content article
|
description: Add a content article. Access granted to access token of the account holder.
|
||||||
operationId: add-article
|
operationId: add-article
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
@ -1350,7 +1354,7 @@ paths:
|
|||||||
article:
|
article:
|
||||||
$ref: '#/components/schemas/Article'
|
$ref: '#/components/schemas/Article'
|
||||||
'401':
|
'401':
|
||||||
description: invalid token
|
description: permission denied
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
|
|
||||||
@ -1358,7 +1362,7 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Get specified article
|
description: Get specified article. Access granted to app token of account holder or contact token of account the article is shared with.
|
||||||
operationId: get-article
|
operationId: get-article
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
@ -1371,19 +1375,21 @@ 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/Article'
|
$ref: '#/components/schemas/Article'
|
||||||
'401':
|
'401':
|
||||||
description: invalid password
|
description: permission denied
|
||||||
|
'404':
|
||||||
|
description: article not found
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Remove specified article
|
description: Remove specified article. Access granted to app token of account holder.
|
||||||
operationId: remove-article
|
operationId: remove-article
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
@ -1396,9 +1402,11 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: successful operation
|
description: success
|
||||||
'401':
|
'401':
|
||||||
description: invalid password
|
description: invalid password
|
||||||
|
'404':
|
||||||
|
description: article not found
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
|
|
||||||
@ -1406,8 +1414,8 @@ paths:
|
|||||||
put:
|
put:
|
||||||
tags:
|
tags:
|
||||||
- content
|
- content
|
||||||
description: Add an content article
|
description: Set subject for article. Access granted to app token of account holder.
|
||||||
operationId: update-content-article
|
operationId: set-article-subject
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
parameters:
|
parameters:
|
||||||
@ -1418,10 +1426,12 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'200':
|
||||||
description: entry created
|
description: success
|
||||||
'401':
|
'401':
|
||||||
description: invalid token
|
description: permission denied
|
||||||
|
'404':
|
||||||
|
description: article not found
|
||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
requestBody:
|
requestBody:
|
||||||
@ -2027,10 +2037,6 @@ paths:
|
|||||||
'500':
|
'500':
|
||||||
description: internal server error
|
description: internal server error
|
||||||
|
|
||||||
# /conversation/dialogues/{dialogueId}/sync - s
|
|
||||||
# /conversation/dialogues/{dialogueId}/insights/{guid} - a,d
|
|
||||||
# /conversation/insights/{dialogueId} a,d
|
|
||||||
|
|
||||||
/conversation/dialogues:
|
/conversation/dialogues:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -2187,7 +2193,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
- name: guid
|
- name: guid
|
||||||
in: path
|
in: path
|
||||||
description: specified card id
|
description: specified contact id
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@ -2206,7 +2212,7 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- conversation
|
- conversation
|
||||||
description: Set active status for contact on the host node. Access is granted to a contact token for an accound with the specified guid
|
description: Set active status for contact on the host node. Access is granted to a contact token for an accound with the specified guid
|
||||||
operationId: set-dialogue-insight-active
|
operationId: set-dialogue-insight-status
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
parameters:
|
parameters:
|
||||||
@ -2218,7 +2224,7 @@ paths:
|
|||||||
type: string
|
type: string
|
||||||
- name: guid
|
- name: guid
|
||||||
in: path
|
in: path
|
||||||
description: specified card id
|
description: specified contact id
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@ -2296,7 +2302,7 @@ paths:
|
|||||||
parameters:
|
parameters:
|
||||||
- name: guid
|
- name: guid
|
||||||
in: path
|
in: path
|
||||||
description: id of card hosting the dialogue
|
description: id of contact hosting the dialogue
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@ -2336,7 +2342,7 @@ paths:
|
|||||||
parameters:
|
parameters:
|
||||||
- name: guid
|
- name: guid
|
||||||
in: path
|
in: path
|
||||||
description: id of card hosting the dialogue
|
description: id of contact hosting the dialogue
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@ -2367,7 +2373,7 @@ paths:
|
|||||||
parameters:
|
parameters:
|
||||||
- name: guid
|
- name: guid
|
||||||
in: path
|
in: path
|
||||||
description: id of card hosting the dialogue
|
description: id of contact hosting the dialogue
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@ -2472,7 +2478,7 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- conversation
|
- conversation
|
||||||
description: Get a view of the topics within a topicBlock. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue.
|
description: Get a view of the topics within a topicBlock. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue.
|
||||||
operationId: get-topic-view
|
operationId: get-topic-views
|
||||||
security:
|
security:
|
||||||
- bearerAuth: []
|
- bearerAuth: []
|
||||||
parameters:
|
parameters:
|
||||||
@ -3158,8 +3164,9 @@ components:
|
|||||||
required:
|
required:
|
||||||
- profile
|
- profile
|
||||||
- content
|
- content
|
||||||
- labels
|
- view # revision increment on sharing changes
|
||||||
- sharing
|
- share
|
||||||
|
- label
|
||||||
- card
|
- card
|
||||||
- blocked
|
- blocked
|
||||||
- dialogue
|
- dialogue
|
||||||
@ -3483,7 +3490,6 @@ components:
|
|||||||
- status
|
- status
|
||||||
- subject
|
- subject
|
||||||
- labels
|
- labels
|
||||||
- groups
|
|
||||||
- tagCount
|
- tagCount
|
||||||
- tagUpdated
|
- tagUpdated
|
||||||
- tagRevision
|
- tagRevision
|
||||||
@ -3502,7 +3508,7 @@ components:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
groups:
|
groups: # present only in account holder responses
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user