Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .DS_Store
Binary file not shown.
36 changes: 36 additions & 0 deletions _raml/apps/gpsrinfo/examples/get_gpsrinfo_response.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"gpsrInfo": {
"pictograms": [
{
"age_restriction_0_3": {
"url": "https://pm.epages.com/rs/shops/apidocu/WebRoot/SafetyPictograms/product-safety-age-0-3.svg",
"description": "Not suitable for children under 3 years of age."
}
},
{
"skull": {
"url": "https://pm.epages.com/rs/shops/apidocu/WebRoot/SafetyPictograms/product-safety-skull.svg",
"description": "Acute toxicity"
}
}
],
"safetyStatements": [
{
"H_225": {
"description": "Highly flammable liquid and vapour."
}
},
{
"H_413": {
"description": "May cause long lasting harmful effects to aquatic life."
}
},
{
"H_224": {
"description": "Extremely flammable liquid and vapour."
}
}

]
}
}
12 changes: 12 additions & 0 deletions _raml/apps/gpsrinfo/gpsrinfo.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#%RAML 0.8
displayName: GpsrInfo
get:
description: Returns all GPSR pictogramms and safety statements from the shop. *epages6 *epagesNow
securedBy: [products_read]
is: [ locale ]
responses:
200:
body:
application/json:
example: !include examples/get_gpsrinfo_response.json
schema: !include schema/get_gpsrinfo.schema.json
11 changes: 11 additions & 0 deletions _raml/apps/gpsrinfo/schema/get_gpsrinfo.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "http://json-schema.org/draft-03/schema",
"title": "GET GpsrInfo Schema",
"type": "object",
"properties": {
"": {
"type": "object of [gpsrinfo](page:apps-data-types#gpsrInfo)",
"description": ""
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"zipCode": "07749",
"country": "Germany",
"street": "Heinrich-Heine-Str. 1",
"state": null,
"emailOrContactFormUrl": "test@epages.de",
"responsiblePersonAddress": {
"zipCode": "07749",
"country": "Germany",
"emailAddress": "test@epages.de",
"street": "Heinrich-Heine-Str. 99",
"state": null,
"city": "Jena",
"streetDetails": null,
"company": "DJ Oetzi",
"phoneNumber": null
},
"city": "Jena",
"streetDetails": null,
"company": "DJ Bass",
"manufacturerId": "691C23A6-6908-FB99-5807-C0A80502185B",
"phoneNumber": null
}
43 changes: 43 additions & 0 deletions _raml/apps/manufacturers/examples/get_manufacturers_response.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"results": 2,
"page": 1,
"resultsPerPage": 2,
"items": [
{
"zipCode": null,
"country": null,
"street": null,
"state": null,
"emailOrContactFormUrl": null,
"responsiblePersonAddress": null,
"city": null,
"streetDetails": null,
"company": "Tatonka",
"manufacturerId": "691B2E5A-A321-9921-8A5E-C0A805021988",
"phoneNumber": null
},
{
"zipCode": "07749",
"country": "Germany",
"street": "Heinrich-Heine-Str. 1",
"state": null,
"emailOrContactFormUrl": "test@epages.de",
"responsiblePersonAddress": {
"zipCode": "07749",
"country": "Germany",
"emailAddress": "test@epages.de",
"street": "Heinrich-Heine-Str. 99",
"state": null,
"city": "Jena",
"streetDetails": null,
"company": "DJ Oetzi",
"phoneNumber": null
},
"city": "Jena",
"streetDetails": null,
"company": "DJ Bass",
"manufacturerId": "691C23A6-6908-FB99-5807-C0A80502185B",
"phoneNumber": null
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[{
"op": "add",
"path": "/manufacturerAddress",
"value": {
"zipCode": "12345",
"country": "FR",
"street": "Heinrich-Heine-Str. 555",
"state": null,
"emailOrContactFormUrl": "test@epages.de",
"city": "Jena",
"streetDetails": null,
"phoneNumber": null,
"company": "DJ Anton",
"responsiblePersonAddress": {
"zipCode": "07745",
"country": "Germany",
"emailAddress": "test@epages.de",
"street": "Heinrich-Heine-Str. 6000",
"state": null,
"city": "Berlin",
"streetDetails": null,
"company": "Tony Tester",
"phoneNumber": "1234567890"
}

}
},
{
"op": "remove",
"path": "/responsiblePersonAddress"
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"zipCode": "12345",
"country": "FR",
"street": "Heinrich-Heine-Str. 555",
"state": null,
"emailOrContactFormUrl": "test@epages.de",
"city": "Jena",
"streetDetails": null,
"phoneNumber": null,
"company": "DJ Anton",
"responsiblePersonAddress": {
"zipCode": "07745",
"country": "Germany",
"emailAddress": "test@epages.de",
"street": "Heinrich-Heine-Str. 6000",
"state": null,
"city": "Berlin",
"streetDetails": null,
"company": "Tony Tester",
"phoneNumber": "1234567890"
},
"manufacturerId": "691C23A6-6908-FB99-5807-C0A80502185B"
}
36 changes: 36 additions & 0 deletions _raml/apps/manufacturers/examples/post_manufacturer_request.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[
{
"zipCode": "07749",
"country": "DE",
"street": "Heinrich-Heine-Str. 1",
"state": "Thüringen",
"responsiblePersonAddress": {
"zipCode": "07749",
"country": "DE",
"emailAddress": "test@epages.de",
"street": "Heinrich-Heine-Str. 99",
"state": "Thüringen",
"city": "Jena",
"streetDetails": null,
"company": "Responsible Company",
"phoneNumber": "12345"
},
"emailOrContactFormUrl": "test@epages.de",
"city": "Jena",
"streetDetails": null,
"company": "Fancy Manufacturer",
"phoneNumber": "08154711"
},
{
"zipCode": 7863,
"country": "Italy",
"street": "Via Regia 42",
"state": null,
"responsiblePersonAddress": null,
"emailOrContactFormUrl": null,
"city": null,
"streetDetails": null,
"company": "Ducati",
"phoneNumber": "1234567890"
}
]
38 changes: 38 additions & 0 deletions _raml/apps/manufacturers/examples/post_manufacturer_response.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[
{
"zipCode": "07749",
"country": "DE",
"street": "Heinrich-Heine-Str. 1",
"state": "Thüringen",
"responsiblePersonAddress": {
"zipCode": "07749",
"country": "DE",
"emailAddress": "test@epages.de",
"street": "Heinrich-Heine-Str. 99",
"state": "Thüringen",
"city": "Jena",
"streetDetails": null,
"company": "Responsible Company",
"phoneNumber": "12345"
},
"emailOrContactFormUrl": "test@epages.de",
"city": "Jena",
"streetDetails": null,
"company": "Fancy Manufacturer",
"phoneNumber": "08154711",
"manufacturerId": "693FDFB0-C202-DD74-584A-C0A80502D85C"
},
{
"zipCode": 7863,
"country": "Italy",
"street": "Via Regia 42",
"state": null,
"responsiblePersonAddress": null,
"emailOrContactFormUrl": null,
"city": null,
"streetDetails": null,
"company": "Ducati",
"phoneNumber": "1234567890",
"manufacturerId": "693FDFB0-C202-DD74-584A-C0A80502X3YZ"
}
]
70 changes: 70 additions & 0 deletions _raml/apps/manufacturers/manufacturers.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
#%RAML 0.8
displayName: Manufacturers
get:
description: Returns all manufacturers with their addresses from the shop. *epages6 *epagesNow
responses:
200:
body:
application/json:
example: !include examples/get_manufacturers_response.json
schema: !include schema/get_manufacturers.schema.json
post:
description: Creates a new manufacturer. *epages6 *epagesNow
securedBy: [products_write]
is: [ locale, currency ]
body:
application/json:
example: !include examples/post_manufacturer_request.json
schema: !include schema/post_manufacturer_request.schema.json
responses:
201:
body:
application/json:
example: !include examples/post_manufacturer_response.json
schema: !include schema/post_manufacturer.schema.json

/{manufacturerId}:
displayName: Manufacturer
uriParameters:
manufacturerId:
description: The unique identifier of the manufacturer.
example: 693FDFB0-C202-DD74-584A-C0A80502D85C
get:
description: Returns information on a single manufacturer. *epages6 *epagesNow
securedBy: [products_read]
responses:
200:
body:
application/json:
example: !include examples/get_manufacturers_manufacturerid_response.json
schema: !include schema/get_manufacturers_manufacturerid.schema.json
patch:
description: Updates information for a single manufacturer with partial data according to [RFC 6902](https://tools.ietf.org/html/rfc6902). You can either add or remove certain attributes. *epages6 *epagesNow <br><br>

*Supported JSON-PATCH operations*<br>
- add (sets or replaces an attribute)<br>
- remove (unsets an attribute)<br>

*Attribute paths that allow updates via PATCH* <br>
- /manufacturerAddress¹<br>
- /responsiblePersonAddress²<br><br>

**¹** supports *add* only<br>
**²** supports *remove* only<br>

securedBy: [products_write]
body:
application/json-patch+json:
example: !include examples/patch_manufacturers_manufacturerid_request.json
schema: !include schema/patch_manufacturers_manufacturerid_request.schema.json
responses:
200:
body:
application/json:
example: !include examples/patch_manufacturers_manufacturerid_response.json
schema: !include schema/patch_manufacturers_manufacturerid.schema.json
delete:
description: Deletes a single manufacturer. *epages6 *epagesNow
securedBy: [products_write]
responses:
204:
23 changes: 23 additions & 0 deletions _raml/apps/manufacturers/schema/get_manufacturers.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"$schema": "http://json-schema.org/draft-03/schema",
"title": "GET Manufacturers Schema",
"type": "object",
"properties": {
"results": {
"type": "integer",
"description": "The number of manufacturers in total."
},
"page": {
"type": "integer",
"description": "The page number on which the manufacturers appears."
},
"resultsPerPage": {
"type": "integer",
"description": "The number of manufacturers returned per page."
},
"items": {
"type": "array of [manufacturer](page:apps-data-types#manufacturer)",
"description": "The list of all manufacturers."
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "http://json-schema.org/draft-03/schema",
"title": "GET Manufacturers ManufacturerID Schema",
"type": "object",
"properties": {
"": {
"type": "object of [manufacturer](page:apps-data-types#manufaturer)",
"description": ""
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "http://json-schema.org/draft-03/schema",
"title": "PATCH Manufacturers ManufacturerID Schema",
"type": "object",
"properties": {
"": {
"type": "object of [manufacturer](page:apps-data-types#manufacturer)",
"description": ""
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "http://json-schema.org/draft-03/schema",
"title": "PATCH Manufacturers ManufacturerID Request Schema",
"type": "object",
"properties": {
"": {
"type": "array of [jsonPatch](page:apps-data-types#jsonpatch)",
"description": ""
}
}
}
Loading