martin/databag
1
0
Fork 0
mirror of https://github.com/balzack/databag.git synced 2025-02-11 19:19:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
2ec7febbe6
databag/api.oa3

3669 lines
95 KiB
Plaintext
Raw Normal View History

starting api with swagger
2021-12-20 21:49:59 +00:00
openapi: 3.0.0
info:
description: |
DataBag provides storage for decentralized identity based self-hosting apps.
It is intended to support sharing of personal data and hosting group
conversations.
version: "0.0.1"
title: DataBag
contact:
email: roland.osborne@gmail.com
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: revision
description: websocket endpoint for receiving module revision events
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- name: admin
description: account creation for portal backend.
- name: account
description: account configuration for portal backend. supports app attachment
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
- name: authenticate
description: authenticate holder of identity for external service
starting api with swagger
2021-12-20 21:49:59 +00:00
- name: profile
description: getting and setting of the public profile
adding contact module
2021-12-24 22:59:24 +00:00
- name: share
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: access control for personal subjects, associates content and cards
adding contact module
2021-12-24 22:59:24 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: contact
description: connection to other identities, hook receiver
preparing for contact module
2021-12-22 05:50:25 +00:00
- name: content
description: posting and listing of personal subjects, group and tag managment
adding endpoints for content module
2021-12-27 23:15:54 +00:00
starting api with swagger
2021-12-20 21:49:59 +00:00
- name: converstaion
description: group sharing of subjects
paths:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
# Concetps:
## access tokens for bearer auth:prefix for bearer tokens types
### app: app_
### contact: cnt_
### pass code: pas_
### account reset: res_
### account create: act_
## subject based content provides external definition of datatypes
preparing for content module
2021-12-26 07:19:25 +00:00
starting api with swagger
2021-12-20 21:49:59 +00:00
/revision:
get:
tags:
- revision
added registry module
2021-12-21 08:13:48 +00:00
description: Websocket placeholder endpoint for receiving revision updates
starting api with swagger
2021-12-20 21:49:59 +00:00
operationId: websocket
responses:
'200':
description: Awaiting announce
specifying contact module
2021-12-25 22:54:45 +00:00
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/admin/claimable:
starting api with swagger
2021-12-20 21:49:59 +00:00
get:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- admin
added registry module
2021-12-21 08:13:48 +00:00
description: Check if portal params have been set
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: node-configurable
starting api with swagger
2021-12-20 21:49:59 +00:00
responses:
'200':
description: success
'405':
description: admin already configured
'500':
description: internal server error
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/admin/config:
starting api with swagger
2021-12-20 21:49:59 +00:00
post:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- admin
added registry module
2021-12-21 08:13:48 +00:00
description: Set admin password and node domain
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: add-node-config
starting api with swagger
2021-12-20 21:49:59 +00:00
security:
- basicAuth: []
parameters:
- name: domain
in: query
description: domain of node
required: true
schema:
type: string
responses:
'200':
description: success
'405':
description: admin already configured
'500':
description: internal server error
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/admin/config/domain:
starting api with swagger
2021-12-20 21:49:59 +00:00
put:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- admin
added registry module
2021-12-21 08:13:48 +00:00
description: Set portal domain
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: set-node-config-domain
security:
- basicAuth: []
responses:
'200':
description: success
'401':
description: authentication error
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
type: string
/admin/token:
put:
tags:
- admin
description: Create password reset token url
operationId: set-node-account
starting api with swagger
2021-12-20 21:49:59 +00:00
security:
- basicAuth: []
parameters:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- name: guid
starting api with swagger
2021-12-20 21:49:59 +00:00
in: query
split portal module into admin & account
2021-12-21 22:08:18 +00:00
description: id of profile to access
starting api with swagger
2021-12-20 21:49:59 +00:00
required: true
schema:
type: string
split portal module into admin & account
2021-12-21 22:08:18 +00:00
responses:
'201':
description: generated
content:
application/json:
schema:
type: string
'401':
description: invalid password
'404':
description: unknown portal
'500':
description: internal server error
post:
tags:
- admin
description: Create new account token url
operationId: add-node-account
security:
- basicAuth: []
responses:
'201':
description: generated
content:
application/json:
schema:
type: string
'401':
description: invalid password
'500':
description: internal server error
/admin/accounts:
get:
tags:
- admin
description: Get list of portals
operationId: get-node-accounts
security:
- basicAuth: []
starting api with swagger
2021-12-20 21:49:59 +00:00
responses:
'200':
split portal module into admin & account
2021-12-21 22:08:18 +00:00
description: successful operation
content:
application/json:
schema:
type: array
items:
adding contact module
2021-12-24 22:59:24 +00:00
$ref: '#/components/schemas/Profile'
starting api with swagger
2021-12-20 21:49:59 +00:00
'401':
split portal module into admin & account
2021-12-21 22:08:18 +00:00
description: invalid password
'404':
description: handle not found
starting api with swagger
2021-12-20 21:49:59 +00:00
'500':
description: internal server error
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/admin/accounts/{guid}:
delete:
tags:
- admin
description: Remove account from node
operationId: remove-node-account
security:
- basicAuth: []
parameters:
- name: guid
in: path
description: id of account to delete
required: true
schema:
type: string
responses:
'200':
description: successful operation
'401':
description: invalid authentication
'404':
description: account not found
'500':
description: internal server error
/admin/accounts/{guid}/image:
get:
tags:
- admin
description: Get profile of specified account
operationId: get-node-account-image
security:
- basicAuth: []
parameters:
- name: guid
in: path
description: id of specified account
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/octet-stream:
schema:
type: string
format: binary
'401':
description: invalid password
'404':
description: account not found
'500':
description: internal server error
/account/claimable:
starting api with swagger
2021-12-20 21:49:59 +00:00
get:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
starting api with swagger
2021-12-20 21:49:59 +00:00
description: Check if username is available
operationId: check-username
security:
- bearerAuth: []
parameters:
- name: username
in: query
description: username to check
required: true
schema:
type: string
responses:
'200':
description: success
'401':
description: authentication error
'405':
description: username already taken
'500':
description: internal server error
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/account/token:
starting api with swagger
2021-12-20 21:49:59 +00:00
get:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
description: Check if bearer token is valid
operationId: check-token
security:
- bearerAuth: []
responses:
'200':
description: success
'401':
description: invalid token
'500':
description: internal server error
/account/profile:
get:
tags:
- account
starting api with swagger
2021-12-20 21:49:59 +00:00
description: Get public profile object
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: get-account-profile
starting api with swagger
2021-12-20 21:49:59 +00:00
security:
- basicAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'401':
description: authentication error
'500':
description: internal server error
post:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
description: Add a new account
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: add-account
starting api with swagger
2021-12-20 21:49:59 +00:00
security:
- bearerAuth: []
- basicAuth: []
responses:
'201':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
'400':
description: invalid handle or password
'401':
description: invalid bearer token
'500':
description: internal server error
added profile module
2021-12-21 22:47:10 +00:00
/account/authentication:
post:
tags:
- account
description: Generate token to reset authentication
operationId: add-account-authentication
security:
- basicAuth: []
responses:
'201':
description: generated
content:
application/json:
schema:
type: string
'401':
description: invalid password
'500':
description: internal server error
put:
tags:
- account
description: Apply account reset token to set handle and password
operationId: set-account-authentication
security:
- bearerAuth: []
- basicAuth: []
responses:
'201':
description: successful operation
'401':
description: invalid token
'406':
description: invalid handle or password
'500':
description: internal server error
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/account/attachment:
added registry module
2021-12-21 08:13:48 +00:00
post:
starting api with swagger
2021-12-20 21:49:59 +00:00
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
description: Generate token to attach an app to the account
operationId: add-account-app
starting api with swagger
2021-12-20 21:49:59 +00:00
security:
- basicAuth: []
responses:
'201':
description: generated
content:
application/json:
schema:
type: string
'401':
description: invalid password
'500':
description: internal server error
added registry module
2021-12-21 08:13:48 +00:00
put:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
description: Apply the app token and attach an app to the account
operationId: set-account-app
added registry module
2021-12-21 08:13:48 +00:00
security:
- bearerAuth: []
responses:
'201':
description: generated
content:
application/json:
schema:
type: string
'401':
description: invalid token
'406':
description: app limit reached
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AppData'
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/account/apps:
added registry module
2021-12-21 08:13:48 +00:00
get:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
added registry module
2021-12-21 08:13:48 +00:00
description: Get list of attached apps
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: get-account-apps
added registry module
2021-12-21 08:13:48 +00:00
security:
- basicAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
$ref: '#/components/schemas/App'
added registry module
2021-12-21 08:13:48 +00:00
'401':
description: invalid password
'500':
description: internal server error
split portal module into admin & account
2021-12-21 22:08:18 +00:00
/account/apps/{appId}:
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
delete:
tags:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
- account
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
description: Get list of attached apps
split portal module into admin & account
2021-12-21 22:08:18 +00:00
operationId: remove-account-app
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
security:
- basicAuth: []
parameters:
- name: appId
in: path
description: specified app id
required: true
schema:
type: string
responses:
'200':
description: successful operation
'401':
description: invalid password
'404':
description: app not found
'500':
description: internal server error
/authenticate:
put:
tags:
- authenticate
description: Sign payload containing external token for authentication
operationId: authenticate
security:
- bearerAuth: []
parameters:
- name: token
in: query
description: token to sign in message response
required: true
schema:
type: string
responses:
'201':
description: generated
content:
application/json:
schema:
$ref: '#/components/schemas/DataMessage'
'401':
description: invalid token
'500':
description: internal server error
added profile module
2021-12-21 22:47:10 +00:00
/profile:
get:
tags:
- profile
description: Get profile view object
operationId: get-profile
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding contact module
2021-12-24 22:59:24 +00:00
$ref: '#/components/schemas/Profile'
added profile module
2021-12-21 22:47:10 +00:00
'401':
description: invalid token
'500':
description: internal server error
put:
tags:
- profile
description: Set profile data
operationId: set-profile
security:
- bearerAuth: []
responses:
'200':
description: successful operation
'401':
description: invalid token
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileData'
preparing for contact module
2021-12-22 05:50:25 +00:00
/profile/image:
get:
tags:
- profile
description: Get profile image
operationId: get-profile-image
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/octet-stream:
schema:
type: string
format: binary
'401':
description: invalid token
'500':
description: internal server error
added profile module
2021-12-21 22:47:10 +00:00
/profile/message:
get:
tags:
- profile
description: Get profile message
operationId: get-profile-message
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataMessage'
'401':
description: invalid token
'500':
description: internal server error
adding contact module
2021-12-24 22:59:24 +00:00
/share/groups:
get:
tags:
- share
description: Get groups for sharing
operationId: get-share-groups
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Group'
'401':
description: invalid token
'500':
description: internal server error
post:
tags:
- share
description: Add a group for sharing
operationId: add-share-group
security:
- bearerAuth: []
responses:
'201':
description: entry created
'401':
description: invalid token
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
type: string
/share/groups/{groupId}:
completed first pass of content module
2021-12-28 05:07:43 +00:00
put:
adding contact module
2021-12-24 22:59:24 +00:00
tags:
- share
completed first pass of content module
2021-12-28 05:07:43 +00:00
description: Update group for sharing
operationId: update-share-group
adding contact module
2021-12-24 22:59:24 +00:00
security:
- bearerAuth: []
parameters:
- name: groupId
in: path
description: specified group id
required: true
schema:
type: string
responses:
'200':
description: successful operation
'401':
description: invalid token
'500':
description: internal server error
completed first pass of content module
2021-12-28 05:07:43 +00:00
requestBody:
content:
application/json:
schema:
type: string
delete:
adding contact module
2021-12-24 22:59:24 +00:00
tags:
- share
completed first pass of content module
2021-12-28 05:07:43 +00:00
description: Get groups for sharing
operationId: remove-share-group
adding contact module
2021-12-24 22:59:24 +00:00
security:
- bearerAuth: []
parameters:
- name: groupId
in: path
description: specified group id
required: true
schema:
type: string
responses:
'200':
description: successful operation
'401':
description: invalid token
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards:
post:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Add card entry
operationId: add-contact-card
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/Card'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
description: invalid password
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
adding contact module
2021-12-24 22:59:24 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards/view:
adding contact module
2021-12-24 22:59:24 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get list of cards
operationId: get-contact-cards
adding contact module
2021-12-24 22:59:24 +00:00
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardView'
adding contact module
2021-12-24 22:59:24 +00:00
'401':
description: invalid password
'500':
description: internal server error
working on content module
2021-12-24 06:58:04 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards/{cardId}:
specifying contact module
2021-12-25 22:54:45 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get card entry
operationId: get-contact-card
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/Card'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
description: invalid password
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
delete:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Remove card entry
operationId: remove-contact-card
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
adding conversation descriptions
2021-12-31 20:23:30 +00:00
parameters:
- name: cardId
in: path
description: specified card id
required: true
schema:
type: string
specifying contact module
2021-12-25 22:54:45 +00:00
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'200':
description: successful operation
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards/{cardId}/status:
put:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Update card status
operationId: set-contact-card-status
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
required: true
schema:
type: string
- name: token
in: query
description: token for accessing card
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
description: invalid password
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
type: string
enum: [ pending, confirmed, connecting, connected ]
/contact/cards/{cardId}/openMessage:
get:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get message for opening card connection
operationId: get-contact-open-message
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
content:
application/json:
schema:
$ref: '#/components/schemas/DataMessage'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
description: invalid password
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
put:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Set message for opening card connection
operationId: set-contact-open-message
specifying contact module
2021-12-25 22:54:45 +00:00
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'200':
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardStatus'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
$ref: '#/components/schemas/DataMessage'
/contact/cards/{cardId}/closeMessage:
get:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get message for closing card connection
operationId: get-contact-close-message
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/DataMessage'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
put:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Set message for closing card connection
operationId: set-contact-close-message
first pass of conversation module
2021-12-29 05:49:51 +00:00
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardStatus'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataMessage'
/contact/cards/{cardId}/profile:
get:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get profile of card entry
operationId: get-contact-profile
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardProfile'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
put:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Set profile of card entry
operationId: set-contact-profile
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardProfile'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
first pass of conversation module
2021-12-29 05:49:51 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards/{cardId}/data:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get data of card entry
operationId: get-contact-data
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
description: invalid password
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards/{cardId}/notes:
put:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Update card notes
operationId: set-contact-card-notes
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
description: invalid password
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
type: string
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Clear card notes
operationId: clear-contact-card-notes
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'200':
description: successful operation
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/cards/{cardId}/shares/{shareId}:
put:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Update card notes
operationId: set-contact-card-share
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: shareId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified share id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'200':
description: successful operation
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
delete:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Clear card share group
operationId: clear-contact-card-share
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: shareId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified share id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/blocked:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Get list of blocked cards
operationId: get-contact-blocked-cards
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'200':
description: successful operation
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
type: array
items:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/blocked/{cardId}:
first pass of conversation module
2021-12-29 05:49:51 +00:00
post:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Add card from blocked list
operationId: add-contact-blocked-card
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'200':
description: successful operation
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
'404':
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- contact
description: Remove card from blocked list
operationId: remove-contact-blocked-card
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: cardId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified card id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/contact/profile/revision:
put:
tags:
- contact
description: Hook receiver for card profile revision updates
operationId: revision-profile-hook
security:
- bearerAuth: []
responses:
'200':
description: revision set
'401':
description: not authorized
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
type: integer
format: int64
/contact/content/revision:
put:
tags:
- contact
description: Hook receiver for card content revision updates
operationId: revision-content-hook
security:
- bearerAuth: []
responses:
'200':
description: revision set
'401':
description: not authorized
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
type: integer
format: int64
/content/articleBlocks/view:
get:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
tags:
- content
adding description to content module
2022-01-02 00:29:58 +00:00
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.
adding conversation descriptions
2021-12-31 20:23:30 +00:00
operationId: get-article-block-view
renamed index module to contact module
2021-12-31 06:01:08 +00:00
security:
- bearerAuth: []
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
renamed index module to contact module
2021-12-31 06:01:08 +00:00
content:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
application/json:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: array
items:
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
renamed index module to contact module
2021-12-31 06:01:08 +00:00
'401':
adding description to content module
2022-01-02 00:29:58 +00:00
description: permission denied
renamed index module to contact module
2021-12-31 06:01:08 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articleBlocks/{blockId}:
get:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
- content
adding description to content module
2022-01-02 00:29:58 +00:00
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
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: blockId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified group id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Article'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding description to content module
2022-01-02 00:29:58 +00:00
description: permission denied
'404':
description: block not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articleBlocks/{blockId}/view:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
- content
adding description to content module
2022-01-02 00:29:58 +00:00
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
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
adding conversation descriptions
2021-12-31 20:23:30 +00:00
parameters:
- name: blockId
in: path
description: specified group id
required: true
schema:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding description to content module
2022-01-02 00:29:58 +00:00
description: permission denied
'404':
description: block not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles:
first pass of conversation module
2021-12-29 05:49:51 +00:00
post:
tags:
- content
adding description to content module
2022-01-02 00:29:58 +00:00
description: Add a content article. Access granted to access token of the account holder.
adding conversation descriptions
2021-12-31 20:23:30 +00:00
operationId: add-article
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
responses:
'201':
description: entry created
adding conversation descriptions
2021-12-31 20:23:30 +00:00
content:
application/json:
schema:
type: object
properties:
blockId:
type: string
blockRevision:
type: integer
format: int64
article:
$ref: '#/components/schemas/Article'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding description to content module
2022-01-02 00:29:58 +00:00
description: permission denied
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}:
get:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
- content
adding description to content module
2022-01-02 00:29:58 +00:00
description: Get specified article. Access granted to app token of account holder or contact token of account the article is shared with.
adding conversation descriptions
2021-12-31 20:23:30 +00:00
operationId: get-article
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding description to content module
2022-01-02 00:29:58 +00:00
description: success
adding conversation descriptions
2021-12-31 20:23:30 +00:00
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding description to content module
2022-01-02 00:29:58 +00:00
description: permission denied
'404':
description: article not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
delete:
tags:
- content
adding description to content module
2022-01-02 00:29:58 +00:00
description: Remove specified article. Access granted to app token of account holder.
adding conversation descriptions
2021-12-31 20:23:30 +00:00
operationId: remove-article
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding description to content module
2022-01-02 00:29:58 +00:00
description: success
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid password
adding description to content module
2022-01-02 00:29:58 +00:00
'404':
description: article not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/subject:
put:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
adding description to content module
2022-01-02 00:29:58 +00:00
description: Set subject for article. Access granted to app token of account holder.
operationId: set-article-subject
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
adding conversation descriptions
2021-12-31 20:23:30 +00:00
parameters:
- name: articleId
in: path
description: specified article id
required: true
schema:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
responses:
adding description to content module
2022-01-02 00:29:58 +00:00
'200':
description: success
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding description to content module
2022-01-02 00:29:58 +00:00
description: permission denied
'404':
description: article not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
type: object
required:
- type
- data
properties:
type:
type: string
data:
type: string
/content/articles/{articleId}/groups/{groupId}:
post:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: set sharing group for article
operationId: set-article-group
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
adding conversation descriptions
2021-12-31 20:23:30 +00:00
parameters:
- name: articleId
in: path
description: specified article id
required: true
schema:
type: string
- name: groupId
in: path
description: specified share group id
required: true
schema:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: entry set
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: clear sharing group for article
operationId: clear-article-group
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: groupId
in: path
description: specified share id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: entry removed
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/labels/{labelId}:
post:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: set orginizational label for article
operationId: set-article-label
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: labelId
in: path
description: specified label id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: entry set
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: clear orginizationl label for article
operationId: clear-article-label
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: labelId
in: path
description: specified label id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: entry cleared
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/tagBlocks/view:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Get view tag blocks in article
operationId: get-article-tag-block-view
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: array
items:
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
description: invalid password
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/tagBlocks/{blockId}/view:
get:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Get view tag blocks in article
operationId: get-tag-view
security:
- bearerAuth: []
first pass of conversation module
2021-12-29 05:49:51 +00:00
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: blockId
in: path
description: specified block id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: array
items:
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
'401':
description: invalid password
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/tagBlocks/{blockId}:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Get tags from specified block
operationId: get-tag-block
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: blockId
in: path
description: specified block id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: array
items:
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
description: invalid password
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/tags:
post:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Add an content article
operationId: add-article-tag
security:
- bearerAuth: []
first pass of conversation module
2021-12-29 05:49:51 +00:00
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'201':
description: entry created
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: object
properties:
blockId:
type: string
blockRevision:
type: integer
format: int64
tag:
$ref: '#/components/schemas/Tag'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/tags/{tagId}:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Add an content article
operationId: get-article-tag
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: tagId
in: path
description: specified tag id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'201':
description: entry created
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
$ref: '#/components/schemas/Tag'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: tag not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Add an content article
operationId: remove-article-tag
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: tagId
in: path
description: specified tag id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: entry removed
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: tag not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/assets:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Get assets attached to article
operationId: get-article-assets
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'201':
description: entry created
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: array
items:
$ref: '#/components/schemas/Asset'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
post:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Add an content article
operationId: add-article-asset
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: transforms
in: query
description: transforms to apply
required: false
schema:
type: array
items:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'201':
description: entry created
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
$ref: '#/components/schemas/Asset'
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
requestBody:
content:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
multipart/form-data:
first pass of conversation module
2021-12-29 05:49:51 +00:00
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: object
properties:
fileName:
type: string
format: binary
/content/articles/{articleId}/assets/{assetId}:
get:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Get asset attached to article
operationId: get-article-asset
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
required: true
schema:
type: string
- name: assetId
in: path
description: specified asset id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: article attachment
first pass of conversation module
2021-12-29 05:49:51 +00:00
content:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
application/octet-stream: #asset specific
first pass of conversation module
2021-12-29 05:49:51 +00:00
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: string
format: binary
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: asset not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Remove asset attached to article
operationId: remove-article-asset
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: assetId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified asset id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: article attachment
specifying contact module
2021-12-25 22:54:45 +00:00
content:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
application/octet-stream: #asset specific
specifying contact module
2021-12-25 22:54:45 +00:00
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: string
format: binary
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
specifying contact module
2021-12-25 22:54:45 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: asset not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/articles/{articleId}/confirmed:
put:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: set confirmed state of article
operationId: set-article-confirmed
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
specifying contact module
2021-12-25 22:54:45 +00:00
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: articleId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified article id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
specifying contact module
2021-12-25 22:54:45 +00:00
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: entry set
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
specifying contact module
2021-12-25 22:54:45 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: article not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
type: boolean
specifying contact module
2021-12-25 22:54:45 +00:00
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/content/labels:
specifying contact module
2021-12-25 22:54:45 +00:00
get:
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Get labels for organization
operationId: get-content-labels
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
responses:
'200':
description: successful operation
content:
application/json:
schema:
first pass of conversation module
2021-12-29 05:49:51 +00:00
type: array
items:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
$ref: '#/components/schemas/Label'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
post:
added missing set contact profile endpoint
2021-12-25 22:58:15 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Add a label for organization
operationId: add-content-label
added missing set contact profile endpoint
2021-12-25 22:58:15 +00:00
security:
- bearerAuth: []
responses:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'201':
description: entry created
added missing set contact profile endpoint
2021-12-25 22:58:15 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
added missing set contact profile endpoint
2021-12-25 22:58:15 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
type: string
/content/labels/{labelId}:
put:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Update label for organization
operationId: update-content-label
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- name: labelId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: specified group id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
type: string
delete:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
- content
description: Remove organizational label
operationId: remove-content-label
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
adding conversation descriptions
2021-12-31 20:23:30 +00:00
parameters:
- name: labelId
in: path
description: specified label id
required: true
schema:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: successful operation
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: invalid token
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
/conversation/dialogues:
get:
tags:
- conversation
description: Retrieve all dialogues.
operationId: get-dialogues
security:
- bearerAuth: []
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Dialogue'
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
post:
tags:
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Create and host a new dialogue. Authroization granted to an app token of the account holder.
first pass of conversation module
2021-12-29 05:49:51 +00:00
operationId: add-dialogue
security:
- bearerAuth: []
responses:
'200':
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Dialogue'
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
/conversation/dialogues/{dialogueId}/subject:
put:
tags:
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Set the subject for a dialogue. Authorization granted the an app token for the account holder.
first pass of conversation module
2021-12-29 05:49:51 +00:00
operationId: set-dialogue-subject
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
first pass of conversation module
2021-12-29 05:49:51 +00:00
'201':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: success
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
specifying contact module
2021-12-25 22:54:45 +00:00
'404':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: dialogue not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
first pass of conversation module
2021-12-29 05:49:51 +00:00
type: object
required:
- type
- data
properties:
type:
type: string
data:
type: string
/conversation/dialogues/{dialogueId}/active:
put:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Set active state of dialogue. If a dialogue is inactive any update to the topics will fail. Authorization is granted to an app token of the account holder.
first pass of conversation module
2021-12-29 05:49:51 +00:00
operationId: set-dialogue-active
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: success
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
specifying contact module
2021-12-25 22:54:45 +00:00
'404':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: dialogue not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
requestBody:
content:
application/json:
schema:
type: boolean
/conversation/dialogues/{dialogueId}/insight/{guid}:
post:
specifying contact module
2021-12-25 22:54:45 +00:00
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Add insight to a dialogue. This endpoint will automatically invoke the add insight on the contact's node. Authorization is granted to the app token of the account holder.
operationId: add-dialogue-insight
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: guid
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified card id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: success
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
specifying contact module
2021-12-25 22:54:45 +00:00
'404':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: guid or dialogue not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
delete:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Remove an insight from a dialogue. This endpoint will authomatically invoke the delete insight endpoint on the contact's node. Authorization is granted to the app token of the accoun holder.
operationId: remove-dialogue-insight
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
- name: guid
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding description to content module
2022-01-02 00:29:58 +00:00
description: specified contact id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
first pass of conversation module
2021-12-29 05:49:51 +00:00
responses:
'200':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: success
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
'404':
description: guid or dialogue not found
'500':
description: internal server error
/conversation/dialogues/{dialogueId}/insight/{guid}/status:
put:
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
adding description to content module
2022-01-02 00:29:58 +00:00
operationId: set-dialogue-insight-status
adding description to conversation module
2022-01-01 19:49:04 +00:00
security:
- bearerAuth: []
parameters:
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
- name: guid
in: path
adding description to content module
2022-01-02 00:29:58 +00:00
description: specified contact id
adding description to conversation module
2022-01-01 19:49:04 +00:00
required: true
schema:
type: string
responses:
'200':
description: success
'401':
description: permission denied
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: guid or dialogue not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
adding description to conversation module
2022-01-01 19:49:04 +00:00
requestBody:
content:
application/json:
schema:
type: string
enum: [ active, inactive, dismissed ]
first pass of conversation module
2021-12-29 05:49:51 +00:00
/conversation/dialogues/{dialogueId}:
delete:
tags:
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Remove specified dialogue. This endpoint will authomatically invoke the delete insight endpoint on all of the contacts' nodes. Access is granted to an app token for the account holder.
first pass of conversation module
2021-12-29 05:49:51 +00:00
operationId: remove-dialogue
security:
- bearerAuth: []
parameters:
- name: dialogueId
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: success
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
specifying contact module
2021-12-25 22:54:45 +00:00
'404':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: dialogue not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
/conversation/insights:
specifying contact module
2021-12-25 22:54:45 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Retrieve all insights. Access granted to app token for the account holder.
first pass of conversation module
2021-12-29 05:49:51 +00:00
operationId: get-insights
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
responses:
'200':
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: success
specifying contact module
2021-12-25 22:54:45 +00:00
content:
application/json:
schema:
type: array
items:
first pass of conversation module
2021-12-29 05:49:51 +00:00
$ref: '#/components/schemas/Insight'
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: invalid token
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
/conversation/insights/{guid}/dialogues/{dialogueId}:
specifying contact module
2021-12-25 22:54:45 +00:00
post:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Create or update an insight. Access granted to a contact token for a contact with the specified guid. This endpoint is invoked by the webhook from the contact node.
operationId: add-insight-dialogue
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: guid
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding description to content module
2022-01-02 00:29:58 +00:00
description: id of contact hosting the dialogue
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
- name: dialogueId
in: path
description: dialogue with insight id to update
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: success
content:
application/json:
schema:
type: string
enum: [ active, inactive, dismissed ]
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
'404':
description: dialogue or guid not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
requestBody:
content:
application/json:
schema:
type: integer
format: int64
specifying contact module
2021-12-25 22:54:45 +00:00
delete:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Remove a specified insight. If the referenced dialogue is still active, the insight will get recreated with the next hook receiver update. Access granted to app token of account holder or contact token of dialogue host.
operationId: set-insight-dialogue
specifying contact module
2021-12-25 22:54:45 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: guid
specifying contact module
2021-12-25 22:54:45 +00:00
in: path
adding description to content module
2022-01-02 00:29:58 +00:00
description: id of contact hosting the dialogue
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
- name: dialogueId
in: path
description: insight id to update
specifying contact module
2021-12-25 22:54:45 +00:00
required: true
schema:
type: string
responses:
'200':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: success
specifying contact module
2021-12-25 22:54:45 +00:00
'401':
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: permission denied
'404':
description: dialogue or guid not found
specifying contact module
2021-12-25 22:54:45 +00:00
'500':
description: internal server error
first pass of conversation module
2021-12-29 05:49:51 +00:00
adding description to conversation module
2022-01-01 19:49:04 +00:00
/conversation/insights/{guid}/dialogues/{dialogueId}/status:
put:
first pass of conversation module
2021-12-29 05:49:51 +00:00
tags:
- conversation
adding description to conversation module
2022-01-01 19:49:04 +00:00
description: Set the active status of an insight. This will cause the hook receiver to return an inactive status. Access granted to app token of account holder.
operationId: set-insight-dialogue-active
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
- name: guid
in: path
adding description to content module
2022-01-02 00:29:58 +00:00
description: id of contact hosting the dialogue
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
- name: dialogueId
in: path
description: dialogue with insight id to update
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: success
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: dialogue or guid not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
adding description to conversation module
2022-01-01 19:49:04 +00:00
type: string
enum: [ active, inactive, dismissed ]
first pass of conversation module
2021-12-29 05:49:51 +00:00
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topicBlocks/view:
adding endpoints for content module
2021-12-27 23:15:54 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Get a view of the topicBlocks within a dialogue. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue
operationId: get-topic-block-view
adding endpoints for content module
2021-12-27 23:15:54 +00:00
security:
- bearerAuth: []
first pass of conversation module
2021-12-29 05:49:51 +00:00
parameters:
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
adding endpoints for content module
2021-12-27 23:15:54 +00:00
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: success
adding endpoints for content module
2021-12-27 23:15:54 +00:00
content:
application/json:
schema:
type: array
items:
completed first pass of content module
2021-12-28 05:07:43 +00:00
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: dialogue not found
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topicBlocks/{blockId}:
adding endpoints for content module
2021-12-27 23:15:54 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Get the topics within a topicBlock. Only the account holder and the topic creator will retrieve pending topics. Authorization granted to account holder app token or dialogue member contact token who is also a member of the dialogue
operationId: get-topic-block
adding endpoints for content module
2021-12-27 23:15:54 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
adding endpoints for content module
2021-12-27 23:15:54 +00:00
- name: blockId
in: path
description: specified group id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
$ref: '#/components/schemas/Topic'
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: block or dialogue not found
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topicBlocks/{blockId}/view:
adding endpoints for content module
2021-12-27 23:15:54 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
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.
adding description to content module
2022-01-02 00:29:58 +00:00
operationId: get-topic-views
adding endpoints for content module
2021-12-27 23:15:54 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
adding endpoints for content module
2021-12-27 23:15:54 +00:00
- name: blockId
in: path
description: specified group id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
completed first pass of content module
2021-12-28 05:07:43 +00:00
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: block or dialogue not found
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics:
adding endpoints for content module
2021-12-27 23:15:54 +00:00
post:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Add a topic to a dialogue. The response contains the topicBlock ID and topicBlock revision to which the topic is assigned. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.
operationId: add-dialogue-topic
adding endpoints for content module
2021-12-27 23:15:54 +00:00
security:
- bearerAuth: []
first pass of conversation module
2021-12-29 05:49:51 +00:00
parameters:
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
adding endpoints for content module
2021-12-27 23:15:54 +00:00
responses:
'201':
description: entry created
completed first pass of content module
2021-12-28 05:07:43 +00:00
content:
application/json:
schema:
type: object
properties:
blockId:
type: string
blockRevision:
type: integer
format: int64
renamed index module to contact module
2021-12-31 06:01:08 +00:00
topic:
$ref: '#/components/schemas/Topic'
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: dialogue not found
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}:
adding endpoints for content module
2021-12-27 23:15:54 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Retrieve a specified dialogue topic. Authorization granted to account holder app token or dialogue member contact token who is a member of the dialogue.
operationId: get-dialogue-topic
adding endpoints for content module
2021-12-27 23:15:54 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
adding endpoints for content module
2021-12-27 23:15:54 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
adding endpoints for content module
2021-12-27 23:15:54 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
$ref: '#/components/schemas/Topic'
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: topic or dialogue not found
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'500':
description: internal server error
delete:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Remove a topic from a dialogue. Authorization granted to account holder app token or dialogue member contact token who is either the topic createor or the account holder.
operationId: remove-dialogue-topic
adding endpoints for content module
2021-12-27 23:15:54 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
adding endpoints for content module
2021-12-27 23:15:54 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
adding endpoints for content module
2021-12-27 23:15:54 +00:00
required: true
schema:
type: string
responses:
'200':
description: successful operation
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: topic or dilaogue not found
adding endpoints for content module
2021-12-27 23:15:54 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/subject:
completed first pass of content module
2021-12-28 05:07:43 +00:00
put:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Set the subject for a topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.
operationId: set-topic-subject
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
responses:
'201':
description: entry created
'401':
description: invalid token
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
'404':
description: topic or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
type: object
required:
- type
- data
properties:
type:
type: string
data:
type: string
adding conversation descriptions
2021-12-31 20:23:30 +00:00
/conversation/dialogues/{dialogueId}/{topicId}/tagBlocks/view:
get:
tags:
- 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.
operationId: get-topic-tag-block-view
security:
- bearerAuth: []
parameters:
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
- name: topicId
in: path
description: specified topic id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
'401':
description: permission denied
'404':
description: topic or dialogue not found
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/{topicId}/tagBlocks/{blockId}/view:
first pass of conversation module
2021-12-29 05:49:51 +00:00
get:
completed first pass of content module
2021-12-28 05:07:43 +00:00
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
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.
operationId: get-topic-tag-view
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
- name: blockId
in: path
description: specified block id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
revision:
type: integer
format: int64
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: block, topic or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/tagBlocks/{blockId}:
completed first pass of content module
2021-12-28 05:07:43 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Get all of the tags within a tag block. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
operationId: get-topic-tag-block
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
- name: blockId
in: path
description: specified block id
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
adding conversation descriptions
2021-12-31 20:23:30 +00:00
$ref: '#/components/schemas/Tag'
completed first pass of content module
2021-12-28 05:07:43 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
'404':
description: block, topic, or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/tags:
completed first pass of content module
2021-12-28 05:07:43 +00:00
post:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Add a tag to specified topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic. The body of the post contains the subject of the tag, which can have no associated assets.
renamed index module to contact module
2021-12-31 06:01:08 +00:00
operationId: add-conversation-topic-tag
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
responses:
'201':
description: entry created
content:
application/json:
schema:
type: object
properties:
blockId:
type: string
blockRevision:
type: integer
format: int64
tag:
$ref: '#/components/schemas/Tag'
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
adding conversation descriptions
2021-12-31 20:23:30 +00:00
'404':
description: topic or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
adding conversation descriptions
2021-12-31 20:23:30 +00:00
requestBody:
content:
application/json:
schema:
type: object
required:
- type
- data
properties:
type:
type: string
data:
type: string
completed first pass of content module
2021-12-28 05:07:43 +00:00
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/tags/{tagId}:
completed first pass of content module
2021-12-28 05:07:43 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Retrieve specified tag on the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
renamed index module to contact module
2021-12-31 06:01:08 +00:00
operationId: get-topic-tag
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
- name: tagId
in: path
description: specified tag id
required: true
schema:
type: string
responses:
'201':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: success
completed first pass of content module
2021-12-28 05:07:43 +00:00
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
completed first pass of content module
2021-12-28 05:07:43 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: tag, topic, or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
delete:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Remove specified tag from the topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
operationId: remove-topic-tag
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
- name: tagId
in: path
description: specified tag id
required: true
schema:
type: string
responses:
'200':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: success
completed first pass of content module
2021-12-28 05:07:43 +00:00
'401':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
completed first pass of content module
2021-12-28 05:07:43 +00:00
'404':
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: tag, topic, or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/assets:
completed first pass of content module
2021-12-28 05:07:43 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Get all assets associated with the specified topic. Authorization granted to account holder app token or dialogue member contact token who has access to the topic.
renamed index module to contact module
2021-12-31 06:01:08 +00:00
operationId: get-topic-assets
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
responses:
'201':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: success
completed first pass of content module
2021-12-28 05:07:43 +00:00
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Asset'
'401':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: permission denied
'404':
description: topic or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
post:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Add an asset to a topic. The asset will be processed and transcoded according to the specified transformation. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.
renamed index module to contact module
2021-12-31 06:01:08 +00:00
operationId: add-topic-asset
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
- name: transforms
in: query
description: transforms to apply
required: false
schema:
type: array
items:
type: string
responses:
'201':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: success
completed first pass of content module
2021-12-28 05:07:43 +00:00
content:
application/json:
schema:
$ref: '#/components/schemas/Asset'
'401':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
renamed index module to contact module
2021-12-31 06:01:08 +00:00
'404':
description: topic or dialogue not found
completed first pass of content module
2021-12-28 05:07:43 +00:00
'500':
description: internal server error
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
fileName:
type: string
format: binary
adding content module
2021-12-27 06:57:34 +00:00
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/assets/{assetId}:
completed first pass of content module
2021-12-28 05:07:43 +00:00
get:
tags:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Retrieve an asset associated with a topic. All transformed assets can be retrieved by anyone with access to the topic, but the original asset can only be retrieved by the author of the topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.
renamed index module to contact module
2021-12-31 06:01:08 +00:00
operationId: get-topic-asset
completed first pass of content module
2021-12-28 05:07:43 +00:00
security:
- bearerAuth: []
parameters:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- name: dialogueId
completed first pass of content module
2021-12-28 05:07:43 +00:00
in: path
first pass of conversation module
2021-12-29 05:49:51 +00:00
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
completed first pass of content module
2021-12-28 05:07:43 +00:00
required: true
schema:
type: string
- name: assetId
in: path
description: specified asset id
required: true
schema:
type: string
responses:
'200':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: success
completed first pass of content module
2021-12-28 05:07:43 +00:00
content:
application/octet-stream: #asset specific
schema:
type: string
format: binary
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: permission denied
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: asset, topic or dialogue not found
'500':
description: internal server error
delete:
tags:
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: Remove and delete an asset associated with a topic. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.
renamed index module to contact module
2021-12-31 06:01:08 +00:00
operationId: remove-topic-asset
security:
- bearerAuth: []
parameters:
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
- name: topicId
in: path
description: specified topic id
required: true
schema:
type: string
- name: assetId
in: path
description: specified asset id
required: true
schema:
type: string
responses:
'200':
description: success
'401':
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
renamed index module to contact module
2021-12-31 06:01:08 +00:00
'404':
description: asset, topic or dialogue not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
completed first pass of content module
2021-12-28 05:07:43 +00:00
renamed index module to contact module
2021-12-31 06:01:08 +00:00
/conversation/dialogues/{dialogueId}/topics/{topicId}/confirmed:
first pass of conversation module
2021-12-29 05:49:51 +00:00
put:
tags:
- conversation
adding conversation descriptions
2021-12-31 20:23:30 +00:00
description: After the assets have been uploaded and the subject has been set, the topic should be set to confirmed (true) to make the topic available to others. Authorization granted to account holder app token or dialogue member contact token who is also the creator of the topic.
first pass of conversation module
2021-12-29 05:49:51 +00:00
security:
- bearerAuth: []
parameters:
- name: dialogueId
in: path
description: specified dialogue id
required: true
schema:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- name: topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
in: path
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: specified topic id
first pass of conversation module
2021-12-29 05:49:51 +00:00
required: true
schema:
type: string
responses:
'200':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: success
first pass of conversation module
2021-12-29 05:49:51 +00:00
'401':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: permission denied
adding description to conversation module
2022-01-01 19:49:04 +00:00
'403':
description: inactive dialogue
first pass of conversation module
2021-12-29 05:49:51 +00:00
'404':
renamed index module to contact module
2021-12-31 06:01:08 +00:00
description: topic or dialogue not found
first pass of conversation module
2021-12-29 05:49:51 +00:00
'500':
description: internal server error
requestBody:
content:
application/json:
schema:
type: boolean
externalDocs:
description: Find out more about Swagger
url: 'http://swagger.io'
components:
schemas:
Announce:
adding content module
2021-12-27 06:57:34 +00:00
type: object
required:
first pass of conversation module
2021-12-29 05:49:51 +00:00
- appToken
adding content module
2021-12-27 06:57:34 +00:00
properties:
first pass of conversation module
2021-12-29 05:49:51 +00:00
appToken:
adding content module
2021-12-27 06:57:34 +00:00
type: string
starting api with swagger
2021-12-20 21:49:59 +00:00
Revsion:
type: object
required:
- profile
- content
adding description to content module
2022-01-02 00:29:58 +00:00
- view # revision increment on sharing changes
- share
- label
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- card
specifying contact module
2021-12-25 22:54:45 +00:00
- blocked
starting api with swagger
2021-12-20 21:49:59 +00:00
- dialogue
- insight
properties:
profile:
type: integer
format: int64
content:
type: integer
format: int64
labels:
type: integer
format: int64
sharing:
type: integer
format: int64
renamed index module to contact module
2021-12-31 06:01:08 +00:00
card:
starting api with swagger
2021-12-20 21:49:59 +00:00
type: integer
format: int64
dialogue:
type: integer
format: int64
insight:
type: integer
format: int64
Profile:
type: object
required:
- guid
- revision
- node
properties:
added registry module
2021-12-21 08:13:48 +00:00
guid:
type: string
added profile module
2021-12-21 22:47:10 +00:00
handle:
type: string
name:
type: string
description:
type: string
location:
type: string
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
image:
type: string
format: base64 encoded data
added registry module
2021-12-21 08:13:48 +00:00
revision:
type: integer
format: int64
node:
type: string
ProfileData:
type: object
properties:
handle:
starting api with swagger
2021-12-20 21:49:59 +00:00
type: string
name:
type: string
description:
type: string
location:
type: string
added profile module
2021-12-21 22:47:10 +00:00
image:
type: string
added registry module
2021-12-21 08:13:48 +00:00
App:
type: object
required:
- appId
- appData
- attached
properties:
appId:
type: string
appData:
$ref: '#/components/schemas/AppData'
attached:
starting api with swagger
2021-12-20 21:49:59 +00:00
type: integer
added registry module
2021-12-21 08:13:48 +00:00
format: int32
AppData:
type: object
properties:
name:
starting api with swagger
2021-12-20 21:49:59 +00:00
type: string
added registry module
2021-12-21 08:13:48 +00:00
description:
type: string
url:
type: string
image:
type: string
format: base64 encoded image
adding description to conversation module
2022-01-01 19:49:04 +00:00
CardView:
adding contact module
2021-12-24 22:59:24 +00:00
type: object
required:
- guid
- profileRevision
- contentRevision
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- cardRevision
adding contact module
2021-12-24 22:59:24 +00:00
properties:
guid:
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
cardRevision:
adding contact module
2021-12-24 22:59:24 +00:00
type: integer
format: int64
profileRevision:
type: integer
format: int64
contentRevision:
type: integer
format: int64
converstaionRevision:
type: integer
format: int64
adding description to conversation module
2022-01-01 19:49:04 +00:00
CardProfile:
adding contact module
2021-12-24 22:59:24 +00:00
type: object
required:
specifying contact module
2021-12-25 22:54:45 +00:00
- node
adding contact module
2021-12-24 22:59:24 +00:00
properties:
handle:
type: string
name:
type: string
description:
type: string
location:
type: string
specifying contact module
2021-12-25 22:54:45 +00:00
revision:
type: integer
format: int64
adding contact module
2021-12-24 22:59:24 +00:00
imageSet:
type: boolean
node:
type: string
specifying contact module
2021-12-25 22:54:45 +00:00
adding description to conversation module
2022-01-01 19:49:04 +00:00
CardData:
specifying contact module
2021-12-25 22:54:45 +00:00
type: object
required:
- status
properties:
revision:
adding contact module
2021-12-24 22:59:24 +00:00
type: integer
format: int64
status:
type: string
enum: [ pending, confirmed, connecting, connected ]
first pass of conversation module
2021-12-29 05:49:51 +00:00
details:
adding contact module
2021-12-24 22:59:24 +00:00
type: string
token:
type: string
groups:
type: array
items:
type: string
specifying contact module
2021-12-25 22:54:45 +00:00
adding description to conversation module
2022-01-01 19:49:04 +00:00
CardStatus:
specifying contact module
2021-12-25 22:54:45 +00:00
type: object
required:
- status
properties:
status:
type: string
enum: [ pending, confirmed, connecting, connected ]
token:
type: string
adding description to conversation module
2022-01-01 19:49:04 +00:00
Card:
specifying contact module
2021-12-25 22:54:45 +00:00
type: object
required:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- cardProfile
- cardData
specifying contact module
2021-12-25 22:54:45 +00:00
- contentRevision
- conversationRevision
properties:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
cardProfile:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardProfile'
renamed index module to contact module
2021-12-31 06:01:08 +00:00
cardData:
adding description to conversation module
2022-01-01 19:49:04 +00:00
$ref: '#/components/schemas/CardData'
specifying contact module
2021-12-25 22:54:45 +00:00
contentRevision:
type: integer
format: int64
converstaionRevision:
type: integer
format: int64
adding contact module
2021-12-24 22:59:24 +00:00
first pass of conversation module
2021-12-29 05:49:51 +00:00
Subject:
type: object
required:
- postId
- revision
- type
- data
- created
- modified
properties:
postId:
type: string
revision:
type: integer
format: int64
type:
type: string
data:
type: string
created:
type: integer
format: int32
Asset:
type: object
required:
- assetId
properties:
assetId:
type: string
transform:
type: string
status:
type: string
enum: [ pending, processing, ready, error ]
Tag:
type: object
required:
- guid
- subject
properties:
guid:
type: string
subject:
$ref: '#/components/schemas/Subject'
Insight:
type: object
required:
- insightId
- revision
- guid
adding description to conversation module
2022-01-01 19:49:04 +00:00
- status
first pass of conversation module
2021-12-29 05:49:51 +00:00
properties:
insightId:
type: string
revision:
type: integer
format: int64
guid:
type: string
adding description to conversation module
2022-01-01 19:49:04 +00:00
status:
type: string
enum: [ active, inactive, dismissed ]
first pass of conversation module
2021-12-29 05:49:51 +00:00
Dialogue:
type: object
required:
- dialogueId
- revision
adding description to conversation module
2022-01-01 19:49:04 +00:00
- active
first pass of conversation module
2021-12-29 05:49:51 +00:00
- subject
- insights
properties:
dialogueId:
type: string
revision:
type: integer
format: int64
active:
type: boolean
subject:
$ref: '#/components/schemas/Subject'
insights:
type: array
items:
type: object
properties:
guid:
type: string
status:
type: string
adding description to conversation module
2022-01-01 19:49:04 +00:00
enum: [ active, offsync, inactive, dismissed ]
first pass of conversation module
2021-12-29 05:49:51 +00:00
renamed index module to contact module
2021-12-31 06:01:08 +00:00
Topic:
first pass of conversation module
2021-12-29 05:49:51 +00:00
type: object
required:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
- topicId
first pass of conversation module
2021-12-29 05:49:51 +00:00
- revision
- status
- subject
- tagCount
- tagUpdated
- tagRevision
properties:
articleId:
type: string
revision:
type: integer
format: int64
status:
type: string
enum: [ unconfirmed, confirmed, complete, error ]
subject:
$ref: '#/components/schemas/Subject'
tagCount:
type: integer
format: int32
tagUpdate:
type: integer
format: int32
tagRevision:
type: integer
format: int64
Article:
type: object
required:
- articleId
- revision
- status
- subject
- labels
- tagCount
- tagUpdated
- tagRevision
properties:
articleId:
type: string
revision:
type: integer
format: int64
status:
type: string
enum: [ unconfirmed, confirmed, complete, error ]
subject:
$ref: '#/components/schemas/Subject'
labels:
type: array
items:
type: string
adding description to content module
2022-01-02 00:29:58 +00:00
groups: # present only in account holder responses
first pass of conversation module
2021-12-29 05:49:51 +00:00
type: array
items:
type: string
tagCount:
type: integer
format: int32
tagUpdate:
type: integer
format: int32
tagRevision:
type: integer
format: int64
Note:
type: object
required:
- noteId
- guid
- revision
- status
- subject
- tagCount
- tagUpdated
- tagRevision
properties:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
topicId:
first pass of conversation module
2021-12-29 05:49:51 +00:00
type: string
guid:
type: string
revision:
type: integer
format: int64
status:
type: string
enum: [ unconfirmed, confirmed, complete, error ]
subject:
$ref: '#/components/schemas/Subject'
tagCount:
type: integer
format: int32
tagUpdate:
type: integer
format: int32
tagRevision:
type: integer
format: int64
adding contact module
2021-12-24 22:59:24 +00:00
Group:
type: object
required:
- groupId
- name
properties:
groupId:
type: string
name:
type: string
preparing for content module
2021-12-26 07:19:25 +00:00
Label:
type: object
required:
- labelId
- name
properties:
labelId:
type: string
name:
type: string
adding contact module
2021-12-24 22:59:24 +00:00
preparing for contact module
2021-12-22 05:50:25 +00:00
Authenticate:
type: object
required:
- guid
- token
- timestamp
properties:
token:
type: string
timestamp:
type: integer
format: int32
Connect:
type: object
required:
- requestorId
- requestedId
- timestamp
- profile
- token
- contentRevision
properties:
renamed index module to contact module
2021-12-31 06:01:08 +00:00
requestorGuid:
preparing for contact module
2021-12-22 05:50:25 +00:00
type: string
renamed index module to contact module
2021-12-31 06:01:08 +00:00
requestedGuid:
preparing for contact module
2021-12-22 05:50:25 +00:00
type: string
timestamp:
type: integer
format: int32
profile:
$ref: '#/components/schemas/Profile'
token:
type: string
contentRevision:
type: integer
format: int64
Disconnect:
type: object
required:
- requestorId
- requestedId
- timestamp
properties:
requestorId:
type: string
requestedId:
type: string
timestamp:
type: integer
format: int32
added registry module
2021-12-21 08:13:48 +00:00
DataMessage:
type: object
required:
- message
- messageType
- keyType
- publicKey
- signature
properties:
split portal module into admin & account
2021-12-21 22:08:18 +00:00
messageType:
added registry module
2021-12-21 08:13:48 +00:00
type: string
added profile image endpoint to registry module
2021-12-21 18:55:05 +00:00
enum: [Connect, Disconnect, Profile, Authenticate]
added registry module
2021-12-21 08:13:48 +00:00
message:
type: string
format: base64 encoded object
keyType:
type: string
enum: [RSA4096, RSA2048]
publicKey:
type: string
format: base64 encoding of account key
split portal module into admin & account
2021-12-21 22:08:18 +00:00
signature:
type: string
format: base64 encoding of message signature
added registry module
2021-12-21 08:13:48 +00:00
preparing for contact module
2021-12-22 05:50:25 +00:00
starting api with swagger
2021-12-20 21:49:59 +00:00
securitySchemes:
basicAuth:
type: http
scheme: basic
bearerAuth:
type: http
scheme: bearer
Reference in New Issue Copy Permalink