Skip to content

Commit 6bb8d35

Browse files
committed
Updated API from documentation release
1 parent ccf4522 commit 6bb8d35

File tree

5 files changed

+19
-13
lines changed

5 files changed

+19
-13
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"id": "4e2b758f-f259-4c14-808e-2beb126bc0f1",
3+
"typeId": "key-value-document"
4+
}

api-specs/api/resources/custom-objects.raml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ post:
5151
If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.
5252
If the request contains a version and an object with the given container/key, then the version must match the version of the existing object. Concurrent updates to the same Custom Object returns a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error even if the version is not provided.
5353
54-
Fields with `null` values will **not be saved**.
54+
Fields within `value` that have `null` values **are not saved**.
5555
body:
5656
application/json:
5757
example: !include ../examples/custom-object-create.example.json
@@ -61,7 +61,7 @@ post:
6161
required: false
6262
description: |
6363
Expands a `value` of type [Reference](ctp:api:type:Reference).
64-
In case the referenced object does not exist, the API returns the non-expanded reference.
64+
If the referenced object does not exist, the API returns the non-expanded reference.
6565
responses:
6666
200:
6767
body:
@@ -99,7 +99,7 @@ post:
9999
required: false
100100
description: |
101101
Expands a `value` of type [Reference](ctp:api:type:Reference).
102-
In case the referenced object does not exist, the API returns the non-expanded reference.
102+
If the referenced object does not exist, the API returns the non-expanded reference.
103103
responses:
104104
200:
105105
body:
@@ -126,7 +126,7 @@ post:
126126
required: false
127127
description: |
128128
Expands a `value` of type [Reference](ctp:api:type:Reference).
129-
In case the referenced object does not exist, the API returns the non-expanded reference.
129+
If the referenced object does not exist, the API returns the non-expanded reference.
130130
responses:
131131
200:
132132
body:
@@ -162,14 +162,14 @@ post:
162162
required: false
163163
description: |
164164
`id`, `key`, `version`, `createdAt`, and `lastModifiedAt` can be used as predicate.
165-
The `field` value can also be used as predicate but is not checked for validity.
166-
For example, you can use any predicates: `value(aValue=true)` or `value(myObject(myValue="abc"))`.
165+
`value` can also be used as predicate, but is not checked for validity.
166+
For example: `value(exampleNumber > 1233)` or `value(exampleObject(exampleBoolean = true))`.
167167
expand:
168168
type: Expansion[]
169169
required: false
170170
description: |
171171
Expands a `value` of type [Reference](ctp:api:type:Reference).
172-
In case the referenced object does not exist, the API returns the non-expanded reference.
172+
If the referenced object does not exist, the API returns the non-expanded reference.
173173
responses:
174174
200:
175175
body:

api-specs/api/types/custom-object/CustomObject.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ properties:
4646
value:
4747
type: any
4848
description: |
49-
JSON standard types Number, String, Boolean, Array, Object, and [common API data types](/../api/types).
50-
For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed.
51-
If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
49+
Can be any JSON standard type, such as number, string, boolean, array, object, or a [common API data type](/../api/types).
50+
51+
- For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.

api-specs/api/types/custom-object/CustomObjectDraft.raml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ properties:
1919
value:
2020
type: any
2121
description: |
22-
JSON standard types Number, String, Boolean, Array, Object, and [common API data types](/../api/types).
23-
For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed.
24-
If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
22+
Can be any JSON standard type, such as number, string, boolean, array, object, or a [common API data type](/../api/types).
23+
24+
- Fields within `value` that have `null` values **are not saved**.
25+
- For values of type [Reference](ctp:api:type:Reference) the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the `value` points to a non-existing object in such case.
2526
version?:
2627
type: number
2728
format: int64

api-specs/api/types/custom-object/CustomObjectReference.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
(package): CustomObject
33
type: Reference
44
displayName: CustomObjectReference
5+
example: !include ../../examples/CustomObjects/CustomObjectReference.json
56
discriminatorValue: key-value-document
67
description: |
78
[Reference](ctp:api:type:Reference) to a [CustomObject](ctp:api:type:CustomObject).

0 commit comments

Comments
 (0)