PMT-32: Define Endpoint Specification

This commit is contained in:
Dominik Säume 2024-10-02 08:48:15 +02:00
parent dddc91bf4d
commit c70ca1d172
Signed by: SZUT-Dominik
GPG key ID: 67D15BB250B41E7C

View file

@ -14,20 +14,22 @@ components:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
HelloOut:
description: "A Test Schema"
schemas:
ProjectInfo:
type: object
properties:
msg:
properties:
id:
type: integer
format: int64
name:
type: string
GetAllProjectsDTO:
type: array
items:
$ref: "#/components/schemas/ProjectInfo"
responses:
OK:
description: "OK"
content:
text/plain:
schema:
type: string
UnAuthorized:
description: "Un Authorized"
InternalError:
description: "Internal Server Error"
content:
@ -35,16 +37,18 @@ components:
schema:
type: string
paths:
/hello:
/project:
get:
operationId: "GetHello"
description: "A Simple Hello World Endpoint"
operationId: "getAllProjects"
description: "Get a List of all Projects"
responses:
200:
description: "A Hello Response"
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/HelloOut"
$ref: "#/components/schemas/GetAllProjectsDTO"
401:
$ref: "#/components/responses/UnAuthorized"
500:
$ref: "#/components/responses/InternalError"