Skip to content

Commit

Permalink
Updated API from documentation release
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Aug 12, 2024
1 parent 8695934 commit 9b3af92
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
type: object
(beta): true
displayName: ProductSearchProjectionParams
description: |
The query parameters used for [data integration with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
properties:
expand?:
type: Expansion[]
Expand Down
13 changes: 8 additions & 5 deletions api-specs/api/types/product-search/ProductSearchRequest.raml
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,23 @@ properties:
The search query against [searchable Product fields](/../api/projects/product-search#searchable-product-fields).
sort?:
type: SearchSorting[]
description: Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.
description: |
Controls how results to your query are [sorted](/../api/projects/product-search#sorting).
If not provided, the results are sorted by relevance score in descending order.
limit?:
type: number
format: int32
default: 20
maximum: 100
description: The maximum number of search results to be returned.
description: |
The maximum number of search results to be returned in one [page](/../api/projects/product-search#pagination).
offset?:
type: number
format: int32
default: 0
maximum: 9900
description: The number of search results to be skipped in the response for pagination.
description: |
The number of search results to be skipped in the response for [pagination](/../api/projects/product-search#pagination).
markMatchingVariants?:
type: boolean
default: false
Expand All @@ -31,8 +35,7 @@ properties:
type: ProductSearchProjectionParams
(beta): true
description: |
Set this field to `{}` to get the [ProductProjection](ctp:api:type:ProductProjection) included in the [ProductSearchResult](ctp:api:type:ProductSearchResult).
Include query parameters for controlling [Reference Expansion](/../api/general-concepts#reference-expansion) or [projections](/../api/projects/productProjections#projection-dimensions) according to your needs.
Controls data integration [with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
If not set, the result does not include the Product Projection.
facets?:
type: ProductSearchFacetExpression[]
Expand Down
4 changes: 1 addition & 3 deletions api-specs/api/types/search/SearchSorting.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,11 @@ type: object
displayName: SearchSorting
description: |
Sorting parameters provided with a Search request.
Sorting allows you to control how results to your query are sorted.
If no sorting is specified, the results are sorted by relevance in descending (`desc`) order.
properties:
field:
type: string
description: |
Use any searchable field of the resource as sort criterion.
Use any searchable field of the resource as sort criterion, or `"score"` to sort by relevance score calculated by the API.
language?:
type: Locale
order:
Expand Down

0 comments on commit 9b3af92

Please sign in to comment.