PRM_Software_AG
/
api-documentation
12
1
Fork 0
Code Issues 10 Pull Requests Activity

Compare commits

base: PRM_Software_AG:791d46ff6bd39c25dab4c0cd727c3d8e0c9fe965
Branches Tags
PRM_Software_AG:master
PRM_Software_AG:development
..
compare: PRM_Software_AG:cec3fa68ad192a6c09546803258cef350b7f2bb9
Branches Tags
PRM_Software_AG:master
PRM_Software_AG:development

No commits in common. "791d46ff6bd39c25dab4c0cd727c3d8e0c9fe965" and "cec3fa68ad192a6c09546803258cef350b7f2bb9" have entirely different histories.
791d46ff6b ... cec3fa68ad

1 changed files with 7 additions and 119 deletions
Show Stats Expand all files Collapse all files

126
src/v2/shop.yaml
View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, Shop" title: "TyrePro-API, Shop"
version: "Version 10" version: "Version 9"
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,7 +105,6 @@ 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"
@ -126,7 +125,6 @@ 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:
@ -321,7 +319,6 @@ paths:
tags: tags:
- "Menu" - "Menu"
parameters: parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- name: "GuidModule" - name: "GuidModule"
in: "query" in: "query"
required: true required: true
@ -461,7 +458,6 @@ 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"
@ -504,32 +500,6 @@ 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:
@ -1128,36 +1098,6 @@ 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:
@ -1390,7 +1330,6 @@ components:
- "AmountPrecisionInNumberOfDecimalPlaces" - "AmountPrecisionInNumberOfDecimalPlaces"
- "Stocks" - "Stocks"
- "AmountInCart" - "AmountInCart"
- "HasShopArticleInformations"
properties: properties:
Guid: Guid:
type: "string" type: "string"
@ -1443,45 +1382,6 @@ 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:
@ -1659,8 +1559,8 @@ components:
OfferLayout: OfferLayout:
type: "object" type: "object"
properties: properties:
BackgroundImage: GuidDbBlobBackground:
$ref: "#/components/schemas/DbBlob" type: "string"
TopOffsetInPixel: TopOffsetInPixel:
type: "integer" type: "integer"
BottomOffsetInPixel: BottomOffsetInPixel:
@ -1847,13 +1747,13 @@ components:
type: "object" type: "object"
required: required:
- "Guid" - "Guid"
- "File" - "GuidDbBlob"
- "Type" - "Type"
properties: properties:
Guid: Guid:
type: "string" type: "string"
File: GuidDbBlob:
$ref: "#/components/schemas/DbBlob" type: "string"
Type: Type:
type: "string" type: "string"
enum: enum:
@ -2027,19 +1927,6 @@ 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."
@ -2049,6 +1936,7 @@ 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