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 7, 2024
1 parent ea8f408 commit af55f7d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 17 deletions.
5 changes: 3 additions & 2 deletions api-specs/api/resources/product-projections-search.raml
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ get:
The fuzzy level desired, if fuzzy is enabled. This value cannot exceed the default value that is calculated based on the length of the searched text.
markMatchingVariants?:
type: boolean
default: false
description: |
if `markMatchingVariants` parameter is `true` those ProductVariants that match the search query have the additional
field `isMatchingVariant` set to `true`. For the other variants in the same product projection this field is set to `false`.
If `markMatchingVariants` parameter is `true`, those ProductVariants that match the search query have the additional
field `isMatchingVariant` set to `true`. For the other variants in the same product projection, this field is set to `false`.
filter?:
type: string[]
filter.facets?:
Expand Down
6 changes: 2 additions & 4 deletions api-specs/api/resources/product-projections-suggest.raml
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,13 @@ get:
The default limit is `10` Suggestions per language and the maximum is `100`.
fuzzy?:
type: boolean
default: false
description: |
Defaults to `false`.
If set to `true`, [fuzzy search](/../api/projects/products-search#fuzzy-search) is applied on the text to analyze.
staged?:
type: boolean
default: false
description: |
Defaults to `false`.
If set to `true` (possible only while using the `view_products` scope), staged projections is queried.
is:
- projectionSelecting
Expand Down
4 changes: 2 additions & 2 deletions api-specs/api/traits/data-erasure.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ queryParameters:
dataErasure:
type: boolean
required: false
default: false
description: |
Defaults to `false`.
Set to `true` if you want to [erase all related personal data](/../api/gdpr#data-erasure-of-personal-data) in compliance with GDPR.
To [erase all related personal data](/../api/gdpr#data-erasure-of-personal-data) in compliance with GDPR, set to `true`.
4 changes: 1 addition & 3 deletions api-specs/api/traits/projection-selecting.raml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ queryParameters:
type: boolean
default: false
description: |
Defaults to `false`.
Set to `true` to retrieve the [staged](ctp:api:type:CurrentStaged) Product Projection
(only for API Clients that have the `view_products:{projectKey}` scope).
To retrieve the [staged](ctp:api:type:CurrentStaged) Product Projection (only for API Clients that have the `view_products:{projectKey}` scope), set to `true`.
17 changes: 11 additions & 6 deletions api-specs/history/api.raml
Original file line number Diff line number Diff line change
Expand Up @@ -189,14 +189,16 @@ resourceTypes:
example: ['order', 'product']
date.from?:
type: number | datetime | DateStringFilter
default: 24
description: |
Can be [DateTime](/types#datetime), non-negative integer, or `now`. Defaults to `24`.
Can be [DateTime](/types#datetime), non-negative integer, or `now`.
The non-negative integer represents a point in time in the past measured in hours, for example, `24` means 24 hours ago.
Can only be used together with the `date.to` query parameter, which has to represent a point in time after the value defined by `date.from`.
date.to?:
type: number | datetime | DateStringFilter
default: 'now'
description: |
Can be [DateTime](/types#datetime), non-negative integer, or `now`. Defaults to `now`.
Can be [DateTime](/types#datetime), non-negative integer, or `now`.
The non-negative integer represents a point in time in the past measured in hours, for example, `24` means 24 hours ago.
Can only be used together with the `date.from` query parameter, which has to represent a point in time before the value defined by `date.to`.
limit?:
Expand Down Expand Up @@ -346,13 +348,14 @@ resourceTypes:
type: number | datetime | DateStringFilter
default: 24
description: |
Can be [DateTime](/types#datetime), non-negative integer, or `now`. Defaults to `24`.
Can be [DateTime](/types#datetime), non-negative integer, or `now`.
The non-negative integer represents a point in time in the past measured in hours, for example, `24` means 24 hours ago.
Can only be used together with the `date.to` query parameter, which has to represent a point in time after the value defined by `date.from`.
date.to?:
type: number | datetime | DateStringFilter
default: 'now'
description: |
Can be [DateTime](/types#datetime), non-negative integer, or `now`. Defaults to `now`.
Can be [DateTime](/types#datetime), non-negative integer, or `now`.
The non-negative integer represents a point in time in the past measured in hours, for example, `24` means 24 hours ago.
Can only be used together with the `date.from` query parameter, which has to represent a point in time before the value defined by `date.to`.
limit?:
Expand Down Expand Up @@ -461,14 +464,16 @@ resourceTypes:
queryParameters:
date.from?:
type: number | datetime | DateStringFilter
default: 24
description: |
Can be [DateTime](/types#datetime), non-negative integer, or `now`. Defaults to `24`.
Can be [DateTime](/types#datetime), non-negative integer, or `now`.
The non-negative integer represents a point in time in the past from now measured in hours, for example, `24` means 24 hours ago.
Can only be used together with the `date.to` query parameter, which has to represent a point in time after the value defined by `date.from`.
date.to?:
type: number | datetime | DateStringFilter
default: 'now'
description: |
Can be [DateTime](/types#datetime), non-negative integer, or `now`. Defaults to `now`.
Can be [DateTime](/types#datetime), non-negative integer, or `now`.
The non-negative integer represents a point in time in the past from now measured in hours, for example, `24` means 24 hours ago.
Can only be used together with the `date.from` query parameter, which has to represent a point in time before the value defined by `date.to`.
limit?:
Expand Down

0 comments on commit af55f7d

Please sign in to comment.