Skip to content

Commit b32dd9c

Browse files
committed
Updated API from documentation release
1 parent ca3a3cd commit b32dd9c

18 files changed

+38
-38
lines changed

api-specs/api/resources/product-projections-search.raml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ get:
3737
type: boolean
3838
default: false
3939
description: |
40-
Set to `true` to mark [matching variants](/../api/projects/products-search#matching-variants) in the search result.
40+
Set to `true` to mark [matching variants](/../api/projects/product-projection-search#matching-variants) in the search result.
4141
#TODO clarify correct syntax
4242
/text\.[a-z]{2}(-[A-Z]{2})?/:
4343
(placeholderParam):
@@ -72,23 +72,23 @@ get:
7272
filter.query?:
7373
type: string[]
7474
description: |
75-
Applies a [filter](/../api/projects/products-search#filters) to the [query results](/../api/projects/products-search#query-results) before [facets](/../api/projects/products-search#facets) are calculated.
75+
Applies a [filter](/../api/projects/product-projection-search#filters) to the [query results](/../api/projects/product-projection-search#query-results) before [facets](/../api/projects/product-projection-search#facets) are calculated.
7676
This parameter has an impact on facet counts.
7777
If you don't use the `facet` parameter in the same request, use this parameter instead of `filter`.
7878
filter?:
7979
type: string[]
8080
description: |
81-
Applies a [filter](/../api/projects/products-search#filters) to the query results after facets are calculated.
81+
Applies a [filter](/../api/projects/product-projection-search#filters) to the query results after facets are calculated.
8282
This parameter does not have an impact on facet counts.
8383
Use this parameter in combination with the `facet` and `filter.facets` parameters for multi-select faceting.
8484
facet?:
8585
type: string[]
8686
description: |
87-
Requests calculation of [facets](/../api/projects/products-search#facets).
87+
Requests calculation of [facets](/../api/projects/product-projection-search#facets).
8888
filter.facets?:
8989
type: string[]
9090
description: |
91-
Applies a [filter](/../api/projects/products-search#filters) to the calculated [facet results](/../api/projects/products-search#facet-results), not to the Products returned with the [query results](/../api/projects/products-search#query-results).
91+
Applies a [filter](/../api/projects/product-projection-search#filters) to the calculated [facet results](/../api/projects/product-projection-search#facet-results), not to the Products returned with the [query results](/../api/projects/product-projection-search#query-results).
9292
A facet's own aggregation is not filtered by its corresponding `filter.facets` criteria.
9393
Use this parameter in combination with the `facet` and `filter` parameters for multi-select faceting.
9494
expand?:
@@ -98,7 +98,7 @@ get:
9898
sort?:
9999
type: string[]
100100
description: |
101-
Controls [sorting](/../api/projects/products-search#sorting) of results.
101+
Controls [sorting](/../api/projects/product-projection-search#sorting) of results.
102102
Use this parameter multiple times to sort by multiple fields.
103103
104104
* When `text` is provided, but no sort parameter is given, the results are returned in descending order of relevance (equivalent to `score desc`).
@@ -110,15 +110,15 @@ get:
110110
minimum: 0
111111
maximum: 500
112112
description: |
113-
The maximum number of results returned on a [page](/../api/projects/products-search#pagination).
113+
The maximum number of results returned on a [page](/../api/projects/product-projection-search#pagination).
114114
offset?:
115115
type: number
116116
format: int32
117117
default: 0
118118
minimum: 0
119119
maximum: 10000
120120
description: |
121-
The starting point for retrieving [paginated](/../api/projects/products-search#pagination) results.
121+
The starting point for retrieving [paginated](/../api/projects/product-projection-search#pagination) results.
122122
staged?:
123123
type: boolean
124124
description: |

api-specs/api/resources/product-projections-suggest.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ get:
2525
type: boolean
2626
default: false
2727
description: |
28-
If set to `true`, [fuzzy search](/../api/projects/products-search#fuzzy-search) is applied on the text to analyze.
28+
If set to `true`, [fuzzy search](/../api/projects/product-projection-search#fuzzy-search) is applied on the text to analyze.
2929
staged?:
3030
type: boolean
3131
default: false

api-specs/api/types/error/SyntaxErrorError.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: ErrorObject
44
displayName: SyntaxErrorError
55
discriminatorValue: SyntaxError
66
description: |
7-
Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
7+
Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/product-projection-search) does not have the correct syntax.
88
properties:
99
code:
1010
type: string

api-specs/api/types/error/graphql/GraphQLSyntaxErrorError.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: GraphQLErrorObject
44
displayName: GraphQLSyntaxErrorError
55
discriminatorValue: SyntaxError
66
description: |
7-
Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
7+
Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#use-predicates-in-conditional-api-extensions), or [search query](/../api/projects/product-projection-search) does not have the correct syntax.
88
properties:
99
code:
1010
type: string

api-specs/api/types/product-type/AttributeDefinition.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ properties:
3636
isSearchable:
3737
type: boolean
3838
description: |-
39-
If `true`, the Attribute's values are available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/products-search) API for use in full-text search queries, filters, and facets.
39+
If `true`, the Attribute's values are available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/product-projection-search) API for use in full-text search queries, filters, and facets.
4040
4141
Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
4242
The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).

api-specs/api/types/product-type/AttributeDefinitionDraft.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ properties:
4545
isSearchable?:
4646
type: boolean
4747
description: |-
48-
Set to `true` if the Attribute's values should be available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/products-search) API and can be used in full-text search queries, filters, and facets.
48+
Set to `true` if the Attribute's values should be available in the [Product Search](/../api/projects/product-search) or the [Product Projection Search](/../api/projects/product-projection-search) API and can be used in full-text search queries, filters, and facets.
4949
Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
5050
The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
5151
This constraint is enforced at both Product creation and Product update.

api-specs/api/types/product/FacetRange.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ properties:
3838
description: |
3939
Number of [Products](ctp:api:type:Product) for which the values in a field fall into the specified range.
4040
41-
Present only if the `counting products` [extension](/projects/products-search#counting-products) is enabled.
41+
Present only if the `counting products` [extension](/projects/product-projection-search#counting-products) is enabled.
4242
total:
4343
type: number
4444
description: |

api-specs/api/types/product/FacetTerm.raml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ properties:
66
term:
77
type: any
88
description: |
9-
Value for the field specified in the [term facet expression](/../api/projects/products-search#term-facet-expression) for which at least one [ProductVariant](ctp:api:type:ProductVariant) could be found.
9+
Value for the field specified in the [term facet expression](/../api/projects/product-projection-search#term-facet-expression) for which at least one [ProductVariant](ctp:api:type:ProductVariant) could be found.
1010
count:
1111
type: number
1212
format: int64
@@ -17,4 +17,4 @@ properties:
1717
format: int64
1818
description: |
1919
Number of [Products](ctp:api:type:Product) for which the `term` applies.
20-
Only available if the `counting products` [extension](/../api/projects/products-search#counting-products) is enabled.
20+
Only available if the `counting products` [extension](/../api/projects/product-projection-search#counting-products) is enabled.

api-specs/api/types/product/FilteredFacetResult.raml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ properties:
88
type: number
99
format: int64
1010
description: |
11-
Number of [ProductVariants](ctp:api:type:ProductVariant) matching the value specified in [filtered facet expression](/../api/projects/products-search#filtered-facet-expression).
11+
Number of [ProductVariants](ctp:api:type:ProductVariant) matching the value specified in [filtered facet expression](/../api/projects/product-projection-search#filtered-facet-expression).
1212
productCount?:
1313
type: number
1414
format: int64
1515
description: |
16-
Number of [Products](ctp:api:type:Product) matching the value specified in [filtered facet expression](/../api/projects/products-search#filtered-facet-expression).
16+
Number of [Products](ctp:api:type:Product) matching the value specified in [filtered facet expression](/../api/projects/product-projection-search#filtered-facet-expression).
1717
18-
Present only if the `counting products` [extension](/projects/products-search#counting-products) is enabled.
18+
Present only if the `counting products` [extension](/projects/product-projection-search#counting-products) is enabled.

api-specs/api/types/product/ProductData.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ properties:
5252
searchKeywords:
5353
type: SearchKeywords
5454
description: |
55-
Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/products-search#full-text-search).
55+
Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).

0 commit comments

Comments
 (0)