2021-02-17 21:29:20 +02:00
|
|
|
basePath: /api/v1
|
|
|
|
consumes:
|
|
|
|
- application/json
|
|
|
|
definitions:
|
|
|
|
Block:
|
|
|
|
description: Block is the basic data unit
|
|
|
|
properties:
|
2022-03-22 16:24:34 +02:00
|
|
|
boardId:
|
|
|
|
description: The board id that the block belongs to
|
|
|
|
type: string
|
|
|
|
x-go-name: BoardID
|
2021-02-17 21:29:20 +02:00
|
|
|
createAt:
|
|
|
|
description: The creation time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: CreateAt
|
2021-08-06 14:10:24 +02:00
|
|
|
createdBy:
|
|
|
|
description: The id for user who created this block
|
|
|
|
type: string
|
|
|
|
x-go-name: CreatedBy
|
2021-02-17 21:29:20 +02:00
|
|
|
deleteAt:
|
|
|
|
description: The deleted time. Set to indicate this block is deleted
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: DeleteAt
|
|
|
|
fields:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: The block fields
|
|
|
|
type: object
|
|
|
|
x-go-name: Fields
|
|
|
|
id:
|
|
|
|
description: The id for this block
|
|
|
|
type: string
|
|
|
|
x-go-name: ID
|
|
|
|
modifiedBy:
|
|
|
|
description: The id for user who last modified this block
|
|
|
|
type: string
|
|
|
|
x-go-name: ModifiedBy
|
|
|
|
parentId:
|
|
|
|
description: The id for this block's parent block. Empty for root blocks
|
|
|
|
type: string
|
|
|
|
x-go-name: ParentID
|
|
|
|
schema:
|
|
|
|
description: The schema version of this block
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: Schema
|
|
|
|
title:
|
|
|
|
description: The display title
|
|
|
|
type: string
|
|
|
|
x-go-name: Title
|
|
|
|
type:
|
2021-12-15 21:54:23 +02:00
|
|
|
$ref: '#/definitions/BlockType'
|
2021-02-17 21:29:20 +02:00
|
|
|
updateAt:
|
|
|
|
description: The last modified time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: UpdateAt
|
|
|
|
required:
|
|
|
|
- id
|
2021-08-06 14:10:24 +02:00
|
|
|
- createdBy
|
2021-02-17 21:29:20 +02:00
|
|
|
- modifiedBy
|
|
|
|
- schema
|
|
|
|
- type
|
|
|
|
- createAt
|
|
|
|
- updateAt
|
2022-03-22 16:24:34 +02:00
|
|
|
- boardId
|
2021-02-17 21:29:20 +02:00
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-08-06 14:10:24 +02:00
|
|
|
BlockPatch:
|
|
|
|
description: BlockPatch is a patch for modify blocks
|
|
|
|
properties:
|
2022-03-22 16:24:34 +02:00
|
|
|
boardId:
|
|
|
|
description: The board id that the block belongs to
|
|
|
|
type: string
|
|
|
|
x-go-name: BoardID
|
2021-08-06 14:10:24 +02:00
|
|
|
deletedFields:
|
|
|
|
description: The block removed fields
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: DeletedFields
|
|
|
|
parentId:
|
|
|
|
description: The id for this block's parent block. Empty for root blocks
|
|
|
|
type: string
|
|
|
|
x-go-name: ParentID
|
|
|
|
schema:
|
|
|
|
description: The schema version of this block
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: Schema
|
|
|
|
title:
|
|
|
|
description: The display title
|
|
|
|
type: string
|
|
|
|
x-go-name: Title
|
|
|
|
type:
|
2021-12-15 21:54:23 +02:00
|
|
|
$ref: '#/definitions/BlockType'
|
2021-08-06 14:10:24 +02:00
|
|
|
updatedFields:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: The block updated fields
|
|
|
|
type: object
|
|
|
|
x-go-name: UpdatedFields
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-12-15 21:54:23 +02:00
|
|
|
BlockPatchBatch:
|
|
|
|
description: BlockPatchBatch is a batch of IDs and patches for modify blocks
|
|
|
|
properties:
|
|
|
|
block_ids:
|
|
|
|
description: The id's for of the blocks to patch
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: BlockIDs
|
|
|
|
block_patches:
|
|
|
|
description: The BlockPatches to be applied
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/BlockPatch'
|
|
|
|
type: array
|
|
|
|
x-go-name: BlockPatches
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
BlockType:
|
|
|
|
title: BlockType represents a block type.
|
|
|
|
type: string
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2022-03-22 16:24:34 +02:00
|
|
|
Board:
|
|
|
|
description: Board groups a set of blocks and its layout
|
|
|
|
properties:
|
|
|
|
cardProperties:
|
|
|
|
description: The properties of the board cards
|
|
|
|
items:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
type: object
|
|
|
|
type: array
|
|
|
|
x-go-name: CardProperties
|
|
|
|
channelId:
|
|
|
|
description: The ID of the channel that the board was created from
|
|
|
|
type: string
|
|
|
|
x-go-name: ChannelID
|
|
|
|
columnCalculations:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: The calculations on the board's cards
|
|
|
|
type: object
|
|
|
|
x-go-name: ColumnCalculations
|
|
|
|
createAt:
|
|
|
|
description: The creation time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: CreateAt
|
|
|
|
createdBy:
|
|
|
|
description: The ID of the user that created the board
|
|
|
|
type: string
|
|
|
|
x-go-name: CreatedBy
|
|
|
|
deleteAt:
|
|
|
|
description: The deleted time. Set to indicate this block is deleted
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: DeleteAt
|
|
|
|
description:
|
|
|
|
description: The description of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Description
|
|
|
|
icon:
|
|
|
|
description: The icon of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Icon
|
|
|
|
id:
|
|
|
|
description: The ID for the board
|
|
|
|
type: string
|
|
|
|
x-go-name: ID
|
|
|
|
isTemplate:
|
|
|
|
description: Marks the template boards
|
|
|
|
type: boolean
|
|
|
|
x-go-name: IsTemplate
|
|
|
|
modifiedBy:
|
|
|
|
description: The ID of the last user that updated the board
|
|
|
|
type: string
|
|
|
|
x-go-name: ModifiedBy
|
|
|
|
properties:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: The properties of the board
|
|
|
|
type: object
|
|
|
|
x-go-name: Properties
|
|
|
|
showDescription:
|
|
|
|
description: Indicates if the board shows the description on the interface
|
|
|
|
type: boolean
|
|
|
|
x-go-name: ShowDescription
|
|
|
|
teamId:
|
|
|
|
description: The ID of the team that the board belongs to
|
|
|
|
type: string
|
|
|
|
x-go-name: TeamID
|
|
|
|
templateVersion:
|
|
|
|
description: Marks the template boards
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: TemplateVersion
|
|
|
|
title:
|
|
|
|
description: The title of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Title
|
|
|
|
type:
|
|
|
|
$ref: '#/definitions/BoardType'
|
|
|
|
updateAt:
|
|
|
|
description: The last modified time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: UpdateAt
|
|
|
|
required:
|
|
|
|
- id
|
|
|
|
- teamId
|
|
|
|
- createdBy
|
|
|
|
- modifiedBy
|
|
|
|
- type
|
|
|
|
- createAt
|
|
|
|
- updateAt
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
BoardMember:
|
|
|
|
description: BoardMember stores the information of the membership of a user on a board
|
|
|
|
properties:
|
|
|
|
boardId:
|
|
|
|
description: The ID of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: BoardID
|
|
|
|
roles:
|
|
|
|
description: The independent roles of the user on the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Roles
|
|
|
|
schemeAdmin:
|
|
|
|
description: Marks the user as an admin of the board
|
|
|
|
type: boolean
|
|
|
|
x-go-name: SchemeAdmin
|
|
|
|
schemeCommenter:
|
|
|
|
description: Marks the user as an commenter of the board
|
|
|
|
type: boolean
|
|
|
|
x-go-name: SchemeCommenter
|
|
|
|
schemeEditor:
|
|
|
|
description: Marks the user as an editor of the board
|
|
|
|
type: boolean
|
|
|
|
x-go-name: SchemeEditor
|
|
|
|
schemeViewer:
|
|
|
|
description: Marks the user as an viewer of the board
|
|
|
|
type: boolean
|
|
|
|
x-go-name: SchemeViewer
|
|
|
|
userId:
|
|
|
|
description: The ID of the user
|
|
|
|
type: string
|
|
|
|
x-go-name: UserID
|
|
|
|
required:
|
|
|
|
- boardId
|
|
|
|
- userId
|
|
|
|
- schemeAdmin
|
|
|
|
- schemeEditor
|
|
|
|
- schemeCommenter
|
|
|
|
- schemeViewer
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
BoardPatch:
|
|
|
|
description: BoardPatch is a patch for modify boards
|
|
|
|
properties:
|
|
|
|
deletedCardProperties:
|
|
|
|
description: The board removed card properties
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: DeletedCardProperties
|
|
|
|
deletedColumnCalculations:
|
|
|
|
description: The board deleted column calculations
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: DeletedColumnCalculations
|
|
|
|
deletedProperties:
|
|
|
|
description: The board removed properties
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: DeletedProperties
|
|
|
|
description:
|
|
|
|
description: The description of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Description
|
|
|
|
icon:
|
|
|
|
description: The icon of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Icon
|
|
|
|
showDescription:
|
|
|
|
description: Indicates if the board shows the description on the interface
|
|
|
|
type: boolean
|
|
|
|
x-go-name: ShowDescription
|
|
|
|
title:
|
|
|
|
description: The title of the board
|
|
|
|
type: string
|
|
|
|
x-go-name: Title
|
|
|
|
type:
|
|
|
|
$ref: '#/definitions/BoardType'
|
|
|
|
updatedCardProperties:
|
|
|
|
description: The board updated card properties
|
|
|
|
items:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
type: object
|
|
|
|
type: array
|
|
|
|
x-go-name: UpdatedCardProperties
|
|
|
|
updatedColumnCalculations:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: The board updated column calculations
|
|
|
|
type: object
|
|
|
|
x-go-name: UpdatedColumnCalculations
|
|
|
|
updatedProperties:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: The board updated properties
|
|
|
|
type: object
|
|
|
|
x-go-name: UpdatedProperties
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
BoardType:
|
|
|
|
type: string
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
BoardsAndBlocks:
|
|
|
|
description: |-
|
|
|
|
BoardsAndBlocks is used to operate over boards and blocks at the
|
|
|
|
same time
|
|
|
|
properties:
|
|
|
|
blocks:
|
|
|
|
description: The blocks
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
|
|
|
x-go-name: Blocks
|
|
|
|
boards:
|
|
|
|
description: The boards
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Board'
|
|
|
|
type: array
|
|
|
|
x-go-name: Boards
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-02-17 21:29:20 +02:00
|
|
|
ChangePasswordRequest:
|
|
|
|
description: ChangePasswordRequest is a user password change request
|
|
|
|
properties:
|
|
|
|
newPassword:
|
|
|
|
description: New password
|
|
|
|
type: string
|
|
|
|
x-go-name: NewPassword
|
|
|
|
oldPassword:
|
|
|
|
description: Old password
|
|
|
|
type: string
|
|
|
|
x-go-name: OldPassword
|
|
|
|
required:
|
|
|
|
- oldPassword
|
|
|
|
- newPassword
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/api
|
2022-03-22 16:24:34 +02:00
|
|
|
DeleteBoardsAndBlocks:
|
|
|
|
description: |-
|
|
|
|
DeleteBoardsAndBlocks is used to list the boards and blocks to
|
|
|
|
delete on a request
|
|
|
|
properties:
|
|
|
|
blocks:
|
|
|
|
description: The blocks
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: Blocks
|
|
|
|
boards:
|
|
|
|
description: The boards
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: Boards
|
|
|
|
required:
|
|
|
|
- boards
|
|
|
|
- blocks
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-02-17 21:29:20 +02:00
|
|
|
ErrorResponse:
|
|
|
|
description: ErrorResponse is an error response
|
|
|
|
properties:
|
|
|
|
error:
|
|
|
|
description: The error message
|
|
|
|
type: string
|
|
|
|
x-go-name: Error
|
2021-03-26 20:01:54 +02:00
|
|
|
errorCode:
|
|
|
|
description: The error code
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: ErrorCode
|
2021-02-17 21:29:20 +02:00
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
FileUploadResponse:
|
|
|
|
description: FileUploadResponse is the response to a file upload
|
|
|
|
properties:
|
2021-02-23 21:42:28 +02:00
|
|
|
fileId:
|
|
|
|
description: The FileID to retrieve the uploaded file
|
2021-02-17 21:29:20 +02:00
|
|
|
type: string
|
2021-02-23 21:42:28 +02:00
|
|
|
x-go-name: FileID
|
2021-02-17 21:29:20 +02:00
|
|
|
required:
|
2021-02-23 21:42:28 +02:00
|
|
|
- fileId
|
2021-02-17 21:29:20 +02:00
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/api
|
|
|
|
LoginRequest:
|
|
|
|
description: LoginRequest is a login request
|
|
|
|
properties:
|
|
|
|
email:
|
|
|
|
description: If specified, login using email
|
|
|
|
type: string
|
|
|
|
x-go-name: Email
|
|
|
|
password:
|
|
|
|
description: Password
|
|
|
|
type: string
|
|
|
|
x-go-name: Password
|
|
|
|
type:
|
|
|
|
description: Type of login, currently must be set to "normal"
|
|
|
|
type: string
|
|
|
|
x-go-name: Type
|
|
|
|
username:
|
|
|
|
description: If specified, login using username
|
|
|
|
type: string
|
|
|
|
x-go-name: Username
|
|
|
|
required:
|
|
|
|
- type
|
|
|
|
- password
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/api
|
|
|
|
LoginResponse:
|
|
|
|
description: LoginResponse is a login response
|
|
|
|
properties:
|
|
|
|
token:
|
|
|
|
description: Session token
|
|
|
|
type: string
|
|
|
|
x-go-name: Token
|
|
|
|
required:
|
|
|
|
- token
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/api
|
2021-12-15 21:54:23 +02:00
|
|
|
NotificationHint:
|
|
|
|
description: |-
|
|
|
|
NotificationHint provides a hint that a block has been modified and has subscribers that
|
|
|
|
should be notified.
|
|
|
|
properties:
|
|
|
|
block_id:
|
|
|
|
description: BlockID is id of the entity that was updated
|
|
|
|
type: string
|
|
|
|
x-go-name: BlockID
|
|
|
|
block_type:
|
|
|
|
$ref: '#/definitions/BlockType'
|
|
|
|
create_at:
|
|
|
|
description: CreatedAt is the timestamp this notification hint was created
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: CreateAt
|
|
|
|
modified_by_id:
|
|
|
|
description: ModifiedByID is the id of the user who made the block change
|
|
|
|
type: string
|
|
|
|
x-go-name: ModifiedByID
|
|
|
|
notify_at:
|
|
|
|
description: NotifyAt is the timestamp this notification should be scheduled
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: NotifyAt
|
|
|
|
required:
|
|
|
|
- block_type
|
|
|
|
- block_id
|
|
|
|
- create_at
|
|
|
|
- notify_at
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2022-03-22 16:24:34 +02:00
|
|
|
PatchBoardsAndBlocks:
|
|
|
|
description: |-
|
|
|
|
PatchBoardsAndBlocks is used to patch multiple boards and blocks on
|
|
|
|
a single request
|
|
|
|
properties:
|
|
|
|
blockIDs:
|
|
|
|
description: The block IDs to patch
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: BlockIDs
|
|
|
|
blockPatches:
|
|
|
|
description: The block patches
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/BlockPatch'
|
|
|
|
type: array
|
|
|
|
x-go-name: BlockPatches
|
|
|
|
boardIDs:
|
|
|
|
description: The board IDs to patch
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: BoardIDs
|
|
|
|
boardPatches:
|
|
|
|
description: The board patches
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/BoardPatch'
|
|
|
|
type: array
|
|
|
|
x-go-name: BoardPatches
|
|
|
|
required:
|
|
|
|
- boardIDs
|
|
|
|
- boardPatches
|
|
|
|
- blockIDs
|
|
|
|
- blockPatches
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-02-17 21:29:20 +02:00
|
|
|
RegisterRequest:
|
|
|
|
description: RegisterRequest is a user registration request
|
|
|
|
properties:
|
|
|
|
email:
|
|
|
|
description: User's email
|
|
|
|
type: string
|
|
|
|
x-go-name: Email
|
|
|
|
password:
|
|
|
|
description: Password
|
|
|
|
type: string
|
|
|
|
x-go-name: Password
|
|
|
|
token:
|
|
|
|
description: Registration authorization token
|
|
|
|
type: string
|
|
|
|
x-go-name: Token
|
|
|
|
username:
|
|
|
|
description: User name
|
|
|
|
type: string
|
|
|
|
x-go-name: Username
|
|
|
|
required:
|
|
|
|
- username
|
|
|
|
- email
|
|
|
|
- password
|
|
|
|
- token
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/api
|
|
|
|
Sharing:
|
|
|
|
description: Sharing is sharing information for a root block
|
|
|
|
properties:
|
|
|
|
enabled:
|
|
|
|
description: Is sharing enabled
|
|
|
|
type: boolean
|
|
|
|
x-go-name: Enabled
|
|
|
|
id:
|
|
|
|
description: ID of the root block
|
|
|
|
type: string
|
|
|
|
x-go-name: ID
|
|
|
|
modifiedBy:
|
|
|
|
description: ID of the user who last modified this
|
|
|
|
type: string
|
|
|
|
x-go-name: ModifiedBy
|
|
|
|
token:
|
|
|
|
description: Access token
|
|
|
|
type: string
|
|
|
|
x-go-name: Token
|
|
|
|
update_at:
|
|
|
|
description: Updated time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: UpdateAt
|
|
|
|
required:
|
|
|
|
- id
|
|
|
|
- enabled
|
|
|
|
- token
|
|
|
|
- modifiedBy
|
|
|
|
- update_at
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-12-15 21:54:23 +02:00
|
|
|
Subscriber:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Subscriber is an entity (e.g. user, channel) that can subscribe to events from boards, cards, etc
|
2021-12-15 21:54:23 +02:00
|
|
|
properties:
|
|
|
|
notified_at:
|
|
|
|
description: NotifiedAt is the timestamp this subscriber was last notified
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: NotifiedAt
|
|
|
|
subscriber_id:
|
|
|
|
description: SubscriberID is the id of the entity that is subscribing
|
|
|
|
type: string
|
|
|
|
x-go-name: SubscriberID
|
|
|
|
subscriber_type:
|
|
|
|
$ref: '#/definitions/SubscriberType'
|
|
|
|
required:
|
|
|
|
- subscriber_type
|
|
|
|
- subscriber_id
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
SubscriberType:
|
|
|
|
type: string
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
Subscription:
|
|
|
|
properties:
|
|
|
|
blockId:
|
|
|
|
description: BlockID is id of the entity being subscribed to
|
|
|
|
type: string
|
|
|
|
x-go-name: BlockID
|
|
|
|
blockType:
|
|
|
|
$ref: '#/definitions/BlockType'
|
|
|
|
createAt:
|
|
|
|
description: CreatedAt is the timestamp this subscription was created
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: CreateAt
|
|
|
|
deleteAt:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: DeleteAt is the timestamp this subscription was deleted, or zero if not deleted
|
2021-12-15 21:54:23 +02:00
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: DeleteAt
|
|
|
|
notifiedAt:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: NotifiedAt is the timestamp of the last notification sent for this subscription
|
2021-12-15 21:54:23 +02:00
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: NotifiedAt
|
|
|
|
subscriberId:
|
|
|
|
description: SubscriberID is the id of the entity that is subscribing
|
|
|
|
type: string
|
|
|
|
x-go-name: SubscriberID
|
|
|
|
subscriberType:
|
|
|
|
$ref: '#/definitions/SubscriberType'
|
|
|
|
required:
|
|
|
|
- blockType
|
|
|
|
- blockId
|
|
|
|
- subscriberType
|
|
|
|
- subscriberId
|
|
|
|
- notifiedAt
|
|
|
|
- createAt
|
|
|
|
- deleteAt
|
|
|
|
title: Subscription is a subscription to a board, card, etc, for a user or channel.
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2022-03-22 16:24:34 +02:00
|
|
|
Team:
|
|
|
|
description: Team is information global to a team
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
description: ID of the team
|
|
|
|
type: string
|
|
|
|
x-go-name: ID
|
|
|
|
modifiedBy:
|
|
|
|
description: ID of user who last modified this
|
|
|
|
type: string
|
|
|
|
x-go-name: ModifiedBy
|
|
|
|
settings:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: Team settings
|
|
|
|
type: object
|
|
|
|
x-go-name: Settings
|
|
|
|
signupToken:
|
|
|
|
description: Token required to register new users
|
|
|
|
type: string
|
|
|
|
x-go-name: SignupToken
|
|
|
|
title:
|
|
|
|
description: Title of the team
|
|
|
|
type: string
|
|
|
|
x-go-name: Title
|
|
|
|
updateAt:
|
|
|
|
description: Updated time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: UpdateAt
|
|
|
|
required:
|
|
|
|
- id
|
|
|
|
- signupToken
|
|
|
|
- modifiedBy
|
|
|
|
- updateAt
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2021-02-17 21:29:20 +02:00
|
|
|
User:
|
|
|
|
description: User is a user
|
|
|
|
properties:
|
|
|
|
create_at:
|
|
|
|
description: Created time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: CreateAt
|
|
|
|
delete_at:
|
|
|
|
description: Deleted time, set to indicate user is deleted
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: DeleteAt
|
|
|
|
id:
|
|
|
|
description: The user ID
|
|
|
|
type: string
|
|
|
|
x-go-name: ID
|
2021-12-15 21:54:23 +02:00
|
|
|
is_bot:
|
|
|
|
description: If the user is a bot or not
|
|
|
|
type: boolean
|
|
|
|
x-go-name: IsBot
|
2021-02-17 21:29:20 +02:00
|
|
|
props:
|
|
|
|
additionalProperties:
|
|
|
|
type: object
|
|
|
|
description: User settings
|
|
|
|
type: object
|
|
|
|
x-go-name: Props
|
|
|
|
update_at:
|
|
|
|
description: Updated time
|
|
|
|
format: int64
|
|
|
|
type: integer
|
|
|
|
x-go-name: UpdateAt
|
|
|
|
username:
|
|
|
|
description: The user name
|
|
|
|
type: string
|
|
|
|
x-go-name: Username
|
|
|
|
required:
|
|
|
|
- id
|
|
|
|
- username
|
|
|
|
- props
|
|
|
|
- create_at
|
|
|
|
- update_at
|
|
|
|
- delete_at
|
2021-12-15 21:54:23 +02:00
|
|
|
- is_bot
|
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
2022-03-22 16:24:34 +02:00
|
|
|
UserPropPatch:
|
|
|
|
description: UserPropPatch is a user property patch
|
2021-02-17 21:29:20 +02:00
|
|
|
properties:
|
2022-03-22 16:24:34 +02:00
|
|
|
deletedFields:
|
|
|
|
description: The user prop removed fields
|
|
|
|
items:
|
|
|
|
type: string
|
|
|
|
type: array
|
|
|
|
x-go-name: DeletedFields
|
|
|
|
updatedFields:
|
2021-02-17 21:29:20 +02:00
|
|
|
additionalProperties:
|
2022-03-22 16:24:34 +02:00
|
|
|
type: string
|
|
|
|
description: The user prop updated fields
|
2021-02-17 21:29:20 +02:00
|
|
|
type: object
|
2022-03-22 16:24:34 +02:00
|
|
|
x-go-name: UpdatedFields
|
2021-02-17 21:29:20 +02:00
|
|
|
type: object
|
|
|
|
x-go-package: github.com/mattermost/focalboard/server/model
|
|
|
|
host: localhost
|
|
|
|
info:
|
|
|
|
contact:
|
|
|
|
email: api@focalboard.com
|
|
|
|
name: Focalboard
|
|
|
|
url: https://www.focalboard.com
|
2021-12-15 21:54:23 +02:00
|
|
|
description: Focalboard Server
|
2021-02-17 21:29:20 +02:00
|
|
|
license:
|
|
|
|
name: Custom
|
|
|
|
url: https://github.com/mattermost/focalboard/blob/main/LICENSE.txt
|
|
|
|
title: Focalboard Server
|
2021-03-08 19:36:14 +02:00
|
|
|
version: 1.0.0
|
2021-02-17 21:29:20 +02:00
|
|
|
paths:
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards:
|
2021-02-17 21:29:20 +02:00
|
|
|
post:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Creates a new board
|
|
|
|
operationId: createBoard
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: the board to create
|
2021-02-17 21:29:20 +02:00
|
|
|
in: body
|
2022-03-22 16:24:34 +02:00
|
|
|
name: Body
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/Board'
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2021-03-26 20:01:54 +02:00
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/Board'
|
|
|
|
default:
|
2021-02-17 21:29:20 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
2022-03-22 16:24:34 +02:00
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/boards-and-blocks:
|
|
|
|
delete:
|
|
|
|
description: Deletes boards and blocks
|
|
|
|
operationId: deleteBoardsAndBlocks
|
|
|
|
parameters:
|
|
|
|
- description: the boards and blocks to delete
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/DeleteBoardsAndBlocks'
|
2021-12-15 21:54:23 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2022-03-22 16:24:34 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
patch:
|
|
|
|
description: Patches a set of related boards and blocks
|
|
|
|
operationId: patchBoardsAndBlocks
|
|
|
|
parameters:
|
|
|
|
- description: the patches for the boards and blocks
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/PatchBoardsAndBlocks'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardsAndBlocks'
|
|
|
|
default:
|
2021-12-15 21:54:23 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2021-03-26 20:01:54 +02:00
|
|
|
post:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Creates new boards and blocks
|
|
|
|
operationId: insertBoardsAndBlocks
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: the boards and blocks to create
|
2021-03-26 20:01:54 +02:00
|
|
|
in: body
|
2022-03-22 16:24:34 +02:00
|
|
|
name: Body
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
2021-03-26 20:01:54 +02:00
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/BoardsAndBlocks'
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2022-03-22 16:24:34 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardsAndBlocks'
|
|
|
|
default:
|
2021-02-17 21:29:20 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
2022-03-22 16:24:34 +02:00
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/boards/{boardID}:
|
|
|
|
delete:
|
|
|
|
description: Removes a board
|
|
|
|
operationId: deleteBoard
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-02-17 21:29:20 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
get:
|
|
|
|
description: Returns a board
|
|
|
|
operationId: getBoard
|
2021-03-26 20:01:54 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/Board'
|
|
|
|
default:
|
2021-02-17 21:29:20 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
patch:
|
|
|
|
description: Partially updates a board
|
|
|
|
operationId: patchBoard
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: board patch to apply
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardPatch'
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2021-03-26 20:01:54 +02:00
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/Board'
|
2021-02-17 21:29:20 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/archive/export:
|
2021-03-26 20:01:54 +02:00
|
|
|
get:
|
2022-03-22 16:24:34 +02:00
|
|
|
operationId: archiveExportBoard
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Id of board to export
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
summary: Exports an archive of all blocks for one boards.
|
|
|
|
/api/v1/boards/{boardID}/archive/import:
|
2021-03-30 01:27:35 +02:00
|
|
|
post:
|
|
|
|
consumes:
|
|
|
|
- multipart/form-data
|
2022-03-22 16:24:34 +02:00
|
|
|
operationId: archiveImport
|
2021-03-30 01:27:35 +02:00
|
|
|
parameters:
|
|
|
|
- description: Workspace ID
|
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-30 01:27:35 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: archive file to import
|
2021-03-30 01:27:35 +02:00
|
|
|
in: formData
|
2022-03-22 16:24:34 +02:00
|
|
|
name: file
|
|
|
|
required: true
|
2021-03-30 01:27:35 +02:00
|
|
|
type: file
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
summary: Import an archive of boards.
|
|
|
|
/api/v1/boards/{boardID}/blocks:
|
2021-03-26 20:01:54 +02:00
|
|
|
get:
|
|
|
|
description: Returns blocks
|
|
|
|
operationId: getBlocks
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
2021-03-26 20:01:54 +02:00
|
|
|
type: string
|
|
|
|
- description: ID of parent block, omit to specify all blocks
|
|
|
|
in: query
|
|
|
|
name: parent_id
|
|
|
|
type: string
|
|
|
|
- description: Type of blocks to return, omit to specify all types
|
|
|
|
in: query
|
|
|
|
name: type
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
2021-03-26 20:01:54 +02:00
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
|
|
|
default:
|
2021-02-17 21:29:20 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
2021-03-26 20:01:54 +02:00
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2021-02-17 21:29:20 +02:00
|
|
|
post:
|
2021-12-15 21:54:23 +02:00
|
|
|
description: |-
|
|
|
|
Insert blocks. The specified IDs will only be used to link
|
|
|
|
blocks with existing ones, the rest will be replaced by server
|
|
|
|
generated IDs
|
2021-03-26 20:01:54 +02:00
|
|
|
operationId: updateBlocks
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: array of blocks to insert or update
|
2021-02-17 21:29:20 +02:00
|
|
|
in: body
|
2021-03-26 20:01:54 +02:00
|
|
|
name: Body
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
schema:
|
2021-03-26 20:01:54 +02:00
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
2021-12-15 21:54:23 +02:00
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/blocks/:
|
2021-12-15 21:54:23 +02:00
|
|
|
patch:
|
|
|
|
description: Partially updates batch of blocks
|
|
|
|
operationId: patchBlocks
|
|
|
|
parameters:
|
|
|
|
- description: Workspace ID
|
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-12-15 21:54:23 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: block Ids and block patches to apply
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BlockPatchBatch'
|
|
|
|
produces:
|
|
|
|
- application/json
|
2021-02-17 21:29:20 +02:00
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2021-03-26 20:01:54 +02:00
|
|
|
default:
|
2021-02-17 21:29:20 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
2021-03-26 20:01:54 +02:00
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/blocks/{blockID}:
|
2021-03-26 20:01:54 +02:00
|
|
|
delete:
|
|
|
|
description: Deletes a block
|
|
|
|
operationId: deleteBlock
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-02-17 21:29:20 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: ID of block to delete
|
|
|
|
in: path
|
|
|
|
name: blockID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2021-08-06 14:10:24 +02:00
|
|
|
patch:
|
|
|
|
description: Partially updates a block
|
|
|
|
operationId: patchBlock
|
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-08-06 14:10:24 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-08-06 14:10:24 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: ID of block to patch
|
|
|
|
in: path
|
|
|
|
name: blockID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: block patch to apply
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BlockPatch'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/blocks/{blockID}/duplicate:
|
|
|
|
post:
|
|
|
|
description: Returns the new created blocks
|
|
|
|
operationId: duplicateBlock
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: Block ID
|
|
|
|
in: path
|
|
|
|
name: blockID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/boards/{boardID}/blocks/{blockID}/subtree:
|
2021-03-26 20:01:54 +02:00
|
|
|
get:
|
|
|
|
description: Returns the blocks of a subtree
|
|
|
|
operationId: getSubTree
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-02-17 21:29:20 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-03-26 20:01:54 +02:00
|
|
|
- description: The ID of the root block of the subtree
|
|
|
|
in: path
|
|
|
|
name: blockID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
2021-03-26 20:01:54 +02:00
|
|
|
type: string
|
|
|
|
- description: The number of levels to return. 2 or 3. Defaults to 2.
|
|
|
|
in: query
|
|
|
|
maximum: 3
|
|
|
|
minimum: 2
|
|
|
|
name: l
|
|
|
|
type: integer
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2021-03-26 20:01:54 +02:00
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
2021-02-17 21:29:20 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/blocks/export:
|
2021-02-17 21:29:20 +02:00
|
|
|
get:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Returns all blocks of a board
|
2021-03-26 20:01:54 +02:00
|
|
|
operationId: exportBlocks
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-02-17 21:29:20 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
2021-03-26 20:01:54 +02:00
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
2021-02-17 21:29:20 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/blocks/import:
|
2021-02-17 21:29:20 +02:00
|
|
|
post:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Import blocks on a given board
|
2021-03-26 20:01:54 +02:00
|
|
|
operationId: importBlocks
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-02-17 21:29:20 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-03-26 20:01:54 +02:00
|
|
|
- description: array of blocks to import
|
2021-02-17 21:29:20 +02:00
|
|
|
in: body
|
2021-03-26 20:01:54 +02:00
|
|
|
name: Body
|
2021-02-17 21:29:20 +02:00
|
|
|
required: true
|
|
|
|
schema:
|
2021-03-26 20:01:54 +02:00
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Block'
|
|
|
|
type: array
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2021-03-26 20:01:54 +02:00
|
|
|
default:
|
2021-02-17 21:29:20 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/duplicate:
|
2021-03-26 20:01:54 +02:00
|
|
|
post:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Returns the new created board and all the blocks
|
|
|
|
operationId: duplicateBoard
|
2021-03-26 20:01:54 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2022-03-22 16:24:34 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardsAndBlocks'
|
2021-02-17 21:29:20 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/members:
|
2021-02-17 21:29:20 +02:00
|
|
|
get:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: Returns the members of the board
|
|
|
|
operationId: getMembersForBoard
|
2021-03-26 20:01:54 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
items:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
|
|
|
type: array
|
2021-02-17 21:29:20 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/members/{userID}:
|
|
|
|
delete:
|
|
|
|
description: Deletes a member from a board
|
|
|
|
operationId: deleteMember
|
2021-03-26 20:01:54 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: User ID
|
2021-03-26 20:01:54 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: userID
|
2021-03-26 20:01:54 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/boards/{boardID}/sharing:
|
|
|
|
get:
|
|
|
|
description: Returns sharing information for a board
|
|
|
|
operationId: getSharing
|
2021-12-15 21:54:23 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-12-15 21:54:23 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-12-15 21:54:23 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/Sharing'
|
2021-12-15 21:54:23 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
post:
|
|
|
|
description: Sets sharing information for a board
|
|
|
|
operationId: postSharing
|
2021-12-15 21:54:23 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Board ID
|
2021-12-15 21:54:23 +02:00
|
|
|
in: path
|
2022-03-22 16:24:34 +02:00
|
|
|
name: boardID
|
2021-12-15 21:54:23 +02:00
|
|
|
required: true
|
|
|
|
type: string
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: sharing information for a root block
|
|
|
|
in: body
|
|
|
|
name: Body
|
2021-12-15 21:54:23 +02:00
|
|
|
required: true
|
2022-03-22 16:24:34 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/Sharing'
|
2021-12-15 21:54:23 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/login:
|
|
|
|
post:
|
|
|
|
description: Login user
|
|
|
|
operationId: login
|
2021-12-15 21:54:23 +02:00
|
|
|
parameters:
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: Login request
|
|
|
|
in: body
|
|
|
|
name: body
|
2021-12-15 21:54:23 +02:00
|
|
|
required: true
|
2022-03-22 16:24:34 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/LoginRequest'
|
2021-12-15 21:54:23 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
2022-03-22 16:24:34 +02:00
|
|
|
$ref: '#/definitions/LoginResponse'
|
|
|
|
"401":
|
|
|
|
description: invalid login
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
"500":
|
2021-12-15 21:54:23 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/logout:
|
|
|
|
post:
|
|
|
|
description: Logout user
|
|
|
|
operationId: logout
|
2021-06-04 15:23:15 +02:00
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2022-03-22 16:24:34 +02:00
|
|
|
"500":
|
2021-06-04 15:23:15 +02:00
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/register:
|
|
|
|
post:
|
|
|
|
description: Register new user
|
|
|
|
operationId: register
|
|
|
|
parameters:
|
|
|
|
- description: Register request
|
|
|
|
in: body
|
|
|
|
name: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/RegisterRequest'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
"401":
|
|
|
|
description: invalid registration token
|
|
|
|
"500":
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
/api/v1/subscriptions:
|
|
|
|
post:
|
|
|
|
operationId: createSubscription
|
|
|
|
parameters:
|
|
|
|
- description: subscription definition
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/Subscription'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/User'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
summary: Creates a subscription to a block for a user. The user will receive change notifications for the block.
|
|
|
|
/api/v1/subscriptions/{blockID}/{subscriberID}:
|
|
|
|
delete:
|
|
|
|
operationId: deleteSubscription
|
|
|
|
parameters:
|
|
|
|
- description: Block ID
|
|
|
|
in: path
|
|
|
|
name: blockID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: Subscriber ID
|
|
|
|
in: path
|
|
|
|
name: subscriberID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
summary: Deletes a subscription a user has for a a block. The user will no longer receive change notifications for the block.
|
|
|
|
/api/v1/subscriptions/{subscriberID}:
|
|
|
|
get:
|
|
|
|
operationId: getSubscriptions
|
|
|
|
parameters:
|
|
|
|
- description: Subscriber ID
|
|
|
|
in: path
|
|
|
|
name: subscriberID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/User'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
summary: Gets subscriptions for a user.
|
|
|
|
/api/v1/team/{teamID}/onboard:
|
|
|
|
post:
|
|
|
|
operationId: onboard
|
|
|
|
parameters:
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/OnboardingResponse'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
summary: Onboards a user on Boards.
|
|
|
|
/api/v1/teams:
|
|
|
|
get:
|
|
|
|
description: Returns information of all the teams
|
|
|
|
operationId: getTeams
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Team'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}:
|
|
|
|
get:
|
|
|
|
description: Returns information of the root team
|
|
|
|
operationId: getTeam
|
|
|
|
parameters:
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/Team'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}/archive/export:
|
|
|
|
get:
|
|
|
|
operationId: archiveExportTeam
|
|
|
|
parameters:
|
|
|
|
- description: Id of team
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
summary: Exports an archive of all blocks for all the boards in a team.
|
|
|
|
/api/v1/teams/{teamID}/boards:
|
|
|
|
get:
|
|
|
|
description: Returns team boards
|
|
|
|
operationId: getBoards
|
|
|
|
parameters:
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Board'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}/boards/{boardID}/files:
|
|
|
|
post:
|
|
|
|
consumes:
|
|
|
|
- multipart/form-data
|
|
|
|
description: Upload a binary file, attached to a root block
|
|
|
|
operationId: uploadFile
|
|
|
|
parameters:
|
|
|
|
- description: ID of the team
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: The file to upload
|
|
|
|
in: formData
|
|
|
|
name: uploaded file
|
|
|
|
type: file
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/FileUploadResponse'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}/boards/search:
|
|
|
|
get:
|
|
|
|
description: Returns the boards that match with a search term
|
|
|
|
operationId: searchBoards
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: The search term. Must have at least one character
|
|
|
|
in: query
|
|
|
|
name: q
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Board'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}/regenerate_signup_token:
|
|
|
|
post:
|
|
|
|
description: Regenerates the signup token for the root team
|
|
|
|
operationId: regenerateSignupToken
|
|
|
|
parameters:
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}/templates:
|
|
|
|
get:
|
|
|
|
description: Returns team templates
|
|
|
|
operationId: getTemplates
|
|
|
|
parameters:
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Board'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/teams/{teamID}/users:
|
|
|
|
get:
|
|
|
|
description: Returns team users
|
|
|
|
operationId: getTeamUsers
|
|
|
|
parameters:
|
|
|
|
- description: Team ID
|
|
|
|
in: path
|
|
|
|
name: teamID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: string to filter users list
|
|
|
|
in: query
|
|
|
|
name: search
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/User'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/users/{userID}:
|
|
|
|
get:
|
|
|
|
description: Returns a user
|
|
|
|
operationId: getUser
|
|
|
|
parameters:
|
|
|
|
- description: User ID
|
|
|
|
in: path
|
|
|
|
name: userID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/User'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/users/{userID}/changepassword:
|
|
|
|
post:
|
|
|
|
description: Change a user's password
|
|
|
|
operationId: changePassword
|
|
|
|
parameters:
|
|
|
|
- description: User ID
|
|
|
|
in: path
|
|
|
|
name: userID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: Change password request
|
|
|
|
in: body
|
|
|
|
name: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ChangePasswordRequest'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
"400":
|
|
|
|
description: invalid request
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
"500":
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/users/{userID}/config:
|
|
|
|
patch:
|
|
|
|
description: Updates user config
|
|
|
|
operationId: updateUserConfig
|
|
|
|
parameters:
|
|
|
|
- description: User ID
|
|
|
|
in: path
|
|
|
|
name: userID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: User config patch to apply
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/UserPropPatch'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/api/v1/users/me:
|
|
|
|
get:
|
|
|
|
description: Returns the currently logged-in user
|
|
|
|
operationId: getMe
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/User'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-29 10:14:33 +02:00
|
|
|
/api/v1/users/me/memberships:
|
|
|
|
get:
|
|
|
|
description: Returns the currently users board memberships
|
|
|
|
operationId: getMyMemberships
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
|
|
|
type: array
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
2022-03-22 16:24:34 +02:00
|
|
|
/api/v1/workspaces/{workspaceID}/blocks/{blockID}/undelete:
|
|
|
|
post:
|
|
|
|
description: Undeletes a block
|
|
|
|
operationId: undeleteBlock
|
2021-02-17 21:29:20 +02:00
|
|
|
parameters:
|
2021-03-30 01:27:35 +02:00
|
|
|
- description: Workspace ID
|
|
|
|
in: path
|
|
|
|
name: workspaceID
|
|
|
|
required: true
|
|
|
|
type: string
|
2022-03-22 16:24:34 +02:00
|
|
|
- description: ID of block to undelete
|
|
|
|
in: path
|
|
|
|
name: blockID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/boards/{boardID}/{rootID}/{fileID}:
|
|
|
|
get:
|
|
|
|
description: Returns the contents of an uploaded file
|
|
|
|
operationId: getFile
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
2021-03-30 01:27:35 +02:00
|
|
|
- description: ID of the root block
|
|
|
|
in: path
|
|
|
|
name: rootID
|
|
|
|
required: true
|
|
|
|
type: string
|
2021-02-17 21:29:20 +02:00
|
|
|
- description: ID of the file
|
|
|
|
in: path
|
|
|
|
name: fileID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
- image/jpg
|
|
|
|
- image/png
|
2022-03-22 16:24:34 +02:00
|
|
|
- image/gif
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
default:
|
|
|
|
description: internal error
|
2022-03-29 10:14:33 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/boards/{boardID}/join:
|
|
|
|
post:
|
|
|
|
description: Become a member of a board
|
|
|
|
operationId: joinBoard
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
|
|
|
"404":
|
|
|
|
description: board not found
|
|
|
|
"503":
|
|
|
|
description: access denied
|
|
|
|
default:
|
|
|
|
description: internal error
|
2022-03-22 16:24:34 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/boards/{boardID}/members:
|
|
|
|
post:
|
|
|
|
description: Adds a new member to a board
|
|
|
|
operationId: addMember
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: membership to replace the current one with
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
/boards/{boardID}/members/{userID}:
|
|
|
|
put:
|
|
|
|
description: Updates a board member
|
|
|
|
operationId: updateMember
|
|
|
|
parameters:
|
|
|
|
- description: Board ID
|
|
|
|
in: path
|
|
|
|
name: boardID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: User ID
|
|
|
|
in: path
|
|
|
|
name: userID
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
- description: membership to replace the current one with
|
|
|
|
in: body
|
|
|
|
name: Body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
|
|
|
produces:
|
|
|
|
- application/json
|
2021-02-17 21:29:20 +02:00
|
|
|
responses:
|
|
|
|
"200":
|
|
|
|
description: success
|
2022-03-22 16:24:34 +02:00
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/BoardMember'
|
2021-02-17 21:29:20 +02:00
|
|
|
default:
|
|
|
|
description: internal error
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/ErrorResponse'
|
|
|
|
security:
|
|
|
|
- BearerAuth: []
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
schemes:
|
|
|
|
- http
|
|
|
|
- https
|
|
|
|
securityDefinitions:
|
|
|
|
BearerAuth:
|
2022-03-22 16:24:34 +02:00
|
|
|
description: 'Pass session token using Bearer authentication, e.g. set header "Authorization: Bearer <session token>"'
|
2021-02-17 21:29:20 +02:00
|
|
|
in: header
|
|
|
|
name: Authorization
|
|
|
|
type: apiKey
|
|
|
|
swagger: "2.0"
|