From 2ec7febbe6218f4734ff34ef0dac16437e1fa998 Mon Sep 17 00:00:00 2001 From: balzack Date: Sat, 1 Jan 2022 16:29:58 -0800 Subject: [PATCH] adding description to content module --- api.oa3 | 76 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 35 deletions(-) diff --git a/api.oa3 b/api.oa3 index 24a207e5..d90746b8 100644 --- a/api.oa3 +++ b/api.oa3 @@ -1238,7 +1238,7 @@ paths: get: tags: - 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 security: - bearerAuth: [] @@ -1258,7 +1258,7 @@ paths: type: integer format: int64 '401': - description: invalid password + description: permission denied '500': description: internal server error @@ -1266,8 +1266,8 @@ paths: get: tags: - content - description: Get articles from specified block - operationId: get-article-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-articles security: - bearerAuth: [] parameters: @@ -1287,7 +1287,9 @@ paths: items: $ref: '#/components/schemas/Article' '401': - description: invalid password + description: permission denied + '404': + description: block not found '500': description: internal server error @@ -1295,8 +1297,8 @@ paths: get: tags: - content - description: Get view articles in content block - operationId: get-article-view + 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-views security: - bearerAuth: [] parameters: @@ -1322,7 +1324,9 @@ paths: type: integer format: int64 '401': - description: invalid password + description: permission denied + '404': + description: block not found '500': description: internal server error @@ -1330,7 +1334,7 @@ paths: post: tags: - content - description: Add an content article + description: Add a content article. Access granted to access token of the account holder. operationId: add-article security: - bearerAuth: [] @@ -1350,7 +1354,7 @@ paths: article: $ref: '#/components/schemas/Article' '401': - description: invalid token + description: permission denied '500': description: internal server error @@ -1358,7 +1362,7 @@ paths: get: tags: - 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 security: - bearerAuth: [] @@ -1371,19 +1375,21 @@ paths: type: string responses: '200': - description: successful operation + description: success content: application/json: schema: $ref: '#/components/schemas/Article' '401': - description: invalid password + description: permission denied + '404': + description: article not found '500': description: internal server error delete: tags: - content - description: Remove specified article + description: Remove specified article. Access granted to app token of account holder. operationId: remove-article security: - bearerAuth: [] @@ -1396,9 +1402,11 @@ paths: type: string responses: '200': - description: successful operation + description: success '401': description: invalid password + '404': + description: article not found '500': description: internal server error @@ -1406,8 +1414,8 @@ paths: put: tags: - content - description: Add an content article - operationId: update-content-article + description: Set subject for article. Access granted to app token of account holder. + operationId: set-article-subject security: - bearerAuth: [] parameters: @@ -1418,10 +1426,12 @@ paths: schema: type: string responses: - '201': - description: entry created + '200': + description: success '401': - description: invalid token + description: permission denied + '404': + description: article not found '500': description: internal server error requestBody: @@ -2027,10 +2037,6 @@ paths: '500': description: internal server error - # /conversation/dialogues/{dialogueId}/sync - s - # /conversation/dialogues/{dialogueId}/insights/{guid} - a,d - # /conversation/insights/{dialogueId} a,d - /conversation/dialogues: get: tags: @@ -2187,7 +2193,7 @@ paths: type: string - name: guid in: path - description: specified card id + description: specified contact id required: true schema: type: string @@ -2206,7 +2212,7 @@ paths: tags: - 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 - operationId: set-dialogue-insight-active + operationId: set-dialogue-insight-status security: - bearerAuth: [] parameters: @@ -2218,7 +2224,7 @@ paths: type: string - name: guid in: path - description: specified card id + description: specified contact id required: true schema: type: string @@ -2296,7 +2302,7 @@ paths: parameters: - name: guid in: path - description: id of card hosting the dialogue + description: id of contact hosting the dialogue required: true schema: type: string @@ -2336,7 +2342,7 @@ paths: parameters: - name: guid in: path - description: id of card hosting the dialogue + description: id of contact hosting the dialogue required: true schema: type: string @@ -2367,7 +2373,7 @@ paths: parameters: - name: guid in: path - description: id of card hosting the dialogue + description: id of contact hosting the dialogue required: true schema: type: string @@ -2472,7 +2478,7 @@ paths: tags: - 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. - operationId: get-topic-view + operationId: get-topic-views security: - bearerAuth: [] parameters: @@ -3158,8 +3164,9 @@ components: required: - profile - content - - labels - - sharing + - view # revision increment on sharing changes + - share + - label - card - blocked - dialogue @@ -3483,7 +3490,6 @@ components: - status - subject - labels - - groups - tagCount - tagUpdated - tagRevision @@ -3502,7 +3508,7 @@ components: type: array items: type: string - groups: + groups: # present only in account holder responses type: array items: type: string