Skip to content

Commit 6bf90bd

Browse files
committed
Updated API from documentation release
1 parent 7c84666 commit 6bf90bd

File tree

4 files changed

+21
-0
lines changed

4 files changed

+21
-0
lines changed

api-specs/api/api.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ traits:
3737
localeProjecting: !include traits/locale-projecting.raml
3838
storeProjecting: !include traits/store-projecting.raml
3939
storeProjectingTailoring: !include traits/store-projecting-tailoring.raml
40+
attributeFiltering: !include traits/attribute-filtering.raml
4041
dataErasure: !include traits/data-erasure.raml
4142
types: !include types/types.raml
4243
mediaType: application/json

api-specs/api/resources/in-store/product-projections-in-store.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
- projectionSelectingTailoring
3131
- priceSelecting
3232
- localeProjecting
33+
- attributeFiltering
3334
head:
3435
displayName: Check if ProductProjection exists in Store by Key
3536
securedBy:
@@ -76,6 +77,7 @@
7677
- projectionSelectingTailoring
7778
- priceSelecting
7879
- localeProjecting
80+
- attributeFiltering
7981
head:
8082
displayName: Check if ProductProjection exists in Store by ID
8183
securedBy:

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ get:
3030
- priceSelecting
3131
- localeProjecting
3232
- storeProjectingTailoring
33+
- attributeFiltering
3334
responses:
3435
200:
3536
body:
@@ -82,6 +83,7 @@ head:
8283
- priceSelecting
8384
- localeProjecting
8485
- storeProjectingTailoring
86+
- attributeFiltering
8587
responses:
8688
200:
8789
body:
@@ -127,6 +129,7 @@ head:
127129
- priceSelecting
128130
- localeProjecting
129131
- storeProjectingTailoring
132+
- attributeFiltering
130133
responses:
131134
200:
132135
body:
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#%RAML 1.0 Trait
2+
3+
queryParameters:
4+
filter[attributes]:
5+
type: string[]
6+
required: false
7+
description: |
8+
Use for [Attribute-based filtering](/../api/projects/productProjections#attributes).
9+
10+
Specify Attribute names that you want to include or exclude from the response.
11+
To exclude an Attribute, add a dash (`-`) before the Attribute name.
12+
13+
For example, `filter[attributes]=color&filter[attributes]=size` includes the `color` and `size` Attributes. And `filter[attributes]=-description&filter[attributes]=-specifications` excludes the `description` and `specifications` Attributes.
14+
15+
If you specify multiple Attributes to be included and excluded from the response, then the Attributes you want to include are processed before the ones you want to exclude.

0 commit comments

Comments
 (0)