Compare commits

...

10 Commits

4 changed files with 470 additions and 105 deletions

View File

@@ -27,3 +27,4 @@ https://docs.hetzner.cloud/
https://opensource.zalando.com/restful-api-guidelines
https://kubernetes.io/docs/reference/using-api/api-concepts
https://docs.stripe.com/api/prices
https://developer.clickup.com/docs/authentication

View File

@@ -4193,6 +4193,7 @@ components:
- "GuidOnlineSchedulerService"
- "GuidBranch"
- "IsDefault"
- "Hints"
properties:
Guid:
type: "string"
@@ -4202,6 +4203,22 @@ components:
type: "string"
IsDefault:
type: "string"
Hints:
type: "array"
items:
type: "object"
required:
- "AttentionLevel"
- "Hint"
properties:
AttentionLevel:
type: "string"
enum:
- "Low"
- "Mid"
- "High"
Hint:
type: "string"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:
@@ -4262,6 +4279,7 @@ components:
- "UsersMayEnterANewLicenceTag"
- "IsConnectedWithATyreStorage"
- "DeadlineTimeInSecondsSinceMidnight"
- "DeadlineTimeInSecondsSinceMidnight"
properties:
Guid:
type: "string"
@@ -4286,6 +4304,16 @@ components:
type: "boolean"
DeadlineTimeInSecondsSinceMidnight:
type: "integer"
RedirectUrlType:
type: "string"
enum:
- "None"
- "NewTab"
- "SameTab"
RedirectUrl:
type: "string"
RedirectUrlShallBeShownAsOptionalButton:
type: "boolean"
_HashValue:
$ref: "#/components/schemas/_HashValue"
example:

View File

@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: "TyrePro-API, Shop"
version: "Version 13"
version: "Version 19"
servers:
- url: "https://musterreifen.com/api/shop"
description: "Development server, customers domain"
@@ -453,7 +453,20 @@ paths:
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/SearchTerm2"
- $ref: "#/components/parameters/GuidWidth2"
- $ref: "#/components/parameters/GuidSection2"
- $ref: "#/components/parameters/GuidDiameter2"
- $ref: "#/components/parameters/GuidSpeedIndex2"
- $ref: "#/components/parameters/GuidLoadIndex2"
- $ref: "#/components/parameters/GuidHoleCount2"
- $ref: "#/components/parameters/GuidHoleCircle2"
- $ref: "#/components/parameters/GuidOffset2"
- $ref: "#/components/parameters/GuidHubBoreHole2"
- name: "Type"
description: "Provide the types you want to get. If this parameter is not provided, all types will be returned."
in: "query"
@@ -475,6 +488,74 @@ paths:
- "Offset"
- "HubBoreHole"
- "Manufacturer"
- "MotorcycleManufacturer"
- "MotorcycleDisplacement"
- "MotorcycleModel"
- "Width2"
- "Section2"
- "Diameter2"
- "SpeedIndex2"
- "LoadIndex2"
- "HoleCount2"
- "HoleCircle2"
- "Offset2"
- "HubBoreHole2"
- name: "MaximumNumberOfOptions"
in: "query"
required: false
schema:
type: "integer"
default: 1000
example: 1000
responses:
200:
description: "successful operation"
headers:
Developer-Hint:
schema:
type: "string"
description: "To prevent data intense calls, we may manipulate your request. If so, you get a hint here, what exactly we've done."
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/Filter"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/Filters2:
get:
tags:
- "Search"
parameters:
- $ref: "#/components/parameters/GuidOnlineService"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/SearchTerm1"
- $ref: "#/components/parameters/SearchTerm2"
- $ref: "#/components/parameters/GuidMaterialType"
- $ref: "#/components/parameters/GuidVehicleType"
- $ref: "#/components/parameters/GuidWidth"
- $ref: "#/components/parameters/GuidSection"
- $ref: "#/components/parameters/GuidDiameter"
- $ref: "#/components/parameters/GuidSpeedIndex"
- $ref: "#/components/parameters/GuidLoadIndex"
- $ref: "#/components/parameters/GuidHoleCount"
- $ref: "#/components/parameters/GuidHoleCircle"
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- name: "MaximumNumberOfOptions"
in: "query"
required: false
schema:
type: "integer"
default: 200
example: 200
responses:
200:
description: "successful operation"
@@ -483,7 +564,7 @@ paths:
schema:
type: "array"
items:
$ref: "#/components/schemas/Filter"
$ref: "#/components/schemas/Filter2"
default:
$ref: "#/components/responses/GenericError"
security:
@@ -545,6 +626,9 @@ paths:
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidBranch"
@@ -587,61 +671,24 @@ paths:
- $ref: "#/components/parameters/GuidOffset"
- $ref: "#/components/parameters/GuidHubBoreHole"
- $ref: "#/components/parameters/GuidManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleManufacturer"
- $ref: "#/components/parameters/GuidMotorcycleDisplacement"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidDeliveryType"
- $ref: "#/components/parameters/GuidBranch"
- $ref: "#/components/parameters/GuidCalculationProfile"
- $ref: "#/components/parameters/GuidShopArticleConfig"
- name: "SearchTerm2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidWidth2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidSection2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidDiameter2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidSpeedIndex2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidLoadIndex2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidHoleCount2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidHoleCircle2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidOffset2"
in: "query"
required: false
schema:
type: "string"
- name: "GuidHubBoreHole2"
in: "query"
required: false
schema:
type: "string"
- $ref: "#/components/parameters/SearchTerm2"
- $ref: "#/components/parameters/GuidWidth2"
- $ref: "#/components/parameters/GuidSection2"
- $ref: "#/components/parameters/GuidDiameter2"
- $ref: "#/components/parameters/GuidSpeedIndex2"
- $ref: "#/components/parameters/GuidLoadIndex2"
- $ref: "#/components/parameters/GuidHoleCount2"
- $ref: "#/components/parameters/GuidHoleCircle2"
- $ref: "#/components/parameters/GuidOffset2"
- $ref: "#/components/parameters/GuidHubBoreHole2"
responses:
200:
description: "successful operation"
@@ -675,11 +722,6 @@ paths:
responses:
200:
description: "successful operation"
headers:
Guid-Shop-Article-Config:
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:
@@ -723,11 +765,6 @@ paths:
responses:
200:
description: "successful operation"
headers:
Guid-Shop-Article-Config:
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:
@@ -738,6 +775,54 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
# MotorcycleDetails
/ShopArticleMotorcycleInformations:
get:
tags:
- "MotorcycleDetails"
parameters:
- $ref: "#/components/parameters/BinaryObjectContentType"
- $ref: "#/components/parameters/GuidShopArticle"
- $ref: "#/components/parameters/GuidMotorcycleModel"
- name: "GuidShopArticle2"
in: "query"
required: false
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/ShopArticleMotorcycleInformation"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/ShopArticleMotorcycles:
get:
tags:
- "MotorcycleDetails"
parameters:
- $ref: "#/components/parameters/GuidShopArticle"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
type: "array"
items:
$ref: "#/components/schemas/ShopArticleMotorcycle"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
# Calculation
/CalculationProfiles:
get:
@@ -1303,6 +1388,7 @@ components:
- "Designation"
- "Number"
- "IsActive"
- "DefaultDeliveryDate"
properties:
Guid:
type: "string"
@@ -1324,6 +1410,9 @@ components:
type: "number"
Longitude:
type: "number"
DefaultDeliveryDate:
type: "string"
format: "date"
example:
Guid: "ebb89e89-8d25-809e-7814-c53b686ae164"
Designation: "Zentrale"
@@ -1376,9 +1465,16 @@ components:
type: "object"
required:
- "Guid"
- "DesiredAmountOfDirectSearch"
- "DesiredAmountOfCombinationSearch"
- "Columns"
properties:
Guid:
type: "string"
DesiredAmountOfDirectSearch:
type: "number"
DesiredAmountOfCombinationSearch:
type: "number"
Columns:
type: "array"
items:
@@ -1442,31 +1538,44 @@ components:
type: "string"
GuidVehicleType:
type: "string"
Types:
TypeGroups:
type: "array"
items:
type: "object"
required:
- "Designation"
- "Type"
- "Types"
properties:
Designation:
type: "string"
Type:
type: "string"
enum:
- "MaterialType"
- "VehicleType"
- "Width"
- "Section"
- "Diameter"
- "SpeedIndex"
- "LoadIndex"
- "HoleCount"
- "HoleCircle"
- "Offset"
- "HubBoreHole"
- "Manufacturer"
Types:
type: "array"
items:
type: "object"
required:
- "Designation"
- "Type"
properties:
Designation:
type: "string"
Type:
type: "string"
enum:
- "MaterialType"
- "VehicleType"
- "Width"
- "Section"
- "Diameter"
- "SpeedIndex"
- "LoadIndex"
- "HoleCount"
- "HoleCircle"
- "Offset"
- "HubBoreHole"
- "Manufacturer"
- "MotorcycleManufacturer"
- "MotorcycleDisplacement"
- "MotorcycleModel"
Filter:
type: "object"
required:
@@ -1494,6 +1603,15 @@ components:
- "Offset"
- "HubBoreHole"
- "Manufacturer"
- "Width2"
- "Section2"
- "Diameter2"
- "SpeedIndex2"
- "LoadIndex2"
- "HoleCount2"
- "HoleCircle2"
- "Offset2"
- "HubBoreHole2"
Options:
type: "array"
items:
@@ -1512,6 +1630,68 @@ components:
type: "string"
ParameterValue:
type: "string"
Filter2:
type: "object"
required:
- "Type"
- "Designation"
- "Fields"
properties:
Type:
type: "string"
enum:
- "Basic"
- "Detail"
- "Motorcycle"
Designation:
type: "string"
Fields:
type: "array"
items:
type: "object"
required:
- "Type"
- "Designation"
- "ParameterKey"
- "Options"
properties:
Type:
type: "string"
enum:
- "MaterialType"
- "VehicleType"
- "Width"
- "Section"
- "Diameter"
- "SpeedIndex"
- "LoadIndex"
- "HoleCount"
- "HoleCircle"
- "Offset"
- "HubBoreHole"
- "Manufacturer"
- "MotorcycleManufacturer"
- "MotorcycleDisplacement"
- "MotorcycleModel"
Designation:
type: "string"
ParameterKey:
type: "string"
Options:
type: "array"
items:
type: "object"
required:
- "Designation"
- "NumberOfResults"
- "ParameterValue"
properties:
Designation:
type: "string"
NumberOfResults:
type: "integer"
ParameterValue:
type: "string"
ShopArticle:
type: "object"
required:
@@ -1638,6 +1818,43 @@ components:
DeliveryDate:
type: "string"
format: "date"
ShopArticleMotorcycleInformation:
type: "object"
required:
- "Notes"
properties:
CertificateFile:
$ref: "#/components/schemas/DbBlob"
Notes:
type: "array"
items:
type: "string"
ShopArticleMotorcycle:
type: "object"
required:
- "GuidMotorcycle"
- "Manufacturer"
- "Model"
- "Type"
properties:
GuidMotorcycleModel:
type: "string"
Manufacturer:
type: "string"
Model:
type: "string"
Type:
type: "string"
DisplacementInCcm:
type: "integer"
PowerInKw:
type: "integer"
ConstructionYearFrom:
type: "integer"
ConstructionYearTo:
type: "integer"
AdditionalDesignation:
type: "string"
MaterialType:
type: "object"
required:
@@ -1780,6 +1997,7 @@ components:
- "Guid"
- "GuidCurrency"
- "DefaultAmount"
- "DefaultDeliveryDate"
- "OneClickPurchase"
- "FullTaxPercentage"
- "ReducedTaxPercentage"
@@ -1805,6 +2023,10 @@ components:
DefaultAmount:
type: "number"
readOnly: true
DefaultDeliveryDate:
type: "string"
format: "date"
readOnly: true
OneClickPurchase:
type: "boolean"
readOnly: true
@@ -2194,6 +2416,30 @@ components:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMotorcycleManufacturer:
name: "GuidMotorcycleManufacturer"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMotorcycleDisplacement:
name: "GuidMotorcycleDisplacement"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidMotorcycleModel:
name: "GuidMotorcycleModel"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidBranch:
name: "GuidBranch"
description: "Required for providing stock and price information."
@@ -2236,14 +2482,94 @@ components:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
SearchTerm:
name: "SearchTerm"
SearchTerm1:
name: "SearchTerm1"
in: "query"
required: false
schema:
type: "string"
default: null
example: "2055516"
SearchTerm2:
name: "SearchTerm2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "2055516"
GuidWidth2:
name: "GuidWidth2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidSection2:
name: "GuidSection2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidDiameter2:
name: "GuidDiameter2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidSpeedIndex2:
name: "GuidSpeedIndex2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidLoadIndex2:
name: "GuidLoadIndex2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidHoleCount2:
name: "GuidHoleCount2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidHoleCircle2:
name: "GuidHoleCircle2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidOffset2:
name: "GuidOffset2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
GuidHubBoreHole2:
name: "GuidHubBoreHole2"
in: "query"
required: false
schema:
type: "string"
default: null
example: "ebb89e89-8d25-809e-7814-c53b686ae164"
BinaryObjectContentType:
name: "BinaryObjectContentType"
in: "query"
@@ -2264,27 +2590,3 @@ components:
application/json:
schema:
$ref: "#/components/schemas/GenericError"
# MISSING
# GET /Vehicles

View File

@@ -167,6 +167,23 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Predecessor:
get:
tags:
- "TPMS / customer storage"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerStorage"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Rearrange:
post:
tags:
@@ -184,6 +201,23 @@ paths:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStorages/{Guid}/custommethods/Successor:
get:
tags:
- "TPMS / customer storage"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/CustomerStorage"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/CustomerStoragePositions/{Guid}:
get:
tags: