Skip to content

Commit c7b825b

Browse files
meganelepalud-akeneomeganelepalud-akeneo
committed
to squash
1 parent 24a425b commit c7b825b

File tree

6 files changed

+167
-5
lines changed

6 files changed

+167
-5
lines changed

‎content/swagger/parameters.yaml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,18 +121,35 @@ with_quality_scores__product_models:
121121
description: Return product model quality scores in the response. <strong>(Only available on SaaS platforms)</strong>
122122
type: boolean
123123
required: false
124-
x-from-version: "SaaS"
124+
x-from-version: "6.0"
125125
with_completenesses:
126126
name: with_completenesses
127127
in: query
128128
description: Return product completenesses in the response. (Only available on SaaS platforms)
129129
default: false
130130
type: boolean
131131
required: false
132-
x-from-version: "SaaS"
132+
x-from-version: "6.0"
133133
with_position:
134134
name: with_position
135135
in: query
136136
description: Return information about category position into its category tree (only available on SaaS platforms)
137137
required: false
138138
type: boolean
139+
x-from-version: "SaaS"
140+
updated_before:
141+
name: updated_before
142+
in: query
143+
description: Filter products that have been updated BEFORE the provided date (Only available on Catalogs endpoints)
144+
type: string
145+
format: date
146+
required: false
147+
x-from-version: "SaaS"
148+
updated_after:
149+
name: updated_after
150+
in: query
151+
description: Filter products that have been updated AFTER the provided date (Only available on Catalogs endpoints)
152+
type: string
153+
format: date
154+
required: false
155+
x-from-version: "SaaS"

‎content/swagger/paths.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,10 @@
167167
$ref: ./resources/app_catalogs/routes/app_catalogs_id.yaml
168168
/api/rest/v1/catalogs/{id}/product-uuids:
169169
$ref: ./resources/app_catalogs/routes/app_catalogs_id_product_uuids.yaml
170+
/api/rest/v1/catalogs/{id}/products:
171+
$ref: ./resources/app_catalogs/routes/app_catalogs_id_products.yaml
172+
/api/rest/v1/catalogs/{id}/products/{uuid}:
173+
$ref: ./resources/app_catalogs/routes/app_catalogs_id_products_uuid.yaml
170174

171175
/api/rest/v1:
172176
$ref: ./resources/list_endpoints.yaml

‎content/swagger/resources/app_catalogs/routes/app_catalogs_id.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ get:
1010
parameters:
1111
- name: id
1212
in: path
13-
description: Id of the catalog
13+
description: Catalog ID
1414
required: true
1515
type: string
1616
format: uuid
@@ -37,7 +37,7 @@ patch:
3737
parameters:
3838
- name: id
3939
in: path
40-
description: Id of the catalog
40+
description: Catalog ID
4141
required: true
4242
type: string
4343
format: uuid
@@ -72,7 +72,7 @@ delete:
7272
parameters:
7373
- name: id
7474
in: path
75-
description: Id of the catalog
75+
description: Catalog ID
7676
required: true
7777
type: string
7878
format: uuid

‎content/swagger/resources/app_catalogs/routes/app_catalogs_id_product_uuids.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ get:
2323
minimum: 1
2424
maximum: 1000
2525
default: 100
26+
- $ref: '#/parameters/updated_before'
27+
- $ref: '#/parameters/updated_after'
2628
responses:
2729
200:
2830
description: Return the paginated product uuids

‎content/swagger/resources/app_catalogs/routes/app_catalogs_id_products.yaml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
get:
2+
summary: Get the list of products related to a catalog
3+
operationId: "get_app_catalog_products"
4+
tags:
5+
- Catalog products
6+
x-versions:
7+
- "SaaS"
8+
description: This endpoint allows you to get the list of products related to a catalog. Products are paginated and they can be filtered. In the Enterprise Edition, permissions based on your app settings are applied to the set of products you request.
9+
parameters:
10+
- name: id
11+
in: path
12+
description: Catalog ID
13+
required: true
14+
type: string
15+
format: uuid
16+
- $ref: '#/parameters/search_after'
17+
- name: limit
18+
in: query
19+
description: Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section
20+
required: false
21+
type: integer
22+
minimum: 1
23+
maximum: 1000
24+
default: 100
25+
- $ref: '#/parameters/updated_before'
26+
- $ref: '#/parameters/updated_after'
27+
responses:
28+
200:
29+
description: Return the paginated products
30+
schema:
31+
title: Products
32+
type: object
33+
allOf:
34+
- $ref: '#/definitions/SearchAfterPagination'
35+
- properties:
36+
_embedded:
37+
type: object
38+
properties:
39+
items:
40+
type: array
41+
items:
42+
type: string
43+
format: uuid
44+
x-examples-per-version:
45+
- x-version: 'SaaS'
46+
x-example: {
47+
"TODO"
48+
}
49+
401:
50+
description: Unauthorized
51+
x-examples-per-version:
52+
- x-version: 'SaaS'
53+
x-example: {
54+
code: 403,
55+
message: "TODO"
56+
}
57+
403:
58+
description: Access forbidden
59+
x-examples-per-version:
60+
- x-version: 'SaaS'
61+
x-example: {
62+
code: 403,
63+
message: "TODO"
64+
}
65+
404:
66+
description: Not found
67+
x-examples-per-version:
68+
- x-version: 'SaaS'
69+
x-example: {
70+
code: 403,
71+
message: "TODO"
72+
}

‎content/swagger/resources/app_catalogs/routes/app_catalogs_id_products_uuid.yaml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
get:
2+
summary: Get a product related to a catalog
3+
operationId: "get_app_catalog_products_uuid"
4+
tags:
5+
- Catalog products
6+
x-versions:
7+
- "SaaS"
8+
description: This endpoint allows you to get a specific product related to a catalog. In the Enterprise Edition, permissions based on your app settings are applied on the product you request.
9+
parameters:
10+
- name: id
11+
in: path
12+
description: Catalog ID
13+
required: true
14+
type: string
15+
format: uuid
16+
- name: uuid
17+
in: path
18+
description: Product UUID
19+
required: true
20+
type: string
21+
format: uuid
22+
responses:
23+
200:
24+
description: Return the product
25+
x-examples-per-version:
26+
- x-version: 'SaaS'
27+
x-example: {
28+
"uuid": "a5eed606-4f98-4d8c-b926-5b59f8fb0ee7",
29+
"family": "tshirt",
30+
"groups": [],
31+
"parent": null,
32+
"categories": [],
33+
"enabled": true,
34+
"values": {
35+
"name": [
36+
{
37+
"data": "Top",
38+
"locale": "en_US",
39+
"scope": null
40+
}
41+
]
42+
}
43+
}
44+
401:
45+
description: Unauthorized
46+
x-examples-per-version:
47+
- x-version: 'SaaS'
48+
x-example: {
49+
code: 403,
50+
message: "TODO"
51+
}
52+
403:
53+
description: Access forbidden
54+
x-examples-per-version:
55+
- x-version: 'SaaS'
56+
x-example: {
57+
code: 403,
58+
message: "TODO"
59+
}
60+
404:
61+
description: Not found
62+
x-examples-per-version:
63+
- x-version: 'SaaS'
64+
x-example: {
65+
code: 403,
66+
message: "TODO"
67+
}

0 commit comments

Comments
 (0)