Skip to content

Commit 0f1227c

Browse files
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent 3505c94 commit 0f1227c

1 file changed

Lines changed: 54 additions & 14 deletions

File tree

oas/api/openapi.yaml

Lines changed: 54 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17517,13 +17517,22 @@ paths:
1751717517
- "view_published_products:{projectKey}"
1751817518
operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet
1751917519
description: |-
17520-
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its key in the specified [Store](ctp:api:type:Store).
17520+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key in the specified [Store](ctp:api:type:Store).
17521+
1752117522
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
1752217523
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
1752317524
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
1752417525
If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/api/project-configuration-overview#products-available-in-store) in the specified Store.
1752517526
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `key` and the given Store, this endpoint returns the ProductProjection with tailored data.
17526-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
17527+
17528+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
17529+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
17530+
17531+
Required access scopes:
17532+
17533+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
17534+
17535+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
1752717536
parameters:
1752817537
- name: staged
1752917538
x-annotation-default: false
@@ -17678,13 +17687,22 @@ paths:
1767817687
- "view_published_products:{projectKey}"
1767917688
operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet
1768017689
description: |-
17681-
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID in the specified [Store](ctp:api:type:Store).
17690+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID in the specified [Store](ctp:api:type:Store).
17691+
1768217692
If the Store has defined some languages, countries, distribution, supply Channels, and/or Product Selection,
1768317693
they are used for projections based on [locale](ctp:api:type:ProductProjectionLocales), [price](ctp:api:type:ProductProjectionPrices),
1768417694
and [inventory](ctp:api:type:ProductProjectionInventoryEntries).
1768517695
If [ProductSelection](ctp:api:type:ProductSelection) is used, it affects the [availability of the Product](/api/project-configuration-overview#products-available-in-store) in the specified Store.
17686-
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `id` and the given Store, this endpoint returns the ProductProjection with tailored data.
17687-
When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
17696+
If a [ProductTailoring](ctp:api:type:ProductTailoring) exists for the Product with the given `key` and the given Store, this endpoint returns the ProductProjection with tailored data.
17697+
17698+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
17699+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
17700+
17701+
Required access scopes:
17702+
17703+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
17704+
17705+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
1768817706
parameters:
1768917707
- name: staged
1769017708
x-annotation-default: false
@@ -28429,9 +28447,16 @@ paths:
2842928447
- "view_published_products:{projectKey}"
2843028448
operationId: ByProjectKeyProductProjectionsGet
2843128449
description: |-
28432-
Use the Product Projections query endpoint to get the current or staged representations of Products.
28433-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
28434-
this endpoint only returns published (current) Product Projections.
28450+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of [Products](ctp:api:type:Product) by [query predicates](/../api/predicates/query).
28451+
28452+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
28453+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
28454+
28455+
Required access scopes:
28456+
28457+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
28458+
28459+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
2843528460
parameters:
2843628461
- name: staged
2843728462
x-annotation-default: false
@@ -28651,9 +28676,16 @@ paths:
2865128676
- "view_published_products:{projectKey}"
2865228677
operationId: ByProjectKeyProductProjectionsKeyByKeyGet
2865328678
description: |-
28654-
Gets the current or staged representation of a [Product](ctp:api:type:Product) found by Key.
28655-
When used with an API Client that has the `view_published_products:{projectKey}` scope,
28656-
this endpoint only returns published (current) Product Projections.
28679+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its Key.
28680+
28681+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
28682+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
28683+
28684+
Required access scopes:
28685+
28686+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
28687+
28688+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
2865728689
parameters:
2865828690
- name: staged
2865928691
x-annotation-default: false
@@ -29136,7 +29168,16 @@ paths:
2913629168
- "view_published_products:{projectKey}"
2913729169
operationId: ByProjectKeyProductProjectionsByIDGet
2913829170
description: |-
29139-
Gets the current or staged representation of a [Product](ctp:api:type:Product) by its ID. When used with an API Client that has the `view_published_products:{projectKey}` scope, this endpoint only returns published (current) Product Projections.
29171+
Retrieves the [projected](/../api/projects/productProjections#projection-dimensions) representation of a [Product](ctp:api:type:Product) by its ID.
29172+
29173+
By default, this endpoint returns the `current` representation of Products where the `published` flag is `true`.
29174+
If a Product is unpublished (`published=false`), the endpoint returns a [Not Found](/../api/errors#404-not-found) error.
29175+
29176+
Required access scopes:
29177+
29178+
- To retrieve the current representation of published Products (published data), the `view_published_products:{projectKey}` scope is required.
29179+
29180+
- To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the `view_products:{projectKey}` scope.
2914029181
parameters:
2914129182
- name: staged
2914229183
x-annotation-default: false
@@ -80874,8 +80915,7 @@ components:
8087480915
x-annotation-package: "Cart"
8087580916
x-annotation-enumDescriptions:
8087680917
All: "Publishes a Product that causes the _staged_ projection of the Product to override
80877-
the _current_ projection. If the Product is published for the first time, the
80878-
_current_ projection is created. This is the default scope."
80918+
the _current_ projection. This is the default scope."
8087980919
Prices: "Publishes the Prices of the Product (only if the Product is already published).
8088080920
All Product Variants' Prices in the _staged_ projection are published into the
8088180921
_current_ projection with the same `id`. Prices in a _staged_ Product Variant

0 commit comments

Comments
 (0)