Skip to content

Commit 315719f

Browse files
committed
Updated API from documentation release
1 parent e69406a commit 315719f

File tree

7 files changed

+14
-10
lines changed

7 files changed

+14
-10
lines changed

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
(package): ProductType
33
displayName: AttributeDefinition
44
type: object
5-
description: |
6-
Describes an Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
75
properties:
86
type:
97
type: AttributeType
@@ -43,8 +41,9 @@ properties:
4341
type: boolean
4442
description: |-
4543
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.
44+
However, if an Attribute's `level` is set as `Product`, then Product Projection Search does **not support** the Attribute.
4645
47-
Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
46+
The exact features that are available with this flag depend on the specific [AttributeType](ctp:api:type:AttributeType).
4847
The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
4948
This constraint is enforced at both [Product creation](ctp:api:endpoint:/{projectKey}/products:POST) and [Product update](/../api/projects/products#update-product).
5049
If the length of the input exceeds the maximum size, an [InvalidField](ctp:api:type:InvalidFieldError) error is returned.

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,12 @@ properties:
5252
isSearchable?:
5353
type: boolean
5454
description: |-
55-
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.
55+
Set as `true` if you want the Attribute's values to 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.
56+
If an Attribute's `level` is set as `Product`, then Product Projection Search does **not support** the Attribute.
57+
58+
5659
Which exact features are available with this flag depends on the specific [AttributeType](ctp:api:type:AttributeType).
5760
The maximum size of a searchable field is **restricted** by the [Field content size limit](/../api/limits#field-content-size).
5861
This constraint is enforced at both Product creation and Product update.
59-
If the length of the input exceeds the maximum size, an InvalidField error is returned.
62+
If the length of the input exceeds the maximum size, an [InvalidField](ctp:api:type:InvalidFieldError) error is returned.
6063
default: true

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ enum:
77
- Product
88
- Variant
99
(enumDescriptions):
10-
Product: Attribute is defined at Product level.
10+
Product: Attribute is defined at Product level (**not supported** by [Product Projection Search](/projects/product-projection-search)).
1111
Variant: Attributes are defined at the Product Variant level.
1212
default: Variant

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,5 @@ properties:
5757
type: Attribute[]
5858
(beta): true
5959
description: |
60-
Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
60+
Product Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
61+
**Not supported** by [Product Projection Search](/projects/product-projection-search).

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,5 @@ properties:
8585
type: Attribute[]
8686
(beta): true
8787
description: |
88-
Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinitionDraft).
88+
Product Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinitionDraft).
89+
**Not supported** by [Product Projection Search](/projects/product-projection-search).

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ properties:
3030
attributes?:
3131
type: Attribute[]
3232
description: |
33-
Attributes of the Product Variant.
33+
Variant Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
3434
price?:
3535
type: Price
3636
description: |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ properties:
2222
attributes?:
2323
type: Attribute[]
2424
description: |
25-
Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
25+
Variant Attributes according to the respective [AttributeDefinition](ctp:api:type:AttributeDefinition).
2626
images?:
2727
type: Image[]
2828
description: |

0 commit comments

Comments
 (0)