adding filter to request types

This commit is contained in:
balzack 2022-01-01 18:33:27 -08:00
parent 2ec7febbe6
commit d8f142e6af

186
api.oa3
View File

@ -562,6 +562,15 @@ paths:
operationId: get-share-groups operationId: get-share-groups
security: security:
- bearerAuth: [] - bearerAuth: []
parameters:
- name: types
in: query
description: limit resutls to groups of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -1266,7 +1275,7 @@ paths:
get: get:
tags: tags:
- content - content
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. description: Get the 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. An article is shared by assigning a common group to an article or assigning a label to an article that has assigned a common group.
operationId: get-articles operationId: get-articles
security: security:
- bearerAuth: [] - bearerAuth: []
@ -1297,7 +1306,7 @@ paths:
get: get:
tags: tags:
- content - content
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. description: Get the 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. An article is shared by assigning a common group to an article or assigning a label to an article that has assigned a common group.
operationId: get-article-views operationId: get-article-views
security: security:
- bearerAuth: [] - bearerAuth: []
@ -1357,6 +1366,23 @@ paths:
description: permission denied description: permission denied
'500': '500':
description: internal server error description: internal server error
requestBody:
content:
application/json:
schema:
type: object
required:
- labels
- groups
properties:
labels:
type: array
items:
type: string
groups:
type: array
items:
type: string
/content/articles/{articleId}: /content/articles/{articleId}:
get: get:
@ -1575,6 +1601,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to articles of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -1616,6 +1650,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to articles of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -1657,6 +1699,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to articles of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -1955,6 +2005,15 @@ paths:
operationId: get-content-labels operationId: get-content-labels
security: security:
- bearerAuth: [] - bearerAuth: []
parameters:
- name: types
in: query
description: limit resutls to labels of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -2037,6 +2096,63 @@ paths:
'500': '500':
description: internal server error description: internal server error
/content/labels/{labelId}/groups/{groupId}:
post:
tags:
- content
description: set sharing group for label
operationId: set-label-group
security:
- bearerAuth: []
parameters:
- name: labelId
in: path
description: specified label id
required: true
schema:
type: string
- name: groupId
in: path
description: specified group id
required: true
schema:
type: string
responses:
'200':
description: entry set
'401':
description: invalid token
'500':
description: internal server error
delete:
tags:
- content
description: clear sharing group for label
operationId: clear-label-group
security:
- bearerAuth: []
parameters:
- name: labelId
in: path
description: specified label id
required: true
schema:
type: string
- name: groupId
in: path
description: specified group id
required: true
schema:
type: string
responses:
'200':
description: entry removed
'401':
description: invalid token
'500':
description: internal server error
/conversation/dialogues: /conversation/dialogues:
get: get:
tags: tags:
@ -2457,6 +2573,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to topics of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -2494,6 +2618,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to topics of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -2671,7 +2803,7 @@ paths:
get: get:
tags: tags:
- conversation - conversation
description: Get a view of all of the tags within a block. Authorization granted to account holder app token or dialogue member contact token who has access to the topic. description: Get a view of all of all tagBlocks. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
operationId: get-topic-tag-block-view operationId: get-topic-tag-block-view
security: security:
- bearerAuth: [] - bearerAuth: []
@ -2688,6 +2820,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to articles of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -2737,6 +2877,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to tags of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -2786,6 +2934,14 @@ paths:
required: true required: true
schema: schema:
type: string type: string
- name: types
in: query
description: limit resutls to tags of types
required: false
schema:
type: array
items:
type: string
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -3359,14 +3515,14 @@ components:
Subject: Subject:
type: object type: object
required: required:
- postId - subjectId
- revision - revision
- type - type
- data - data
- created - created
- modified - modified
properties: properties:
postId: subjectId:
type: string type: string
revision: revision:
type: integer type: integer
@ -3559,23 +3715,21 @@ components:
Group: Group:
type: object type: object
required: required:
- groupId - subject
- name
properties: properties:
groupId: subject:
type: string $ref: '#/components/schemas/Subject'
name:
type: string
Label: Label:
type: object type: object
required: required:
- labelId - subject
- name
properties: properties:
labelId: subject:
type: string $ref: '#/components/schemas/Subject'
name: groups: # present only in account holder responses
type: array
items:
type: string type: string
Authenticate: Authenticate: