Files
api-specs/idn/beta/schemas/forms/CreateFormDefinitionRequest.yaml
GitHub Action Bot 6499189f24 Automated commit 'Merge pull request #1324 from sailpoint/jalvarez/PLTFORMS-923
PLTFORMS-923: Add api docs for forms' by github action: 5592152758
2023-07-18 20:36:51 +00:00

45 lines
1.3 KiB
YAML

properties:
description:
description: Description is the form definition description
example: My form description
maxLength: 2000
minLength: 0
type: string
x-go-name: Description
formConditions:
description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form
items:
$ref: './FormCondition.yaml'
type: array
x-go-name: FormConditions
formElements:
description: FormElements is a list of nested form elements
items:
$ref: './FormElement.yaml'
type: array
x-go-name: FormElements
formInput:
description: FormInput is a list of form inputs that are required when creating a form-instance object
items:
$ref: './FormDefinitionInput.yaml'
type: array
x-go-name: FormInput
name:
description: Name is the form definition name
example: My form
maxLength: 255
type: string
x-go-name: Name
owner:
$ref: './FormOwner.yaml'
usedBy:
description: UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used
items:
$ref: './FormUsedBy.yaml'
type: array
x-go-name: UsedBy
required:
- name
- owner
type: object
x-go-package: github.com/sailpoint/sp-forms/domain