Further adjustments during testing and implementation

This commit is contained in:
Nico Kroll 2024-05-29 14:39:29 +02:00
parent 705b1385da
commit 8aa53558ca
1 changed files with 54 additions and 6 deletions

View File

@ -1,7 +1,7 @@
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: "TyrePro-API, TPMS" title: "TyrePro-API, TPMS"
version: "2" version: "Version 3"
servers: servers:
- url: "https://musterreifen.com/api/tpms" - url: "https://musterreifen.com/api/tpms"
description: "Development server" description: "Development server"
@ -840,6 +840,29 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
patch:
tags:
- "TPMS"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TpmsMeasurement"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/TpmsMeasurement"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/TpmsMeasurements/{Guid}/DmsFiles: /TpmsMeasurements/{Guid}/DmsFiles:
get: get:
tags: tags:
@ -913,7 +936,7 @@ paths:
schema: schema:
type: "array" type: "array"
items: items:
$ref: "#/components/schemas/TpmsMeasurement" $ref: "#/components/schemas/TpmsMeasurementPosition"
default: default:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
@ -978,6 +1001,29 @@ paths:
$ref: "#/components/responses/GenericError" $ref: "#/components/responses/GenericError"
security: security:
- SessionScheme: [] - SessionScheme: []
patch:
tags:
- "TPMS"
parameters:
- $ref: "#/components/parameters/GuidPathParameter"
- $ref: "#/components/parameters/_HashValueParameter"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TpmsMeasurementPosition"
responses:
200:
description: "successful operation"
content:
application/json:
schema:
$ref: "#/components/schemas/TpmsMeasurementPosition"
default:
$ref: "#/components/responses/GenericError"
security:
- SessionScheme: []
/TpmsMeasurementPositions/{Guid}/DmsFiles: /TpmsMeasurementPositions/{Guid}/DmsFiles:
get: get:
tags: tags:
@ -1409,6 +1455,8 @@ components:
CreationMoment: CreationMoment:
type: "string" type: "string"
format: "date-time" format: "date-time"
Comment:
type: "string"
_HashValue: _HashValue:
$ref: "#/components/schemas/_HashValue" $ref: "#/components/schemas/_HashValue"
TpmsMeasurementPosition: TpmsMeasurementPosition:
@ -1426,13 +1474,13 @@ components:
type: "string" type: "string"
SensorId: SensorId:
type: "string" type: "string"
TirePressureInBar: TyrePressureInBar:
type: "number" type: "number"
TireTemperatureInCelsius: TyreTemperatureInCelsius:
type: "number" type: "number"
SensorBatteryInPercent: SensorBatteryInPercent:
type: "integer" type: "integer"
description: "If you just can provide [ok, low, empty] use please [100, 20, 0] as values." description: "If you just can provide [ok, low, empty] use please [100, 10, 0] as values."
_HashValue: _HashValue:
$ref: "#/components/schemas/_HashValue" $ref: "#/components/schemas/_HashValue"
VehicleType: VehicleType:
@ -1573,7 +1621,7 @@ components:
schema: schema:
type: "string" type: "string"
default: null default: null
example: "mc*onald" example: ""
responses: responses:
GenericError: GenericError:
description: "Unexpected error like 4XX or 5XX http errors." description: "Unexpected error like 4XX or 5XX http errors."