Compare commits
2 Commits
cec3fa68ad
...
791d46ff6b
| Author | SHA1 | Date |
|---|---|---|
|
|
791d46ff6b | |
|
|
5b9a836c65 |
126
src/v2/shop.yaml
126
src/v2/shop.yaml
|
|
@ -1,7 +1,7 @@
|
||||||
openapi: 3.0.0
|
openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: "TyrePro-API, Shop"
|
title: "TyrePro-API, Shop"
|
||||||
version: "Version 9"
|
version: "Version 10"
|
||||||
servers:
|
servers:
|
||||||
- url: "https://musterreifen.com/api/shop"
|
- url: "https://musterreifen.com/api/shop"
|
||||||
description: "Development server, customers domain"
|
description: "Development server, customers domain"
|
||||||
|
|
@ -105,6 +105,7 @@ paths:
|
||||||
- "Settings"
|
- "Settings"
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidOnlineService"
|
- $ref: "#/components/parameters/GuidOnlineService"
|
||||||
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: "successful operation"
|
description: "successful operation"
|
||||||
|
|
@ -125,6 +126,7 @@ paths:
|
||||||
parameters:
|
parameters:
|
||||||
- $ref: "#/components/parameters/GuidPath"
|
- $ref: "#/components/parameters/GuidPath"
|
||||||
- $ref: "#/components/parameters/_HashValue"
|
- $ref: "#/components/parameters/_HashValue"
|
||||||
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
|
|
@ -319,6 +321,7 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- "Menu"
|
- "Menu"
|
||||||
parameters:
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
- name: "GuidModule"
|
- name: "GuidModule"
|
||||||
in: "query"
|
in: "query"
|
||||||
required: true
|
required: true
|
||||||
|
|
@ -458,6 +461,7 @@ paths:
|
||||||
- $ref: "#/components/parameters/GuidOffset"
|
- $ref: "#/components/parameters/GuidOffset"
|
||||||
- $ref: "#/components/parameters/GuidHubBoreHole"
|
- $ref: "#/components/parameters/GuidHubBoreHole"
|
||||||
- $ref: "#/components/parameters/GuidManufacturer"
|
- $ref: "#/components/parameters/GuidManufacturer"
|
||||||
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
- name: "GuidBranch"
|
- name: "GuidBranch"
|
||||||
description: "Required for providing stock and price information."
|
description: "Required for providing stock and price information."
|
||||||
in: "query"
|
in: "query"
|
||||||
|
|
@ -500,6 +504,32 @@ paths:
|
||||||
$ref: "#/components/responses/GenericError"
|
$ref: "#/components/responses/GenericError"
|
||||||
security:
|
security:
|
||||||
- SessionScheme: []
|
- SessionScheme: []
|
||||||
|
/ShopArticleInformations:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- "Search"
|
||||||
|
parameters:
|
||||||
|
- $ref: "#/components/parameters/BinaryObjectContentType"
|
||||||
|
- name: "GuidShopArticle"
|
||||||
|
in: "query"
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: "string"
|
||||||
|
default: null
|
||||||
|
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: "successful operation"
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: "array"
|
||||||
|
items:
|
||||||
|
$ref: "#/components/schemas/ShopArticleInformation"
|
||||||
|
default:
|
||||||
|
$ref: "#/components/responses/GenericError"
|
||||||
|
security:
|
||||||
|
- SessionScheme: []
|
||||||
# Calculation
|
# Calculation
|
||||||
/CalculationProfiles:
|
/CalculationProfiles:
|
||||||
get:
|
get:
|
||||||
|
|
@ -1098,6 +1128,36 @@ components:
|
||||||
example:
|
example:
|
||||||
Message: "Ihr Anwender wurde nicht gefunden."
|
Message: "Ihr Anwender wurde nicht gefunden."
|
||||||
Details: "Progress.Lang.AppError\n Ihr Anwender wurde nicht gefunden.\nat sourcecode.line 123"
|
Details: "Progress.Lang.AppError\n Ihr Anwender wurde nicht gefunden.\nat sourcecode.line 123"
|
||||||
|
DbBlob:
|
||||||
|
type: "object"
|
||||||
|
required:
|
||||||
|
- "Designation"
|
||||||
|
- "MimeType"
|
||||||
|
- "CharacterSet"
|
||||||
|
- "LastFileModificationMoment"
|
||||||
|
- "Content"
|
||||||
|
- "ContentHashValue"
|
||||||
|
- "SizeInBytes"
|
||||||
|
properties:
|
||||||
|
Designation:
|
||||||
|
type: "string"
|
||||||
|
MimeType:
|
||||||
|
type: "string"
|
||||||
|
readOnly: true
|
||||||
|
CharacterSet:
|
||||||
|
type: "string"
|
||||||
|
LastFileModificationMoment:
|
||||||
|
type: "string"
|
||||||
|
format: "date-time"
|
||||||
|
readOnly: true
|
||||||
|
Content:
|
||||||
|
type: "string"
|
||||||
|
ContentHashValue:
|
||||||
|
type: "string"
|
||||||
|
readOnly: true
|
||||||
|
SizeInBytes:
|
||||||
|
type: "integer"
|
||||||
|
readOnly: true
|
||||||
AddressState:
|
AddressState:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
|
@ -1330,6 +1390,7 @@ components:
|
||||||
- "AmountPrecisionInNumberOfDecimalPlaces"
|
- "AmountPrecisionInNumberOfDecimalPlaces"
|
||||||
- "Stocks"
|
- "Stocks"
|
||||||
- "AmountInCart"
|
- "AmountInCart"
|
||||||
|
- "HasShopArticleInformations"
|
||||||
properties:
|
properties:
|
||||||
Guid:
|
Guid:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
@ -1382,6 +1443,45 @@ components:
|
||||||
type: "string"
|
type: "string"
|
||||||
Amount:
|
Amount:
|
||||||
type: "number"
|
type: "number"
|
||||||
|
HasShopArticleInformations:
|
||||||
|
type: "boolean"
|
||||||
|
Thumbnail:
|
||||||
|
$ref: "#/components/schemas/DbBlob"
|
||||||
|
ShopArticleInformation:
|
||||||
|
type: "object"
|
||||||
|
required:
|
||||||
|
- "Type"
|
||||||
|
- "Designation"
|
||||||
|
- "Informations"
|
||||||
|
properties:
|
||||||
|
Type:
|
||||||
|
type: "string"
|
||||||
|
enum:
|
||||||
|
- "ManufacturerLink"
|
||||||
|
- "Photo"
|
||||||
|
- "MarketingInfo"
|
||||||
|
- "TestReport"
|
||||||
|
- "TechnicalInfo"
|
||||||
|
- "Certificate"
|
||||||
|
- "Manual"
|
||||||
|
Designation:
|
||||||
|
type: "string"
|
||||||
|
Informations:
|
||||||
|
type: "array"
|
||||||
|
items:
|
||||||
|
type: "object"
|
||||||
|
required:
|
||||||
|
- "Designation"
|
||||||
|
- "IsUrl"
|
||||||
|
properties:
|
||||||
|
Designation:
|
||||||
|
type: "string"
|
||||||
|
IsUrl:
|
||||||
|
type: "string"
|
||||||
|
Url:
|
||||||
|
type: "string"
|
||||||
|
File:
|
||||||
|
$ref: "#/components/schemas/DbBlob"
|
||||||
MaterialType:
|
MaterialType:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
|
@ -1559,8 +1659,8 @@ components:
|
||||||
OfferLayout:
|
OfferLayout:
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
GuidDbBlobBackground:
|
BackgroundImage:
|
||||||
type: "string"
|
$ref: "#/components/schemas/DbBlob"
|
||||||
TopOffsetInPixel:
|
TopOffsetInPixel:
|
||||||
type: "integer"
|
type: "integer"
|
||||||
BottomOffsetInPixel:
|
BottomOffsetInPixel:
|
||||||
|
|
@ -1747,13 +1847,13 @@ components:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
- "Guid"
|
- "Guid"
|
||||||
- "GuidDbBlob"
|
- "File"
|
||||||
- "Type"
|
- "Type"
|
||||||
properties:
|
properties:
|
||||||
Guid:
|
Guid:
|
||||||
type: "string"
|
type: "string"
|
||||||
GuidDbBlob:
|
File:
|
||||||
type: "string"
|
$ref: "#/components/schemas/DbBlob"
|
||||||
Type:
|
Type:
|
||||||
type: "string"
|
type: "string"
|
||||||
enum:
|
enum:
|
||||||
|
|
@ -1927,6 +2027,19 @@ components:
|
||||||
type: "string"
|
type: "string"
|
||||||
default: null
|
default: null
|
||||||
example: "2055516"
|
example: "2055516"
|
||||||
|
BinaryObjectContentType:
|
||||||
|
name: "BinaryObjectContentType"
|
||||||
|
in: "query"
|
||||||
|
description: "Determines what you will find in the field content."
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: "string"
|
||||||
|
enum:
|
||||||
|
- "Base64"
|
||||||
|
- "UrlWithInlineContentDisposition"
|
||||||
|
- "UrlWithAttachmentContentDisposition"
|
||||||
|
default: "UrlWithInlineContentDisposition"
|
||||||
|
example: "UrlWithInlineContentDisposition"
|
||||||
responses:
|
responses:
|
||||||
GenericError:
|
GenericError:
|
||||||
description: "Unexpected error like 4XX or 5XX http errors."
|
description: "Unexpected error like 4XX or 5XX http errors."
|
||||||
|
|
@ -1936,7 +2049,6 @@ components:
|
||||||
$ref: "#/components/schemas/GenericError"
|
$ref: "#/components/schemas/GenericError"
|
||||||
|
|
||||||
# MISSING
|
# MISSING
|
||||||
# GET /ArticleInformation
|
|
||||||
# GET /Vehicles
|
# GET /Vehicles
|
||||||
# GET /Tubes
|
# GET /Tubes
|
||||||
# GET /Campaigns
|
# GET /Campaigns
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue