Updated API from documentation release

Author: ct-sdks[bot]

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

@@ -7,6 +7,7 @@ type:
     sortExample: createdAt asc
 description: Store custom JSON values.
 get:
+  displayName: Query CustomObjects
   (markDeprecated): true
   securedBy:
     - oauth_2_0:
@@ -23,6 +24,7 @@ get:
         application/json:
           example: !include ../examples/custom-objects.example.json
 head:
+  displayName: Check if CustomObject exists by Query Predicate
   securedBy:
     - oauth_2_0:
         scopes:
@@ -40,6 +42,7 @@ head:
         [Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
         [Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
 post:
+  displayName: Create or update CustomObject
   securedBy:
     - oauth_2_0:
         scopes:
@@ -84,6 +87,7 @@ post:
         `key` of the [CustomObject](ctp:api:type:CustomObject).
   type: base
   get:
+    displayName: Get CustomObject by Container and Key
     is:
       - expandable
     securedBy:
@@ -107,6 +111,7 @@ post:
             example: !include ../examples/custom-object.example.json
             type: CustomObject
   delete:
+    displayName: Delete CustomObject by Container and Key
     is:
       - dataErasure
       - versioned
@@ -140,6 +145,7 @@ post:
       uriParameterName: container
       resourceType: CustomObjectPagedQueryResponse
   get:
+    displayName: Query CustomObjects
     securedBy:
       - oauth_2_0:
           scopes:

api-specs/api/resources/extensions.raml

@@ -16,6 +16,7 @@ get:
           type: ExtensionPagedQueryResponse
           example: !include ../examples/extensions.example.json
 head:
+  displayName: Check if Extension exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
   description: Checks if one or more Extensions exist for the provided query predicate. Returns a `200 OK` status if any Extensions match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -49,7 +50,7 @@ post:
       type: string
       description: '`key` of the [Extension](ctp:api:type:Extension).'
   get:
-    displayName: Get Extension by key
+    displayName: Get Extension by Key
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
     responses:
       200:
@@ -58,10 +59,11 @@ post:
             type: Extension
             example: !include ../examples/extension.example.json
   head:
+    displayName: Check if Extension exists by Key
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
     description: Checks if an Extension exists with the provided `key`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise.
   post:
-    displayName: Update Extension by key
+    displayName: Update Extension by Key
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
     is:
       - conflicting
@@ -77,7 +79,7 @@ post:
             type: Extension
             example: !include ../examples/extension-update-response.example.json
   delete:
-    displayName: Delete Extension by key
+    displayName: Delete Extension by Key
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
     is:
       - versioned
@@ -105,6 +107,7 @@ post:
             type: Extension
             example: !include ../examples/extension.example.json
   head:
+    displayName: Check if Extension exists by ID
     securedBy: [oauth_2_0: { scopes: ['manage_extensions:{projectKey}'] }]
     description: Checks if an Extension exists with the provided `id`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise.
   post:

api-specs/api/resources/messages.raml

@@ -9,6 +9,7 @@ description:
   A message represents a change or an action performed on a resource (like an
   Order or a Product).
 get:
+  displayName: Query Messages
   description: 'Deprecated OAuth 2.0 Scope: `view_orders:{projectKey}`'
   securedBy: [oauth_2_0: { scopes: ['view_messages:{projectKey}'] }]
   responses:
@@ -17,6 +18,7 @@ get:
         application/json:
           example: !include ../examples/messages.example.json
 head:
+  displayName: Check if Message exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_messages:{projectKey}'] }]
   description: Checks if one or more Messages exist for the provided query predicate. Returns a `200 OK` status if any Messages match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -34,6 +36,7 @@ head:
       uriParameterName: ID
       resourceType: Message
   get:
+    displayName: Get Message by ID
     description: 'Deprecated OAuth 2.0 Scope: `view_orders:{projectKey}`'
     securedBy: [oauth_2_0: { scopes: ['view_messages:{projectKey}'] }]
     responses:
@@ -42,5 +45,6 @@ head:
           application/json:
             example: !include ../examples/message.example.json
   head:
+    displayName: Check if Message exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_messages:{projectKey}'] }]
     description: Checks if a Message exists with the provided `id`. Returns a `200 OK` status if the Message exists or a `404 Not Found` otherwise.

api-specs/api/resources/states.raml

@@ -13,13 +13,15 @@ description: |
   reviews, and payments in order to define finite state machines reflecting the business logic you'd like to
   implement.
 get:
+  displayName: Query States
   securedBy: [oauth_2_0: { scopes: ['view_states:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/states.example.json
 head:
+  displayName: Check if State exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_states:{projectKey}'] }]
   description: Checks if one or more States exist for the provided query predicate. Returns a `200 OK` status if any States match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -31,6 +33,7 @@ head:
         [Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
         [Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
 post:
+  displayName: Create State
   securedBy: [oauth_2_0: { scopes: ['manage_states:{projectKey}'] }]
   body:
     application/json:
@@ -48,16 +51,19 @@ post:
       resourceType: State
       resourceUpdateType: StateUpdate
   get:
+    displayName: Get State by Key
     securedBy: [oauth_2_0: { scopes: ['view_states:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/state.example.json
   head:
+    displayName: Check if State exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_states:{projectKey}'] }]
     description: Checks if a State exists with the provided `key`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update State by Key
     securedBy: [oauth_2_0: { scopes: ['manage_states:{projectKey}'] }]
     body:
       application/json:
@@ -68,6 +74,7 @@ post:
           application/json:
             example: !include ../examples/state-update-response.example.json
   delete:
+    displayName: Delete State by Key
     securedBy: [oauth_2_0: { scopes: ['manage_states:{projectKey}'] }]
     responses:
       200:
@@ -82,16 +89,19 @@ post:
       resourceType: State
       resourceUpdateType: StateUpdate
   get:
+    displayName: Get State by ID
     securedBy: [oauth_2_0: { scopes: ['view_states:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/state.example.json
   head:
+    displayName: Check if State exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_states:{projectKey}'] }]
     description: Checks if a State exists with the provided `id`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update State by ID
     securedBy: [oauth_2_0: { scopes: ['manage_states:{projectKey}'] }]
     body:
       application/json:
@@ -102,6 +112,7 @@ post:
           application/json:
             example: !include ../examples/state-update-response.example.json
   delete:
+    displayName: Delete State by ID
     securedBy: [oauth_2_0: { scopes: ['manage_states:{projectKey}'] }]
     responses:
       200:

api-specs/api/resources/subscriptions.raml

@@ -18,6 +18,7 @@ get:
           type: SubscriptionPagedQueryResponse
           example: !include ../examples/subscriptions.example.json
 head:
+  displayName: Check if Subscription exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['manage_subscriptions:{projectKey}'] }]
   description: Checks if one or more Subscriptions exist for the provided query predicate. Returns a `200 OK` status if any Subscriptions match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -53,7 +54,7 @@ post:
       type: string
       description: '`key` of the [Subscription](ctp:api:type:Subscription).'
   get:
-    displayName: Get Subscription by key
+    displayName: Get Subscription by Key
     securedBy: [oauth_2_0: { scopes: ['manage_subscriptions:{projectKey}'] }]
     responses:
       200:
@@ -62,10 +63,11 @@ post:
             type: Subscription
             example: !include ../examples/subscription.example.json
   head:
+    displayName: Check if Subscription exists by Key
     securedBy: [oauth_2_0: { scopes: ['manage_subscriptions:{projectKey}'] }]
     description: Checks if a Subscription exists with the provided `key`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise.
   post:
-    displayName: Update Subscription by key
+    displayName: Update Subscription by Key
     securedBy: [oauth_2_0: { scopes: ['manage_subscriptions:{projectKey}'] }]
     is:
       - conflicting
@@ -81,7 +83,7 @@ post:
             type: Subscription
             example: !include ../examples/subscription-update-response.example.json
   delete:
-    displayName: Delete Subscription by key
+    displayName: Delete Subscription by Key
     securedBy: [oauth_2_0: { scopes: ['manage_subscriptions:{projectKey}'] }]
     is:
       - versioned
@@ -109,6 +111,7 @@ post:
             type: Subscription
             example: !include ../examples/subscription.example.json
   head:
+    displayName: Check if Subscription exists by ID
     securedBy: [oauth_2_0: { scopes: ['manage_subscriptions:{projectKey}'] }]
     description: Checks if a Subscription exists with the provided `id`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise.
   post:

api-specs/api/resources/types.raml

@@ -10,13 +10,15 @@ type:
 (createable): TypeDraft
 description: Types define custom fields that are used to enhance resources as you need.
 get:
+  displayName: Query Types
   securedBy: [oauth_2_0: { scopes: ['view_types:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/types.example.json
 head:
+  displayName: Check if Type exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_types:{projectKey}'] }]
   description: Checks if one or more Types exist for the provided query predicate. Returns a `200 OK` status if any Types match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -28,6 +30,7 @@ head:
         [Number](ctp:api:type:AttributeNumberType), [Date](ctp:api:type:AttributeDateType),
         [Time](ctp:api:type:AttributeTimeType), and [DateTime](ctp:api:type:AttributeDateTimeType) attribute types.
 post:
+  displayName: Create Type
   securedBy: [oauth_2_0: { scopes: ['manage_types:{projectKey}'] }]
   body:
     application/json:
@@ -45,16 +48,19 @@ post:
       resourceType: Type
       resourceUpdateType: TypeUpdate
   get:
+    displayName: Get Type by Key
     securedBy: [oauth_2_0: { scopes: ['view_types:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/type.example.json
   head:
+    displayName: Check if Type exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_types:{projectKey}'] }]
     description: Checks if a Type exists with the provided `key`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update Type by Key
     securedBy: [oauth_2_0: { scopes: ['manage_types:{projectKey}'] }]
     body:
       application/json:
@@ -65,6 +71,7 @@ post:
           application/json:
             example: !include ../examples/type-update-response.example.json
   delete:
+    displayName: Delete Type by Key
     securedBy: [oauth_2_0: { scopes: ['manage_types:{projectKey}'] }]
     responses:
       200:
@@ -79,16 +86,19 @@ post:
       resourceType: Type
       resourceUpdateType: TypeUpdate
   get:
+    displayName: Get Type by ID
     securedBy: [oauth_2_0: { scopes: ['view_types:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/type.example.json
   head:
+    displayName: Check if Type exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_types:{projectKey}'] }]
     description: Checks if a Type exists with the provided `id`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update Type by ID
     securedBy: [oauth_2_0: { scopes: ['manage_types:{projectKey}'] }]
     body:
       application/json:
@@ -99,6 +109,7 @@ post:
           application/json:
             example: !include ../examples/type-update-response.example.json
   delete:
+    displayName: Delete Type by ID
     securedBy: [oauth_2_0: { scopes: ['manage_types:{projectKey}'] }]
     responses:
       200: