Skip to content

Commit dd95227

Browse files
committed
Updated API from documentation release
1 parent 59bf0ff commit dd95227

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

api-specs/api/types/type/FieldDefinition.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ properties:
1515
description: |
1616
Name of the Custom Field to define.
1717
Must be unique for a given [ResourceTypeId](ctp:api:type:ResourceTypeId).
18-
In case there is a FieldDefinition with the same `name` in another [Type](ctp:api:type:Type), both FieldDefinitions must have the same `type`.
18+
If a FieldDefinition with the same `name` is defined in another [Type](ctp:api:type:Type) for the same [ResourceTypeId](ctp:api:type:ResourceTypeId), then both FieldDefinitions must have the same `type`.
1919
pattern: ^[A-Za-z0-9_-]+$
2020
minLength: 2
2121
maxLength: 36

api-specs/api/types/type/FieldType.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ discriminator: name
66
properties:
77
name:
88
type: string
9+
description: Discriminator that determines the type of the field.

api-specs/import/types/type-import.raml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@ types:
130130
name:
131131
type: string
132132
description: |
133-
Name of the field type. Must be unique for a given [ResourceTypeId](ctp:import:type:ResourceTypeId). In case there is a FieldDefinition with the same `name` in another Type, both FieldDefinitions must have the same `type`. This value cannot be changed after the Type is imported.
133+
Discriminator that determines the type of the field.
134+
This value can't be changed after you import the Type.
134135
135136
CustomFieldBooleanType:
136137
type: FieldType
@@ -277,7 +278,10 @@ types:
277278
name:
278279
type: string
279280
description: |
280-
Name of the Custom Field to define. Must be unique for a given [ResourceTypeId](ctp:import:type:ResourceTypeId). In case there is a FieldDefinition with the same `name` in another Type, both FieldDefinitions must have the same `type`. This value cannot be changed after the Type is imported.
281+
Name of the Custom Field that you want to define.
282+
The name must be unique for a given [ResourceTypeId](ctp:import:type:ResourceTypeId).
283+
If a FieldDefinition with the same `name` is defined in another [Type](ctp:api:type:Type) for the same [ResourceTypeId](ctp:import:type:ResourceTypeId), then both FieldDefinitions must have the same `type`.
284+
This value can't be changed after you import the Type.
281285
pattern: ^[A-Za-z0-9_-]+$
282286
minLength: 2
283287
maxLength: 36

0 commit comments

Comments
 (0)