Skip to content

Commit b3b0734

Browse files
committed
Updated API from documentation release
1 parent 78e9e01 commit b3b0734

File tree

8 files changed

+11
-10
lines changed

8 files changed

+11
-10
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ 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/product-projection-search#full-text-search).
55+
Used by [Search Term Suggestions](/projects/search-term-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search) in the Product Projection Search API.
5656
attributes:
5757
type: Attribute[]
5858
(beta): true

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ properties:
6666
searchKeywords?:
6767
type: SearchKeywords
6868
description: |
69-
Used by [Product Suggestions](/projects/products-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search).
69+
Used by [Search Term Suggestions](/projects/search-term-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search) in the Product Projection Search API.
7070
state?:
7171
type: StateResourceIdentifier
7272
description: |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ properties:
6767
searchKeywords?:
6868
type: SearchKeywords
6969
description: |
70-
Used by [Product Suggestions](/../api/projects/products-suggestions), but is also considered for a [full text search](ctp:api:type:FullTextSearch).
70+
Used by [Search Term Suggestions](/../api/projects/search-term-suggestions), but is also considered for a [full text search](/projects/product-projection-search#full-text-search) in the Product Projection Search API.
7171
hasStagedChanges?:
7272
type: boolean
7373
description: |

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ type: object
66
key: Locale
77
value: SearchKeyword[]
88
description: |
9-
Although search keywords are primarily used by [Product Suggestions](/projects/products-suggestions), they are also considered for a [full text search](/projects/products-search#full-text-search). The keys are of type [Locale](ctp:api:type:Locale), and the values are an array of [SearchKeyword](ctp:api:type:SearchKeyword).
9+
Search keywords are JSON objects primarily used by [Search Term Suggestions](/projects/search-term-suggestions), but are also considered for a [full text search](/projects/product-projection-search#full-text-search) in the Product Projection Search API.
10+
The keys are of type [Locale](ctp:api:type:Locale), and the values are an array of [SearchKeyword](ctp:api:type:SearchKeyword).
1011
example: !include ../../examples/Product/SearchKeywords.json
1112
properties:
1213
/^[a-z]{2}(-[A-Z]{2})?$/:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ properties:
99
items: Suggestion
1010
description: |
1111
The result may contain multiple Suggestions identified by their [Locale](ctp:api:type:Locale).
12-
See [Suggestions for two languages](/projects/products-suggestions#suggestions-for-two-languages).
12+
See [Suggestions for two languages](/projects/search-term-suggestions#suggestions-for-two-languages).

api-specs/api/types/project/SearchIndexingConfiguration.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: |
77
properties:
88
products?:
99
type: SearchIndexingConfigurationValues
10-
description: Configuration for the [Product Projection Search](/../api/projects/product-projection-search) and [Product Suggestions](/../api/projects/products-suggestions) endpoints.
10+
description: Configuration for the [Product Projection Search](/../api/projects/product-projection-search) and [Search Term Suggestions](/../api/projects/search-term-suggestions) APIs.
1111
productsSearch?:
1212
type: SearchIndexingConfigurationValues
1313
description: Configuration for the [Product Search](/../api/projects/product-search) feature.

api-specs/api/types/project/updates/ProjectChangeProductSearchIndexingEnabledAction.raml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ properties:
88
enabled:
99
type: boolean
1010
description: |
11-
- If `false`, the indexing of [Product](ctp:api:type:Product) information will stop and the [Product Projection Search](/../api/projects/product-projection-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will not be available anymore for this Project. The Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be changed to `"Deactivated"`.
12-
- If `true`, the indexing of [Product](ctp:api:type:Product) information will start and the [Product Projection Search](/../api/projects/product-projection-search) as well as the [Product Suggestions](/../api/projects/products-suggestions) endpoint will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be shown as `"Indexing"` during this time. As soon as the indexing has finished, the configuration status will be changed to `"Activated"` making the aforementioned endpoints fully available for this Project.
11+
- If `false`, the indexing of [Product](ctp:api:type:Product) information will stop and the [Product Projection Search](/../api/projects/product-projection-search) as well as the [Search Term Suggestions](/../api/projects/search-term-suggestions) API will no longer be available for this Project. The Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be changed to `"Deactivated"`.
12+
- If `true`, the indexing of [Product](ctp:api:type:Product) information will start and the [Product Projection Search](/../api/projects/product-projection-search) as well as the [Search Term Suggestions](/../api/projects/search-term-suggestions) API will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's [SearchIndexingConfiguration](ctp:api:type:SearchIndexingConfiguration) `status` for `products` will be shown as `"Indexing"` during this time. As soon as the indexing has finished, the configuration status will be changed to `"Activated"` making the aforementioned APIs fully available for this Project.
1313
mode?:
1414
type: ProductSearchIndexingMode
1515
description: |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ types:
3737
type: string
3838
suggestTokenizer?:
3939
type: SuggestTokenizer
40-
description: The tokenizer defines the tokens that are used to match against the [Suggest Query](/../products-suggestions#query-suggestions) input.
40+
description: The tokenizer defines the tokens that are used for [search term suggestions](/projects/search-term-suggestions).
4141
SuggestTokenizer:
4242
discriminator: type
4343
properties:
4444
type:
4545
type: string
4646
description: |
47-
The tokenizer defines the tokens that are used to match against the [Suggest Query](/../products-suggestions#query-suggestions) input.
47+
The tokenizer defines the tokens that are used for [search term suggestions](/projects/search-term-suggestions).
4848
CustomTokenizer:
4949
type: SuggestTokenizer
5050
discriminatorValue: custom

0 commit comments

Comments
 (0)