Skip to content

Commit 6a8624f

Browse files
committed
Updated API from documentation release
1 parent a639dbb commit 6a8624f

File tree

3 files changed

+47
-9
lines changed

3 files changed

+47
-9
lines changed

api-specs/history/api.raml

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ annotationTypes:
3636
package:
3737
type: string
3838
allowedTargets: TypeDeclaration
39+
enumDescriptions:
40+
description: |
41+
Describes the values of an enum type.
42+
type: object
43+
properties:
44+
//:
45+
description: |
46+
Adds a description for the enum value given by the key.
3947
(products):
4048
- Composable Commerce
4149
description: Fetch all Records from all resource types that match queryParameters.
@@ -253,9 +261,9 @@ resourceTypes:
253261
description: |
254262
[Key](/general-concepts#identifier) of the changed resource. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Associate Roles](ctp:api:type:AssociateRole), [Products](ctp:api:type:Product), and [Stores](ctp:api:type:Store) can be filtered.
255263
source?:
256-
type: string
264+
type: Source
257265
description: |
258-
Source from which changes were made: `"MerchantCenter"`, `"ImpEx"`, or `"ApiClient"`.
266+
Source of the change.
259267
changes?:
260268
type: string[]
261269
description: |
@@ -403,9 +411,9 @@ resourceTypes:
403411
description: |
404412
[Key](/general-concepts#identifier) of the changed resource. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Associate Roles](ctp:api:type:AssociateRole), [Products](ctp:api:type:Product), and [Stores](ctp:api:type:Store) can be filtered.
405413
source?:
406-
type: string
414+
type: Source
407415
description: |
408-
Name of the source with which changes were made. Can be `"MerchantCenter"`, `"ImpEx"`, or `"ApiClient"`.
416+
Source of the change.
409417
changes?:
410418
type: string[]
411419
description: |
@@ -517,9 +525,9 @@ resourceTypes:
517525
Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`.
518526
Can be used to filter for a specific type of change.
519527
source?:
520-
type: string
528+
type: Source
521529
description: |
522-
Name of the source with which changes were made. Can be `"MerchantCenter"`, `"ImpEx"`, or `"ApiClient"`.
530+
Source of the change.
523531
changes?:
524532
type: string[]
525533
description: |

api-specs/history/types/ChangeHistoryResourceType.raml

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,32 @@ enum:
2929
- 'tax-category'
3030
- 'type'
3131
- 'zone'
32+
(enumDescriptions):
33+
associate-role: for [AssociateRole](/projects/associate-roles#associaterole)
34+
business-unit: for [BusinessUnit](/projects/business-units#businessunit)
35+
cart-discount: for [CartDiscount](/projects/cartDiscounts#cartdiscount)
36+
category: for [Category](/projects/categories#category)
37+
channel: for [Channel](/projects/channels#channel)
38+
customer: for [Customer](/projects/customers#customer)
39+
customer-group: for [CustomerGroup](/projects/customerGroups#customergroup)
40+
discount-code: for [DiscountCode](/projects/discountCodes#discountcode)
41+
inventory-entry: for [InventoryEntry](/projects/inventory#inventoryentry)
42+
key-value-document: for [CustomObject](/projects/custom-objects#customobject)
43+
order: for [Order](/projects/orders#order)
44+
payment: for [Payment](/projects/payments#payment)
45+
product: for [Product](/projects/products#product)
46+
product-discount: for [ProductDiscount](/projects/productDiscounts#productdiscount)
47+
product-selection: for [ProductSelection](/projects/product-selections#productselection)
48+
product-type: for [ProductType](/projects/productTypes#producttype)
49+
quote-request: for [QuoteRequest](/projects/quote-requests#quoterequest)
50+
quote: for [Quote](/projects/quotes#quote)
51+
review: for [Review](/projects/reviews#review)
52+
shopping-list: for [ShoppingList](/projects/shoppingLists#shoppinglist)
53+
state: for [State](/projects/states#state)
54+
staged-quote: for [StagedQuote](/projects/staged-quotes#stagedquote)
55+
store: for [Store](/projects/stores#store)
56+
tax-category: for [TaxCategory](/projects/taxCategories#taxcategory)
57+
type: for [Type](/projects/types#type)
58+
zone: for [Zone](/projects/zones#zone)
3259
description: |
33-
This data type represents the supported resource types.
34-
The value must be one of the following:
60+
Value of resource types supported in Change History.

api-specs/history/types/Source.raml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ enum:
66
- 'MerchantCenter'
77
- 'ImpEx'
88
- 'ApiClient'
9-
description: Values for the Source enumeration.
9+
description: Source of change for the resource.
10+
(enumDescriptions):
11+
MerchantCenter: The change was made through the Merchant Center.
12+
ApiClient: The change was made through an API Client.
13+
ImpEx: The change was made through ImpEx.

0 commit comments

Comments
 (0)