Compare commits

..

2 Commits

1 changed files with 119 additions and 7 deletions

View File

@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: "TyrePro-API, Shop"
version: "Version 9"
version: "Version 10"
servers:
- url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain"
@ -105,6 +105,7 @@ paths:
- "Settings"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/BinaryObjectContentType"
responses:
200:
description: "successful operation"
@ -125,6 +126,7 @@ paths:
parameters:
- $ref: "#/components/parameters/GuidPath"
- $ref: "#/components/parameters/_HashValue"
- $ref: "#/components/parameters/BinaryObjectContentType"
requestBody:
required: true
content:
@ -319,6 +321,7 @@ paths:
tags:
- "Menu"
parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- name: "GuidModule"
in: "query"
required: true
@ -458,6 +461,7 @@ paths:
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/BinaryObjectContentType"
- name: "GuidBranch"
description: "Required for providing stock and price information."
in: "query"
@ -500,6 +504,32 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- 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
/CalculationProfiles:
get:
@ -1098,6 +1128,36 @@ components:
example:
Message: "Ihr Anwender wurde nicht gefunden."
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:
type: "object"
required:
@ -1330,6 +1390,7 @@ components:
- "AmountPrecisionInNumberOfDecimalPlaces"
- "Stocks"
- "AmountInCart"
- "HasShopArticleInformations"
properties:
Guid:
type: "string"
@ -1382,6 +1443,45 @@ components:
type: "string"
Amount:
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:
type: "object"
required:
@ -1559,8 +1659,8 @@ components:
OfferLayout:
type: "object"
properties:
GuidDbBlobBackground:
type: "string"
BackgroundImage:
$ref: "#/components/schemas/DbBlob"
TopOffsetInPixel:
type: "integer"
BottomOffsetInPixel:
@ -1747,13 +1847,13 @@ components:
type: "object"
required:
- "Guid"
- "GuidDbBlob"
- "File"
- "Type"
properties:
Guid:
type: "string"
GuidDbBlob:
type: "string"
File:
$ref: "#/components/schemas/DbBlob"
Type:
type: "string"
enum:
@ -1927,6 +2027,19 @@ components:
type: "string"
default: null
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:
GenericError:
description: "Unexpected error like 4XX or 5XX http errors."
@ -1936,7 +2049,6 @@ components:
$ref: "#/components/schemas/GenericError"
# MISSING
# GET /ArticleInformation
# GET /Vehicles
# GET /Tubes
# GET /Campaigns