Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/resources/as-associate.raml

@@ -10,19 +10,22 @@ type:
 (createable): AssociateRoleDraft
 description: An Associate Role enables permissions over a Business Unit to an Associate.
 get:
+  displayName: Query AssociateRoles
   securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/associate-roles.example.json
 head:
+  displayName: Check if AssociateRole exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
   description: Checks if one or more AssociateRoles exist for the provided query predicate. Returns a `200 OK` status if any AssociateRole match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
+  displayName: Create AssociateRole
   securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
   description: |
     Creating a Associate Role generates the [AssociateRoleCreated](ctp:api:type:AssociateRoleCreatedMessage) Message.
@@ -42,16 +45,19 @@ post:
       resourceType: AssociateRole
       resourceUpdateType: AssociateRoleUpdate
   get:
+    displayName: Get AssociateRole by Key
     securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/associate-role.example.json
   head:
+    displayName: Check if AssociateRole exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
     description: Checks if an AssociateRole exists with the provided `key`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update AssociateRole by Key
     securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
     body:
       application/json:
@@ -62,6 +68,7 @@ post:
           application/json:
             example: !include ../examples/associate-role.example.json
   delete:
+    displayName: Delete AssociateRole by Key
     securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
     description: |
       Deleting an AssociateRole generates the [AssociateRoleDeleted](ctp:api:type:AssociateRoleDeletedMessage) Message. An AssociateRole can only be deleted if it is not assigned to any [Associates](ctp:api:type:Associate).
@@ -78,16 +85,19 @@ post:
       resourceType: AssociateRole
       resourceUpdateType: AssociateRoleUpdate
   get:
+    displayName: Get AssociateRole by ID
     securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/associate-role.example.json
   head:
+    displayName: Check if AssociateRole exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_associate_roles:{projectKey}'] }]
     description: Checks if an AssociateRole exists with the provided `id`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update AssociateRole by ID
     securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
     body:
       application/json:
@@ -98,6 +108,7 @@ post:
           application/json:
             example: !include ../examples/associate-role.example.json
   delete:
+    displayName: Delete AssociateRole by ID
     securedBy: [oauth_2_0: { scopes: ['manage_associate_roles:{projectKey}'] }]
     responses:
       200:

api-specs/api/resources/associate-roles.raml

@@ -10,19 +10,22 @@ type:
 (createable): BusinessUnitDraft
 description: A Business Unit can represent a Company or a Division.
 get:
+  displayName: Query BusinessUnits
   securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
   responses:
     200:
       body:
         application/json:
           example: !include ../examples/business-units.example.json
 head:
+  displayName: Check if BusinessUnit exists by Query Predicate
   securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
   description: Checks if one or more BusinessUnits exist for the provided query predicate. Returns a `200 OK` status if any BusinessUnits match the query predicate, or a `404 Not Found` otherwise.
   queryParameters:
     where?:
       type: QueryPredicate[]
 post:
+  displayName: Create BusinessUnit
   securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
   body:
     application/json:
@@ -40,16 +43,19 @@ post:
       resourceType: BusinessUnit
       resourceUpdateType: BusinessUnitUpdate
   get:
+    displayName: Get BusinessUnit by Key
     securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/business-unit.example.json
   head:
+    displayName: Check if BusinessUnit exists by Key
     securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
     description: Checks if a BusinessUnit exists with the provided `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update BusinessUnit by Key
     securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
     body:
       application/json:
@@ -60,6 +66,7 @@ post:
           application/json:
             example: !include ../examples/business-unit.example.json
   delete:
+    displayName: Delete BusinessUnit by Key
     securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
     responses:
       200:
@@ -74,16 +81,19 @@ post:
       resourceType: BusinessUnit
       resourceUpdateType: BusinessUnitUpdate
   get:
+    displayName: Get BusinessUnit by ID
     securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
     responses:
       200:
         body:
           application/json:
             example: !include ../examples/business-unit.example.json
   head:
+    displayName: Check if BusinessUnit exists by ID
     securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
     description: Checks if a BusinessUnit exists with the provided `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update BusinessUnit by ID
     securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
     body:
       application/json:
