Compare commits
No commits in common. "master" and "development" have entirely different histories.
master
...
developmen
|
|
@ -19,7 +19,6 @@ https://www.astera.com/de/type/blog/api-design-best-practices
|
|||
https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/
|
||||
https://stackoverflow.blog/2021/10/06/best-practices-for-authentication-and-authorization-for-rest-apis/
|
||||
https://www.akamai.com/blog/security/rest-api-security-best-practices
|
||||
https://jakarta.ee/specifications/data/1.0/
|
||||
|
||||
# Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -1287,62 +1287,6 @@ paths:
|
|||
$ref: "#/components/responses/GenericError"
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/Documents/{Guid}/custommethods/AcceptOffer:
|
||||
post:
|
||||
tags:
|
||||
- "Documents"
|
||||
description: "Accepts an offer. Dependant on the implementation, it could be that the offer is after the operation an order."
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/GuidPathParameter"
|
||||
- $ref: "#/components/parameters/_HashValueParameter"
|
||||
- name: "Comment"
|
||||
in: "query"
|
||||
required: false
|
||||
schema:
|
||||
type: "string"
|
||||
default: null
|
||||
example: "Thanks you!"
|
||||
responses:
|
||||
200:
|
||||
description: "successful operation"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Document"
|
||||
401:
|
||||
$ref: "#/components/responses/SessionOfOnlineUserOrHigherRequired"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/Documents/{Guid}/custommethods/RejectOffer:
|
||||
post:
|
||||
tags:
|
||||
- "Documents"
|
||||
description: "Rejects an offer. Dependant on the implementation, the offer keeps beeing open for further responses or gets historic."
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/GuidPathParameter"
|
||||
- $ref: "#/components/parameters/_HashValueParameter"
|
||||
- name: "Comment"
|
||||
in: "query"
|
||||
required: false
|
||||
schema:
|
||||
type: "string"
|
||||
default: null
|
||||
example: "The price is higher than excepted. Can you make another offer?"
|
||||
responses:
|
||||
200:
|
||||
description: "successful operation"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Document"
|
||||
401:
|
||||
$ref: "#/components/responses/SessionOfOnlineUserOrHigherRequired"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/DocumentPositions:
|
||||
get:
|
||||
tags:
|
||||
|
|
@ -4262,7 +4206,6 @@ components:
|
|||
- "UsersMayEnterANewLicenceTag"
|
||||
- "IsConnectedWithATyreStorage"
|
||||
- "DeadlineTimeInSecondsSinceMidnight"
|
||||
- "DeadlineTimeInSecondsSinceMidnight"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
|
|
@ -4287,16 +4230,6 @@ 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:
|
||||
|
|
|
|||
1041
src/v2/shop.yaml
1041
src/v2/shop.yaml
File diff suppressed because it is too large
Load Diff
|
|
@ -1,7 +1,7 @@
|
|||
openapi: 3.0.0
|
||||
info:
|
||||
title: "TyrePro-API, TPMS"
|
||||
version: "Version 7"
|
||||
version: "Version 4"
|
||||
servers:
|
||||
- url: "https://musterreifen.com/api/tpms"
|
||||
description: "Development server"
|
||||
|
|
@ -167,23 +167,6 @@ paths:
|
|||
$ref: "#/components/responses/GenericError"
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/CustomerStorages/{Guid}/custommethods/Rearrange:
|
||||
post:
|
||||
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:
|
||||
|
|
@ -589,7 +572,6 @@ paths:
|
|||
$ref: "#/components/schemas/Customer"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/CustomerStorages:
|
||||
|
|
@ -617,7 +599,6 @@ paths:
|
|||
$ref: "#/components/schemas/CustomerStorage"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/CustomerVehicles:
|
||||
|
|
@ -644,7 +625,6 @@ paths:
|
|||
$ref: "#/components/schemas/CustomerVehicle"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/CustomerVehicles/{Guid}/CustomerStorages:
|
||||
|
|
@ -673,7 +653,6 @@ paths:
|
|||
$ref: "#/components/schemas/CustomerStorage"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/CustomerVehicles/{Guid}/TpmsMeasurements:
|
||||
|
|
@ -701,7 +680,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurement"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
post:
|
||||
|
|
@ -724,7 +702,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurement"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/DbBlobs/{Guid}:
|
||||
|
|
@ -745,7 +722,6 @@ paths:
|
|||
$ref: "#/components/schemas/DbBlob"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/DmsFiles:
|
||||
|
|
@ -767,7 +743,6 @@ paths:
|
|||
$ref: "#/components/schemas/DmsFile"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/Documents:
|
||||
|
|
@ -807,7 +782,6 @@ paths:
|
|||
$ref: "#/components/schemas/Document"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/Documents/{Guid}:
|
||||
|
|
@ -825,7 +799,6 @@ paths:
|
|||
$ref: "#/components/schemas/Document"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/Employees:
|
||||
|
|
@ -853,7 +826,6 @@ paths:
|
|||
$ref: "#/components/schemas/Employee"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/Employees/{Guid}:
|
||||
|
|
@ -871,7 +843,6 @@ paths:
|
|||
$ref: "#/components/schemas/Employee"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurements:
|
||||
|
|
@ -893,7 +864,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurement"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurements/{Guid}:
|
||||
|
|
@ -911,7 +881,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurement"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
patch:
|
||||
|
|
@ -935,7 +904,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurement"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurements/{Guid}/DmsFiles:
|
||||
|
|
@ -963,7 +931,6 @@ paths:
|
|||
$ref: "#/components/schemas/DmsFile"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
post:
|
||||
|
|
@ -986,7 +953,6 @@ paths:
|
|||
$ref: "#/components/schemas/DmsFile"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurements/{Guid}/TpmsMeasurementPositions:
|
||||
|
|
@ -1014,7 +980,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurementPosition"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
post:
|
||||
|
|
@ -1037,7 +1002,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurementPosition"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurementPositions:
|
||||
|
|
@ -1059,7 +1023,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurementPosition"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurementPositions/{Guid}:
|
||||
|
|
@ -1077,7 +1040,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurementPosition"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
patch:
|
||||
|
|
@ -1101,7 +1063,6 @@ paths:
|
|||
$ref: "#/components/schemas/TpmsMeasurementPosition"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/TpmsMeasurementPositions/{Guid}/DmsFiles:
|
||||
|
|
@ -1129,7 +1090,6 @@ paths:
|
|||
$ref: "#/components/schemas/DmsFile"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
post:
|
||||
|
|
@ -1152,7 +1112,6 @@ paths:
|
|||
$ref: "#/components/schemas/DmsFile"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/VehicleTypes:
|
||||
|
|
@ -1180,7 +1139,6 @@ paths:
|
|||
$ref: "#/components/schemas/VehicleType"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
/VehicleTypes/{Guid}:
|
||||
|
|
@ -1198,7 +1156,6 @@ paths:
|
|||
$ref: "#/components/schemas/VehicleType"
|
||||
default:
|
||||
$ref: "#/components/responses/GenericError"
|
||||
deprecated: true
|
||||
security:
|
||||
- SessionScheme: []
|
||||
components:
|
||||
|
|
@ -1276,13 +1233,10 @@ components:
|
|||
type: "object"
|
||||
required:
|
||||
- "Guid"
|
||||
- "Score"
|
||||
- "Number"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
Score:
|
||||
type: "number"
|
||||
Number:
|
||||
type: "integer"
|
||||
Name1:
|
||||
|
|
@ -1301,14 +1255,11 @@ components:
|
|||
type: "object"
|
||||
required:
|
||||
- "Guid"
|
||||
- "Score"
|
||||
- "GuidCustomer"
|
||||
- "CustomerNumber"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
Score:
|
||||
type: "number"
|
||||
LicenceTagNumber:
|
||||
type: "string"
|
||||
GuidCustomer:
|
||||
|
|
@ -1323,24 +1274,14 @@ components:
|
|||
type: "object"
|
||||
required:
|
||||
- "Guid"
|
||||
- "Score"
|
||||
- "Number"
|
||||
- "ContractStartDate"
|
||||
- "IsActive"
|
||||
- "GuidCustomer"
|
||||
- "CustomerNumber"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
Score:
|
||||
type: "number"
|
||||
Number:
|
||||
type: "integer"
|
||||
ContractStartDate:
|
||||
type: "string"
|
||||
format: "date"
|
||||
IsActive:
|
||||
type: "boolean"
|
||||
DimensionFrontLeft:
|
||||
type: "string"
|
||||
LicenceTagNumber:
|
||||
|
|
@ -1353,19 +1294,12 @@ components:
|
|||
type: "integer"
|
||||
CustomerName1:
|
||||
type: "string"
|
||||
StorageDesignation:
|
||||
type: "string"
|
||||
StoragePlaceDesignation:
|
||||
type: "string"
|
||||
RemoteStorageReference:
|
||||
type: "string"
|
||||
Documents:
|
||||
type: "array"
|
||||
items:
|
||||
type: "object"
|
||||
required:
|
||||
- "Guid"
|
||||
- "Score"
|
||||
- "DocumentTypeDesignation"
|
||||
- "Date"
|
||||
- "Number"
|
||||
|
|
@ -1376,8 +1310,6 @@ components:
|
|||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
Score:
|
||||
type: "number"
|
||||
DocumentTypeDesignation:
|
||||
type: "string"
|
||||
Date:
|
||||
|
|
@ -1407,15 +1339,12 @@ components:
|
|||
type: "object"
|
||||
required:
|
||||
- "Guid"
|
||||
- "Score"
|
||||
- "StartMoment"
|
||||
- "Designation"
|
||||
- "WasCreatedByOnlineScheduler"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
Score:
|
||||
type: "number"
|
||||
StartMoment:
|
||||
type: "string"
|
||||
format: "date-time"
|
||||
|
|
@ -1464,8 +1393,6 @@ components:
|
|||
type: "string"
|
||||
GuidStorageLocation:
|
||||
type: "string"
|
||||
RemoteStorageReference:
|
||||
type: "string"
|
||||
CommentExternal:
|
||||
type: "string"
|
||||
CommentInternal:
|
||||
|
|
@ -1478,7 +1405,6 @@ components:
|
|||
- "Guid"
|
||||
- "GuidCustomerStorage"
|
||||
- "PositionDescription"
|
||||
- "PositionDescriptionDesignation"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
|
|
@ -1488,10 +1414,6 @@ components:
|
|||
readOnly: true
|
||||
PositionDescription:
|
||||
type: "string"
|
||||
PositionDescriptionDesignation:
|
||||
type: "string"
|
||||
GuidArticleTyre:
|
||||
type: "string"
|
||||
TyreDimension:
|
||||
type: "string"
|
||||
TyreManufacturer:
|
||||
|
|
@ -1508,8 +1430,6 @@ components:
|
|||
type: "integer"
|
||||
TyreDotWeek:
|
||||
type: "integer"
|
||||
GuidArticleRim:
|
||||
type: "string"
|
||||
RimDimension:
|
||||
type: "string"
|
||||
RimManufacturer:
|
||||
|
|
@ -1525,8 +1445,6 @@ components:
|
|||
- "SteelRim"
|
||||
- "WithoutRim"
|
||||
- "Unknown"
|
||||
GuidArticleTpms:
|
||||
type: "string"
|
||||
TpmsSensorId:
|
||||
type: "string"
|
||||
TpmsSensorBatteryInPercent:
|
||||
|
|
@ -1558,13 +1476,10 @@ components:
|
|||
type: "object"
|
||||
readOnly: true
|
||||
required:
|
||||
- "Guid"
|
||||
- "Type"
|
||||
- "Designation"
|
||||
- "Axles"
|
||||
properties:
|
||||
Guid:
|
||||
type: "string"
|
||||
Type:
|
||||
type: "string"
|
||||
enum:
|
||||
|
|
@ -1588,7 +1503,6 @@ components:
|
|||
- "IsDrivingAxle"
|
||||
- "IsReserveAxle"
|
||||
- "IsSteeringAxle"
|
||||
- "Designation"
|
||||
- "Positions"
|
||||
properties:
|
||||
BlockNumberFrontToBack:
|
||||
|
|
@ -1599,8 +1513,6 @@ components:
|
|||
type: "boolean"
|
||||
IsSteeringAxle:
|
||||
type: "boolean"
|
||||
Designation:
|
||||
type: "string"
|
||||
Positions:
|
||||
type: "array"
|
||||
items:
|
||||
|
|
@ -1608,14 +1520,11 @@ components:
|
|||
required:
|
||||
- "BlockNumberLeftToRight"
|
||||
- "PositionDescription"
|
||||
- "Designation"
|
||||
properties:
|
||||
BlockNumberLeftToRight:
|
||||
type: "integer"
|
||||
PositionDescription:
|
||||
type: "string"
|
||||
Designation:
|
||||
type: "string"
|
||||
ChassisNumber:
|
||||
type: "string"
|
||||
EgTypeApprovalNumber:
|
||||
|
|
@ -1660,7 +1569,6 @@ components:
|
|||
type: "object"
|
||||
required:
|
||||
- "Guid"
|
||||
- "ProgramIdentifier"
|
||||
- "ProgramIdentifierDesignation"
|
||||
- "Type"
|
||||
- "Designation"
|
||||
|
|
@ -1672,9 +1580,6 @@ components:
|
|||
ProgramIdentifierDesignation:
|
||||
type: "string"
|
||||
readOnly: true
|
||||
ProgramIdentifier:
|
||||
type: "string"
|
||||
readOnly: true
|
||||
Type:
|
||||
type: "string"
|
||||
enum:
|
||||
|
|
|
|||
Loading…
Reference in New Issue