Skip to content

resolve validation errors under OpenAPI 3.0 #88

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.

Sign up for GitHub

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

Open
karenetheridge wants to merge 2 commits into
base: master
Choose a base branch
from
+124 −2
Open

resolve validation errors under OpenAPI 3.0 #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f7a417
resolve validation errors under OpenAPI 3.0
karenetheridge Dec 24, 2025
baf304c
add length constraints
karenetheridge Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion defs/app_components_oas.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
openapi: 3.0.0
openapi: 3.0.4
info:
description: >-
This is the interface for handling requests for
Expand Down Expand Up @@ -289,6 +289,7 @@ components:
description: >-
The label of the option. Limit 80 characters.
type: string
maxLength: 80
example: 'Opt in'
DropdownOption:
description: >-
Expand All @@ -307,6 +308,7 @@ components:
description: >-
The label of the option. Limit 80 characters.
type: string
maxLength: 80
example: 'Red'
icon_url:
description: >-
Expand Down Expand Up @@ -358,6 +360,7 @@ components:
description: >-
The text (i.e., label) for the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Please enter the following details:'
style:
description: >-
Expand Down Expand Up @@ -391,6 +394,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Resource name'
is_required:
description: >-
Expand Down Expand Up @@ -425,6 +429,7 @@ components:
description: >-
The value of the field. If not provided, the field will be empty and the form cannot be submitted if it is required. Limit 200 characters.
type: string
maxLength: 200
example: "Annual Kick-Off Meeting"
FormField-MultiLineText:
description: >-
Expand All @@ -450,6 +455,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Resource name'
is_required:
description: >-
Expand All @@ -476,6 +482,7 @@ components:
description: >-
The value of the field. If not provided, the field will be empty and the form cannot be submitted if it is required. Limit 3000 characters.
type: string
maxLength: 3000
example: "Annual Kick-Off Meeting"
FormField-RichText:
description: >-
Expand All @@ -501,6 +508,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Resource name'
is_required:
description: >-
Expand All @@ -527,6 +535,7 @@ components:
description: >-
The value of the field. If not provided, the field will be empty and the form cannot be submitted if it is required. Limit 3000 characters.
type: string
maxLength: 3000
example: "Annual Kick-Off Meeting"
FormField-Dropdown:
description: >-
Expand All @@ -536,6 +545,7 @@ components:
- id
- type
- options
maxProperties: 50
properties:
type:
description: >-
Expand All @@ -553,6 +563,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Resource name'
is_required:
description: >-
Expand Down Expand Up @@ -597,6 +608,7 @@ components:
- id
- type
- options
maxProperties: 5
properties:
type:
description: >-
Expand All @@ -614,6 +626,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Resource name'
is_required:
description: >-
Expand Down Expand Up @@ -650,6 +663,7 @@ components:
- id
- type
- options
maxProperties: 10
properties:
type:
description: >-
Expand All @@ -667,6 +681,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Resource name'
is_required:
description: >-
Expand Down Expand Up @@ -722,6 +737,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Date'
is_required:
description: >-
Expand Down Expand Up @@ -775,6 +791,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Datetime'
is_required:
description: >-
Expand Down Expand Up @@ -829,6 +846,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 50 characters.
type: string
maxLength: 50
example: 'Statuses'
is_required:
description: >-
Expand Down Expand Up @@ -904,6 +922,19 @@ components:
[FormField-RichText](/reference/modal-forms#formfield-richtext), [FormField-SingleLineText](/reference/modal-forms#formfield-singlelinetext),
[FormField-StaticText](/reference/modal-forms#formfield-statictext), [FormField-Typeahead](/reference/modal-forms#formfield-typeahead)
type: array
maxItems: 30
items:
anyOf:
- $ref: '#/components/schemas/FormField-Checkbox'
- $ref: '#/components/schemas/FormField-Date'
- $ref: '#/components/schemas/FormField-Datetime'
- $ref: '#/components/schemas/FormField-Dropdown'
- $ref: '#/components/schemas/FormField-MultiLineText'
- $ref: '#/components/schemas/FormField-RadioButton'
- $ref: '#/components/schemas/FormField-RichText'
- $ref: '#/components/schemas/FormField-SingleLineText'
- $ref: '#/components/schemas/FormField-StaticText'
- $ref: '#/components/schemas/FormField-Typeahead'
on_submit_callback:
description: >-
The URL to `POST` the form to when the user clicks the submit button.
Expand Down Expand Up @@ -1175,6 +1206,7 @@ components:
description: >-
The label of the option. Limit 80 characters.
type: string
maxLength: 80
example: 'Radio Option 1'
sub_label:
description: >-
Expand Down Expand Up @@ -1308,6 +1340,7 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 40 characters.
type: string
maxLength: 40
example: 'Status'
datetime:
description: >-
Expand Down Expand Up @@ -1340,11 +1373,13 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 40 characters.
type: string
maxLength: 40
example: 'Status'
text:
description: >-
The text to show in the field. Limit 40 characters.
type: string
maxLength: 40
example: 'In Progress'
color:
description: >-
Expand Down Expand Up @@ -1388,11 +1423,13 @@ components:
description: >-
The text (i.e., label) to show in the title of the field. Limit 40 characters.
type: string
maxLength: 40
example: 'Status'
text:
description: >-
The text to show in the field. Limit 40 characters.
type: string
maxLength: 40
example: 'In Progress'
icon_url:
description: >-
Expand Down Expand Up @@ -1435,6 +1472,13 @@ components:

Valid object schemas: [WidgetField-DatetimeWithIcon](/reference/widgets#widgetfield-datetimewithicon), [WidgetField-Pill](/reference/widgets#widgetfield-pill), [WidgetField-TextWithIcon](/reference/widgets#widgetfield-textwithicon).
type: array
minItems: 1
maxItems: 5
items:
anyOf:
- $ref: '#/components/schemas/DatetimeWithIcon'
- $ref: '#/components/schemas/WidgetField-Pill'
- $ref: '#/components/schemas/WidgetField-TextWithIcon'
subtitle:
description: >-
The text to show under the title of the widget, next to "Open in {App Name}". If not provided, the
Expand Down
Loading