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

Version 8

This commit is contained in:
Nico Kroll 2024-09-03 07:59:09 +02:00
parent a5aaa63f8a
commit 8b6aa36d36
1 changed files with 41 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/v2/shop.yaml
View File

@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: "TyrePro-API, Shop"
version: "Version 7"
version: "Version 8"
servers:
- url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain"
@ -485,6 +485,11 @@ paths:
responses:
200:
description: "successful operation"
headers:
GuidShopArticleConfig:
schema:
type: "string"
description: "The ShopArticleConfig which was used to build the response. With this unification the configuration is maybe not precise, but you can show the results in a unified form (columns). Currently it's a response header. In the future we will maybe change this as a field in a response object."
content:
application/json:
schema:
@ -1188,12 +1193,9 @@ components:
type: "object"
required:
- "Guid"
- "Designation"
properties:
Guid:
type: "string"
Designation:
type: "string"
Columns:
type: "array"
items:
@ -1323,7 +1325,7 @@ components:
type: "object"
required:
- "Guid"
- "GuidTableConfig"
- "GuidShopArticleConfig"
- "Details"
- "AmountPrecisionInNumberOfDecimalPlaces"
- "Stocks"
@ -1331,7 +1333,7 @@ components:
properties:
Guid:
type: "string"
GuidTableConfig:
GuidShopArticleConfig:
type: "string"
Details:
type: "array"
@ -1410,21 +1412,27 @@ components:
properties:
Guid:
type: "string"
readOnly: true
Designation:
type: "string"
SequenceNumber:
type: "integer"
ProvidedByShopOperator:
type: "boolean"
readOnly: true
Calculation:
type: "object"
required:
- "Guid"
- "GuidCalculationProfile"
- "Designation"
- "SequenceNumber"
properties:
Guid:
type: "string"
readOnly: true
GuidCalculationProfile:
type: "string"
Designation:
type: "string"
SequenceNumber:
@ -1445,6 +1453,7 @@ components:
type: "object"
required:
- "Guid"
- "GuidCalculation"
- "SequenceNumber"
- "NetPrice"
- "Mode"
@ -1453,6 +1462,9 @@ components:
properties:
Guid:
type: "string"
readOnly: true
GuidCalculation:
type: "string"
SequenceNumber:
type: "integer"
PriceNet:
@ -1570,6 +1582,7 @@ components:
properties:
Guid:
type: "string"
readOnly: true
SequenceNumber:
type: "integer"
Designation:
@ -1595,6 +1608,7 @@ components:
properties:
Guid:
type: "string"
readOnly: true
Type:
type: "string"
readOnly: true
@ -1609,6 +1623,7 @@ components:
required:
- "Guid"
- "CreationMoment"
- "LastModificationMoment"
- "SequenceNumber"
- "Comment"
properties:
@ -1619,6 +1634,10 @@ components:
type: "string"
format: "date-time"
readOnly: true
LastModificationMoment:
type: "string"
format: "date-time"
readOnly: true
Designation:
type: "string"
Comment:
@ -1633,11 +1652,24 @@ components:
type: "object"
required:
- "Guid"
- "GuidCart"
- "CreationMoment"
- "LastModificationMoment"
- "Articles"
properties:
Guid:
type: "string"
readOnly: true
GuidCart:
type: "string"
CreationMoment:
type: "string"
format: "date-time"
readOnly: true
LastModificationMoment:
type: "string"
format: "date-time"
readOnly: true
Comment:
type: "string"
Articles:
@ -1646,13 +1678,14 @@ components:
type: "object"
required:
- "Guid"
- "GuidArticle"
- "Designation"
- "Amount"
properties:
Guid:
type: "string"
GuidArticle:
Designation:
type: "string"
readOnly: true
Amount:
type: "number"
PriceNet: