Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/api.raml

@@ -199,7 +199,7 @@ resourceTypes:
   (updateable): Project
   description: The Project endpoint is used to retrieve certain information from a project.
   get:
-    displayName: Get project settings
+    displayName: Get Project
     is:
       - errorable
       - deprecatable200
@@ -210,12 +210,13 @@ resourceTypes:
           example: !include examples/project.example.json
           type: Project
   head:
+    displayName: Check if Project exists
     securedBy: [oauth_2_0: { scopes: ['view_project_settings:{projectKey}'] }]
     description: Checks if a Project exists for a given `projectKey`. Returns a `200 OK` status if the Project exists or a `404 Not Found` otherwise.
     responses:
       200:
   post:
-    displayName: Update project settings
+    displayName: Update Project
     is:
       - conflicting
     securedBy: [oauth_2_0: { scopes: ['manage_project_settings:{projectKey}'] }]

api-specs/api/resources/api-clients.raml

@@ -8,13 +8,15 @@ type:
 description: |
   Manage your API Clients via an API. Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets.
 get:
+  displayName: Query ApiClients
   securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/api-clients.example.json
 head:
+  displayName: Check if ApiClient exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
   description: Checks if an API Client exists for the provided query predicate. Returns a `200 OK` status if any API Clients match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -26,6 +28,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 ApiClient
   securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
   body:
     application/json:
@@ -44,20 +47,21 @@ post:
       description: '`id` of the API Client.'
   type: base
   get:
-    securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
     displayName: Get ApiClient by ID
+    securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/api-client.example.json
             type: ApiClient
   head:
+    displayName: Check if ApiClient exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_api_clients:{projectKey}'] }]
     description: Checks if an API Client exists with the provided `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise.
   delete:
-    securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
     displayName: Delete ApiClient by ID
+    securedBy: [oauth_2_0: { scopes: ['manage_api_clients:{projectKey}'] }]
     responses:
       200:
         body:

api-specs/api/resources/attribute-groups.raml

@@ -10,13 +10,15 @@ type:
 (createable): AttributeGroupDraft
 description: Attribute groups ... TODO
 get:
+  displayName: Query AttributeGroups
   securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/AttributeGroup/AttributeGroups.json
 head:
+  displayName: Check if AttributeGroup exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
   description: Checks if one or more AttributeGroups exist for the provided query predicate. Returns `200 OK` status if any AttributeGroups 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 AttributeGroup
   securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
   body:
     application/json:
@@ -45,16 +48,19 @@ post:
       resourceType: AttributeGroup
       resourceUpdateType: AttributeGroupUpdate
   get:
+    displayName: Get AttributeGroup by Key
     securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/AttributeGroup/AttributeGroup.json
   head:
+    displayName: Check if AttributeGroup exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
     description: Checks if an AttributeGroup exists with the provided `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update AttributeGroup by Key
     securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
     body:
       application/json:
@@ -65,6 +71,7 @@ post:
           application/json:
             example: !include ../examples/AttributeGroup/AttributeGroup.json
   delete:
+    displayName: Delete AttributeGroup by Key
     securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
     responses:
       200:
@@ -79,16 +86,19 @@ post:
       resourceType: AttributeGroup
       resourceUpdateType: AttributeGroupUpdate
   get:
+    displayName: Get AttributeGroup by ID
     securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/AttributeGroup/AttributeGroup.json
   head:
+    displayName: Check if AttributeGroup exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_attribute_groups:{projectKey}'] }]
     description: Checks if an AttributeGroup exists with the provided `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update AttributeGroup by ID
     securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
     body:
       application/json:
@@ -99,6 +109,7 @@ post:
           application/json:
             example: !include ../examples/AttributeGroup/AttributeGroup.json
   delete:
+    displayName: Delete AttributeGroup by ID
     securedBy: [oauth_2_0: { scopes: ['manage_attribute_groups:{projectKey}'] }]
     responses:
       200:

api-specs/api/resources/channels.raml

@@ -11,13 +11,15 @@ type:
 description: |
   Channels represent a source or destination of different entities. They can be used to model warehouses or stores.
 get:
+  displayName: Query Channels
   securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/channels.example.json
 head:
+  displayName: Check if Channel exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
   description: Checks if one or more Channels exist for the provided query predicate. Returns a `200 OK` status if any Channels match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
@@ -29,6 +31,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 Channel
   securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
   body:
     application/json:
@@ -46,16 +49,19 @@ post:
       resourceType: Channel
       resourceUpdateType: ChannelUpdate
   get:
+    displayName: Get Channel by ID
     securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/channel.example.json
   head:
+    displayName: Check if Channel exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
     description: Checks if a Channel exists with the provided `id`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update Channel by ID
     securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
     body:
       application/json:
@@ -66,6 +72,7 @@ post:
           application/json:
             example: !include ../examples/channel-updated.example.json
   delete:
+    displayName: Delete Channel by ID
     securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
     description: |
       Returns a [ReferenceExists](ctp:api:type:ReferenceExistsError) error if other resources reference the Channel to be deleted.
@@ -83,16 +90,19 @@ post:
       resourceType: Channel
       resourceUpdateType: ChannelUpdate
   get:
+    displayName: Get Channel by Key
     securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/channel.example.json
   head:
+    displayName: Check if Channel exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_products:{projectKey}'] }]
     description: Checks if a Channel exists with the provided `key`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update Channel by Key
     securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
     body:
       application/json:
@@ -103,6 +113,7 @@ post:
           application/json:
             example: !include ../examples/channel-updated.example.json
   delete:
+    displayName: Delete Channel by Key
     securedBy: [oauth_2_0: { scopes: ['manage_products:{projectKey}'] }]
     description: |
       Returns a [ReferenceExists](ctp:api:type:ReferenceExistsError) error if other resources reference the Channel to be deleted.

api-specs/api/resources/in-store.raml

@@ -2202,7 +2202,7 @@ uriParameters:
     type: base
     description: Get ShippingMethods for a cart in a store
     get:
-      displayName: Get ShippingMethods for a cart in a store
+      displayName: Get matching ShippingMethods for a Cart in Store
       description: |
         Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart in a given [Store](ctp:api:type:Store).
         Each ShippingMethod contains exactly one ShippingRate with the flag `isMatching` set to `true`.
@@ -2231,6 +2231,7 @@ uriParameters:
               type: ShippingMethodPagedQueryResponse
               example: !include ../examples/shipping-methods.example.json
     head:
+      displayName: Check if matching ShippingMethod exists for a Cart in Store
       securedBy:
         - oauth_2_0:
             scopes: