tom/arbeitszeitmessung
3
0
Fork 0
Code Issues 17 Pull Requests Actions Packages Releases 9 Wiki Activity

FIX: docker build with database and swagger api

Browse Source
This commit is contained in:
Tom Tröger
2024-09-10 22:39:53 +02:00
parent 0fac697cda
commit 0c0034644e
5 changed files with 209 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Docker/.env
View File

@@ -1,5 +1,5 @@
POSTGRES_USER=arbeit_zeit
POSTGRES_PASSWORD=password
POSTGRES_PATH=../Backend/database
POSTGRES_PATH=../Backend/db
POSTGRES_DB=arbeitszeitmessung
EXPOSED_PORT=8000

196
Docker/arbeitszeitmessung.json Normal file
View File

@@ -0,0 +1,196 @@
{
"openapi": "3.0.3",
"info": {
"title": "Arbeitszeitmessung - OpenAPI 3.0",
"description": "This demos the API for the Arbeitszeitmessung Project ",
"version": "0.1.0"
},
"externalDocs": {
"description": "Git-Repository",
"url": "https://git.letsstein.de/tom/arbeitszeitmessung"
},
"servers": [
{
"url": "http://localhost:8000"
}
],
"tags": [
{
"name": "booking",
"description": "all Bookings"
}
],
"paths": {
"/time": {
"put": {
"tags": ["booking"],
"summary": "Update a existing booking",
"description": "Update an existing booking by Id",
"operationId": "updateBooking",
"parameters": [
{
"name": "counter_id",
"in": "query",
"description": "Booking ID to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Update an existent booking in the db. Not all values have to be updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Booking"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Booking Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Booking"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"500": {
"description": "Server Error"
}
}
},
"get": {
"tags": ["booking"],
"summary": "Gets all the bookings limited",
"description": "Returns all the bookings optionally filtered with cardID",
"parameters": [
{
"name": "card_uid",
"in": "query",
"description": "CardID to filter for",
"required": false,
"schema": {
"type": "string"
}
}
],
"operationId": "addPet",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Booking"
}
}
}
}
},
"400": {
"description": "Invalid cardID"
}
}
}
},
"/time/new": {
"put": {
"tags": ["booking"],
"summary": "Create new Booking",
"description": "Creates a new booking with the supplied parameters",
"operationId": "createBooking",
"parameters": [
{
"name": "card_uid",
"in": "query",
"description": "id of the RFID card scanned",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "geraet_id",
"in": "query",
"description": "id of the RFID reader scanning the card",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "check_in_out",
"in": "query",
"description": "booking Type",
"required": true,
"schema": {
"type": "integer",
"enum": [1, 2, 255]
}
}
],
"responses": {
"200": {
"description": "successfully created booking",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Booking"
}
}
}
},
"409": {
"description": "Same booking type as last booking"
}
}
}
}
},
"components": {
"schemas": {
"Booking": {
"type": "object",
"properties": {
"counter_id": {
"type": "integer",
"format": "int64",
"example": 100
},
"card_uid": {
"type": "string",
"example": "test_card"
},
"geraet_id": {
"type": "string",
"example": "test_reader"
},
"check_in_out": {
"type": "integer",
"example": 1,
"enum": [1, 2, 255]
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2024-09-05T08:51:12.670Z"
}
},
"xml": {
"name": "booking"
}
}
}
}
}

18
Docker/arbeitszeitmessung.yaml
View File

@@ -21,7 +21,7 @@ paths:
description: Update an existing booking by Id
operationId: updateBooking
parameters:
- name: counterID
- name: counter_id
in: query
description: Booking ID to update
required: true
@@ -51,7 +51,7 @@ paths:
summary: Gets all the bookings limited
description: Returns all the bookings optionally filtered with cardID
parameters:
- name: cardID
- name: card_uid
in: query
description: CardID to filter for
required: false
@@ -77,19 +77,19 @@ paths:
description: Creates a new booking with the supplied parameters
operationId: createBooking
parameters:
- name: cardID
- name: card_uid
in: query
description: id of the RFID card scanned
required: true
schema:
type: string
- name: geraetID
- name: geraet_id
in: query
description: id of the RFID reader scanning the card
required: true
schema:
type: string
- name: checkInOut
- name: check_in_out
in: query
description: booking Type
required: true
@@ -113,17 +113,17 @@ components:
Booking:
type: object
properties:
counterID:
counter_id:
type: integer
format: int64
example: 100
cardID:
card_uid:
type: string
example: test_card
geraetID:
geraet_id:
type: string
example: test_reader
checkInOut:
check_in_out:
type: integer
example: 1
enum: