Skip to content

Commit e18cd80

Browse files
committed
Updated API from documentation release
1 parent f28a146 commit e18cd80

File tree

6 files changed

+30
-12
lines changed

6 files changed

+30
-12
lines changed

api-specs/api/types/order-search/OrderSearchCustomType.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 DataType
22
(package): Order
33
displayName: OrderSearchCustomType
4-
description: Possible values for the `customType` property on [query expressions](/../api/projects/order-search#query-expressions) indicating the data type of the `field`.
4+
description: Possible values for the `customType` property on [simple expressions](/../api/projects/order-search#simple-expressions) indicating the data type of the `field`.
55
type: string
66
enum:
77
- BooleanType

api-specs/api/types/product-search/ProductSearchMatchingVariantEntry.raml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ properties:
66
id:
77
type: number
88
format: int32
9-
description: Unique identifier of the variant.
9+
description: |
10+
`id` of the [ProductVariant](ctp:api:type:ProductVariant) that matches the search query.
1011
sku?:
1112
type: string
12-
description: SKU of the matching variant.
13+
description: |
14+
`sku` of the ProductVariant that matches the search query.

api-specs/api/types/product-search/ProductSearchMatchingVariants.raml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ type: object
55
properties:
66
allMatched:
77
type: boolean
8-
description: Whether the search criteria definitely matches all Variants of the returned Product, like for Product-level fields. Is always `false` for search expressions on Variant-level fields.
8+
description: |
9+
`true` if all Variants of the returned Product match the search query, or if search query does not specify any expression for a [Product Variant field](/../api/projects/product-search#field-levels).
10+
11+
`false` if only a subset of the Product Variants match the search query.
12+
13+
Is always `false` for query expressions on Product Variant fields.
914
matchedVariants:
1015
type: ProductSearchMatchingVariantEntry[]
11-
description: The variants matching the search criteria or empty if all matched.
16+
description: |
17+
Identifiers of the Product Variants that match the search query.
18+
19+
Empty if all Product Variants of the returned Product match.

api-specs/api/types/product-search/ProductSearchRequest.raml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ properties:
3030
markMatchingVariants?:
3131
type: boolean
3232
default: false
33-
description: The search can return Products where not all Product Variants match the search criteria. If `true`, the response will include a field called `matchingVariants` that contains the `sku` of Product Variants that match the search query. If the query does not specify any variant-level criteria, `matchingVariants` will be null signifying that all Product Variants are a match.
33+
description: |
34+
If `query` specifies an expression for a Product Variant field,
35+
set this to `true` to get additional information for each returned Product about which Product Variants match the search query.
36+
For details, see [matching variants](/../api/projects/product-search#matching-variants).
3437
productProjectionParameters?:
3538
type: ProductSearchProjectionParams
3639
(beta): true

api-specs/api/types/product-search/ProductSearchResult.raml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@ properties:
66
id:
77
(identifier): true
88
type: string
9-
description: Unique identifier of the Product.
9+
description: |
10+
`id` of the [Product](ctp:api:type:Product) that matches the search query.
11+
matchingVariants?:
12+
type: ProductSearchMatchingVariants
13+
description: |
14+
Information about which Product Variants match the search query.
15+
Only present if `markMatchingVariants` is set to `true` in the [ProductSearchRequest](ctp:api:type:ProductSearchRequest).
1016
productProjection?:
1117
type: ProductProjection
1218
(beta): true
13-
description: Contains Product Projection data for Products matching the `projection` field in the Search Products request.
14-
matchingVariants?:
15-
type: ProductSearchMatchingVariants
16-
description: Describes the variants that matched the search criteria.
19+
description: |
20+
Projected data of the Product with `id`.
21+
Only present if data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters) is requested.

api-specs/api/types/search/SearchFieldType.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#%RAML 1.0 DataType
22
(package): Search
33
displayName: SearchFieldType
4-
description: Possible values for the `fieldType` property on [query expressions](/../api/search-query-language#query-expressions) indicating the data type of the `field`.
4+
description: Possible values for the `fieldType` property on [simple expressions](/../api/search-query-language#simple-expressions) indicating the data type of the `field`.
55
type: string
66
enum:
77
- boolean

0 commit comments

Comments
 (0)