mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
31 lines
882 B
YAML
31 lines
882 B
YAML
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: Type of the attribute. Only type 'TEXT' is supported for custom attributes.
|
|
example: "TEXT"
|
|
label:
|
|
type: string
|
|
description: Label displayed on the UI for this schema attribute.
|
|
example: "Account Name"
|
|
technicalName:
|
|
type: string
|
|
description: The technical name of the attribute. Must be unique per source.
|
|
example: "account.name"
|
|
helpText:
|
|
type: string
|
|
description: help text displayed by UI.
|
|
example: "The unique identifier for the account"
|
|
placeholder:
|
|
type: string
|
|
description: Hint text that fills UI box.
|
|
example: "Enter a unique user name for this account."
|
|
required:
|
|
type: boolean
|
|
description: If true, the schema attribute is required for all non-employees in the source
|
|
example: true
|
|
required:
|
|
- type
|
|
- technicalName
|
|
- label
|