Skip to content

Commit 40cc4b2

Browse files
committed
Precision about media files
1 parent d6bce1e commit 40cc4b2

File tree

9 files changed

+24
-24
lines changed

9 files changed

+24
-24
lines changed

content/swagger/resources/media_files/routes/media_files.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
get:
2-
summary: Get a list of media files
2+
summary: Get a list of product media files
33
operationId: "get_media_files"
4-
description: This endpoint allows you to get a list of media files.
4+
description: This endpoint allows you to get a list of media files that are used as attribute values in products or product models.
55
tags:
66
- Product media file
77
x-versions:
@@ -118,7 +118,7 @@ get:
118118
406:
119119
$ref: "#/responses/406Error"
120120
post:
121-
summary: Create a new media file
121+
summary: Create a new product media file
122122
operationId: "post_media_files"
123123
description: This endpoint allows you to create a new media file and associate it to an attribute value of a given product or product model.
124124
tags:

content/swagger/resources/media_files/routes/media_files_code.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
get:
2-
summary: Get a media file
2+
summary: Get a product media file
33
operationId: "get_media_files__code_"
4-
description: This endpoint allows you to get the information about a given media file.
4+
description: This endpoint allows you to get the information about a given media file that is used as an attribute value of a product or a product model.
55
tags:
66
- Product media file
77
x-versions:

content/swagger/resources/media_files/routes/media_files_code_download.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
get:
2-
summary: Download a media file
2+
summary: Download a product media file
33
operationId: "get_media_files__code__download"
4-
description: This endpoint allows you to download a given media file.
4+
description: This endpoint allows you to download a given media file that is used as an attribute value of a product or a product model.
55
x-content-type: Mime-type of the media file
66
tags:
77
- Product media file

content/swagger/resources/reference_entity_media_files/routes/reference_entity_media_files.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
post:
2-
summary: Create a new record media file
2+
summary: Create a new media file for a reference entity or a record
33
operationId: "post_reference_entity_media_files"
4-
description: This endpoint allows you to create a new media file and associate it to the main image or to an attribute value of a record of a reference entity.
4+
description: This endpoint allows you to create a new media file and associate it to the image of a reference entity, or to the main image or to an attribute value of a record.
55
tags:
6-
- Record media file
6+
- Reference entity media file
77
x-versions:
88
- "3.0"
99
x-ee: true
@@ -21,11 +21,11 @@ post:
2121
properties:
2222
file:
2323
type: string
24-
description: The binary of the record media file
24+
description: The binary of the rmedia file
2525
format: binary
2626
responses:
2727
201:
28-
$ref: "#/responses/RecordMediaFileUploaded"
28+
$ref: "#/responses/ReferenceEntityMediaFileUploaded"
2929
401:
3030
$ref: "#/responses/401Error"
3131
415:

content/swagger/resources/reference_entity_media_files/routes/reference_entity_media_files_code.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
get:
2-
summary: Download a record media file
2+
summary: Download the media file associated to a reference entity or a record
33
operationId: "get_reference_entity_media_files__code"
4-
description: This endpoint allows you to download a given record media file.
4+
description: This endpoint allows you to download a given media file that is associated with a reference entity or a record.
55
x-content-type: Mime-type of the media file
66
tags:
7-
- Record media file
7+
- Reference entity media file
88
x-versions:
99
- "3.0"
1010
x-ee: true
@@ -13,8 +13,8 @@ get:
1313
responses:
1414
200:
1515
description: OK
16-
x-details: Returns the binary of the record media file
17-
x-content-type: Mime-type of the record media file
16+
x-details: Returns the binary of the media file
17+
x-content-type: Mime-type of the media file
1818
401:
1919
$ref: "#/responses/401Error"
2020
404:

content/swagger/responses.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Created:
55
Location:
66
description: URI of the created resource
77
type: string
8-
RecordMediaFileUploaded:
8+
ReferenceEntityMediaFileUploaded:
99
description: Created
10-
x-details: Means that the record media file creation was successful
10+
x-details: Means that the media file creation was successful
1111
headers:
1212
Location:
1313
description: URI of the created resource
1414
type: string
1515
Reference-entities-media-file-code:
16-
description: Code of the record media file
16+
description: Code of the media file
1717
type: string
1818
AssetReferenceFileUploaded:
1919
description: Uploaded

src/index.handlebars

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,9 @@
208208
<img class="img-responsive center-block" src="img/illustrations/illus--Referenceentityrecord.svg"></img>
209209
<p class="text-center">Reference entity record</p>
210210
</a>
211-
<a href="/api-reference-index.html#Recordmediafile" class="link-resource">
212-
<img class="img-responsive center-block" src="img/illustrations/illus--Recordmediafile.svg"></img>
213-
<p class="text-center">Record media file</p>
211+
<a href="/api-reference-index.html#Referenceentitymediafile" class="link-resource">
212+
<img class="img-responsive center-block" src="img/illustrations/illus--Referenceentitymediafile.svg"></img>
213+
<p class="text-center">Reference entity media file</p>
214214
</a>
215215
<a href="/api-reference-index.html#Asset" class="link-resource">
216216
<img class="img-responsive center-block" src="img/illustrations/illus--Asset.svg"></img>

tasks/reference.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ function determineCategory(tag){
4444
return 'PAM';
4545
case 'Reference entity record':
4646
case 'Reference entity':
47-
case 'Record media file':
47+
case 'Reference entity media file':
4848
case 'Reference entity attribute':
4949
case 'Reference entity attribute option':
5050
return 'Reference entities';

0 commit comments

Comments
 (0)