@@ -94,6 +104,7 @@ post:
           application/json:
             example: !include ../examples/business-unit.example.json
   delete:
+    displayName: Delete BusinessUnit by ID
     securedBy: [oauth_2_0: { scopes: ['manage_business_units:{projectKey}'] }]
     responses:
       200:
@@ -142,7 +153,6 @@ post:
             example: !include ../examples/BusinessUnit/BusinessUnitAssociateResponseExample.json
 /search:
   type: base
-  displayName: Business Unit Search
   description: |
     This endpoint provides high-performance search queries over Business Units.
   post:
@@ -159,6 +169,7 @@ post:
           application/json:
             type: BusinessUnitPagedSearchResponse
   head:
+    displayName: Check if Business Unit Search index exists
     securedBy: [oauth_2_0: { scopes: ['view_business_units:{projectKey}'] }]
     description: |
       Checks whether a search index of Business Units exists for a Project.
@@ -170,9 +181,8 @@ post:
         description: A search index does not exist and the [Search Business Units](ctp:api:endpoint:/{projectKey}/business-units/search:POST) endpoint returns a 409 error.
 /search/indexing-status:
   type: base
-  displayName: Business Unit Search Status
   get:
-    displayName: Business Unit Search Status
+    displayName: Get indexing status of Business Unit Search
     description: |
       Returns the indexing status of the Business Unit Search for a Project.
     securedBy: [oauth_2_0: { scopes: ['view_project_settings:{projectKey}'] }]

api-specs/api/resources/business-units.raml

@@ -10,6 +10,7 @@ type:
 (createable): CustomerGroupDraft
 description: customer-groups are used to evaluate products and channels.
 get:
+  displayName: Query CustomerGroups
   queryParameters:
     where:
       description: |-
@@ -31,6 +32,7 @@ get:
         application/json:
           example: !include ../examples/customer-groups.example.json
 head:
+  displayName: Check if CustomerGroup exists by Query Predicate
   securedBy:
     [
       oauth_2_0:
@@ -47,6 +49,7 @@ head:
     where?:
       type: QueryPredicate[]
 post:
+  displayName: Create CustomerGroup
   securedBy:
     [
       oauth_2_0:
@@ -74,6 +77,7 @@ post:
       resourceType: CustomerGroup
       resourceUpdateType: CustomerGroupUpdate
   get:
+    displayName: Get CustomerGroup by Key
     securedBy:
       [
         oauth_2_0:
@@ -91,6 +95,7 @@ post:
           application/json:
             example: !include ../examples/customer-group.example.json
   head:
+    displayName: Check if CustomerGroup exists by Key
     securedBy:
       [
         oauth_2_0:
@@ -104,6 +109,7 @@ post:
       ]
     description: Checks if a CustomerGroup exists with the provided `key`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update CustomerGroup by Key
     securedBy:
       [
         oauth_2_0:
@@ -125,6 +131,7 @@ post:
           application/json:
             example: !include ../examples/customer-group.example.json
   delete:
+    displayName: Delete CustomerGroup by Key
     securedBy:
       [
         oauth_2_0:
@@ -149,6 +156,7 @@ post:
       resourceType: CustomerGroup
       resourceUpdateType: CustomerGroupUpdate
   get:
+    displayName: Get CustomerGroup by ID
     securedBy:
       [
         oauth_2_0:
@@ -166,6 +174,7 @@ post:
           application/json:
             example: !include ../examples/customer-group.example.json
   head:
+    displayName: Check if CustomerGroup exists by ID
     securedBy:
       [
         oauth_2_0:
@@ -179,6 +188,7 @@ post:
       ]
     description: Checks if a CustomerGroup exists with the provided `id`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise.
   post:
+    displayName: Update CustomerGroup by ID
     securedBy:
       [
         oauth_2_0:
@@ -199,6 +209,7 @@ post:
           application/json:
             example: !include ../examples/customer-group.example.json
   delete:
+    displayName: Delete CustomerGroup by ID
     securedBy:
       [
         oauth_2_0: