SZUT/ProjectManagmentTool
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

PMT-16: Add Endpoint Specification

Browse source
This commit is contained in:
Rajbir Singh 2024-10-07 15:53:26 +02:00 committed by Dominik Säume
parent 5c06b052af
commit f774450986
Signed by: SZUT-Dominik
GPG key ID: 67D15BB250B41E7C
1 changed files with 71 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
api/pmt.yml
View file

@ -27,9 +27,56 @@ components:
type: array
items:
$ref: "#/components/schemas/ProjectInfo"
CreateProjectDTO:
type: object
properties:
name:
type: string
goal:
type: string
customerId:
type: integer
format: int64
administratorId:
type: integer
format: int64
start:
type: string
format: date-time
plannedEnd:
type: string
format: date-time
CreatedProjectDTO:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
goal:
type: string
customerId:
type: integer
format: int64
administratorId:
type: integer
format: int64
start:
type: string
format: date-time
plannedEnd:
type: string
format: date-time
responses:
UnAuthorized:
description: "Un Authorized"
Unauthorized:
description: "Unauthorized"
NotFound:
description: "Not Found"
content:
text/plain:
schema:
type: string
InternalError:
description: "Internal Server Error"
content:
@ -49,6 +96,27 @@ paths:
schema:
$ref: "#/components/schemas/GetAllProjectsDTO"
401:
$ref: "#/components/responses/UnAuthorized"
$ref: "#/components/responses/Unauthorized"
500:
$ref: "#/components/responses/InternalError"
post:
operationId: "CreateProject"
description: "Creates a new Project"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateProjectDTO"
responses:
201:
description: "Project created successfully"
content:
application/json:
schema:
$ref: "#/components/schemas/CreatedProjectDTO"
401:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
500:
$ref: "#/components/responses/InternalError"