Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger custom fields #341

Merged
merged 3 commits into from
May 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
80 changes: 73 additions & 7 deletions swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1793,6 +1793,11 @@ components:
$ref: '#/components/schemas/topic_actions'
comment_actions:
$ref: '#/components/schemas/comment_actions'
custom_fields:
type: array
nullable: true
items:
$ref: '#/components/schemas/project_custom_field_extension'
project_GET:
type: object
description: Schema for single project GET, BCF REST API.
Expand Down Expand Up @@ -2188,6 +2193,8 @@ components:
default_viewpoint_guid:
type: string
nullable: true
custom_fields:
$ref: '#/components/schemas/topic_custom_fields'
topic_POST:
type: object
required:
Expand Down Expand Up @@ -2236,6 +2243,8 @@ components:
default_viewpoint_guid:
type: string
nullable: true
custom_fields:
$ref: '#/components/schemas/topic_custom_fields'
topic_PUT:
type: object
required:
Expand Down Expand Up @@ -2281,6 +2290,23 @@ components:
default_viewpoint_guid:
type: string
nullable: true
custom_fields:
$ref: '#/components/schemas/topic_custom_fields'
# topic custom fields schemas
topic_custom_fields:
type: array
items:
$ref: '#/components/schemas/topic_custom_field'
topic_custom_field:
type: object
properties:
id:
type: string
nullable: true
description: 'Refers to the id of the custom field in the project extensions.'
value:
type: string
nullable: true
# viewpoint schemas
bitmap_GET:
type: object
Expand Down Expand Up @@ -2580,7 +2606,52 @@ components:
type: object
properties:
visibility:
$ref: '#/components/schemas/visibility'
$ref: '#/components/schemas/visibility'
project_custom_field_extension:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- integer
- decimal
- string
- boolean
- enum
- date
- date-time
readonly:
type: boolean
minArraySize:
type: integer
maxArraySize:
type: integer
defaultValue:
type: array
items:
type: string
enumValues:
type: array
items:
$ref: '#/components/schemas/project_custom_field_enum_value'
project_custom_field_enum_value:
type: object
properties:
value:
type: string
displayValue:
type: string
readonly:
type: boolean
marker:
type: object
properties:
location:
$ref: '#/components/schemas/point'
parameters:
version:
in: path
Expand Down Expand Up @@ -2640,9 +2711,4 @@ components:
in: query
name: $skip
schema:
type: string
marker:
type: object
properties:
location:
$ref: '#/components/schemas/point'
type: string