Skip to content

Commit 82e70f6

Browse files
committed
📝 Add job import/export endpoints
1 parent cdd13ff commit 82e70f6

File tree

5 files changed

+66
-1
lines changed

5 files changed

+66
-1
lines changed

content/swagger/akeneo-web-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

content/swagger/paths.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@
3737
/api/rest/v1/media-files/{code}/download:
3838
$ref: ./resources/media_files/routes/media_files_code_download.yaml
3939

40+
/api/rest/v1/job/export/{code}:
41+
$ref: ./resources/job/routes/export.yaml
42+
/api/rest/v1/job/import/{code}:
43+
$ref: ./resources/job/routes/import.yaml
44+
4045
/api/rest/v1/families:
4146
$ref: ./resources/families/routes/families.yaml
4247
/api/rest/v1/families/{code}:
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
post:
2+
summary: Launch export job by code
3+
operationId: "post_job_export"
4+
tags:
5+
- Job
6+
x-versions:
7+
- "SaaS"
8+
description: This endpoint allows you to launch an export job by code.
9+
parameters:
10+
- name: code
11+
in: path
12+
type: string
13+
description: Job code
14+
required: true
15+
responses:
16+
200:
17+
description: OK
18+
x-details: Returns the execution ID for the launched job
19+
x-examples-per-version:
20+
- x-version: 'SaaS'
21+
x-example: {"execution_id": "12345"}
22+
404:
23+
$ref: "#/responses/404Error"
24+
422:
25+
$ref: "#/responses/422Error"
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
post:
2+
summary: Launch import job by code
3+
operationId: "post_job_import"
4+
tags:
5+
- Job
6+
x-versions:
7+
- "SaaS"
8+
description: This endpoint allows you to launch an import job by code.
9+
parameters:
10+
- name: code
11+
in: path
12+
type: string
13+
description: Job code
14+
required: true
15+
- name: body
16+
in: body
17+
schema:
18+
properties:
19+
import_mode:
20+
type: string
21+
description: Optional. Change the import mode for this job by overriding the profile value.
22+
format: binary
23+
responses:
24+
200:
25+
description: OK
26+
x-details: Returns the execution ID for the launched job
27+
x-examples-per-version:
28+
- x-version: 'SaaS'
29+
x-example: {"execution_id": "12345"}
30+
404:
31+
$ref: "#/responses/404Error"
32+
422:
33+
$ref: "#/responses/422Error"

tasks/reference.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ function determineCategory(tag){
8282
return 'Catalogs for Apps';
8383
case 'UI Extensions':
8484
return 'Extensions';
85+
case 'Job':
86+
return 'Job';
8587
default:
8688
return 'Utilities';
8789
}

0 commit comments

Comments
 (0)