PMT-37-added endpoint and DTO specification
This commit is contained in:
parent
6eb1b5bda8
commit
8ea7bf798f
1 changed files with 47 additions and 0 deletions
47
api/pmt.yml
47
api/pmt.yml
|
@ -27,6 +27,28 @@ components:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/ProjectInfo"
|
$ref: "#/components/schemas/ProjectInfo"
|
||||||
|
GetAllProjectInfoDTO:
|
||||||
|
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
|
||||||
CreateProjectDTO:
|
CreateProjectDTO:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -213,6 +235,31 @@ paths:
|
||||||
$ref: "#/components/responses/ServiceUnavailable"
|
$ref: "#/components/responses/ServiceUnavailable"
|
||||||
|
|
||||||
/project/{id}:
|
/project/{id}:
|
||||||
|
get:
|
||||||
|
operationId: "getProjectInfo"
|
||||||
|
description: "Get a list of all Project Informations"
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: id
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
required: true
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: "Project Info recieved"
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/GetAllProjectInfoDTO"
|
||||||
|
401:
|
||||||
|
$ref: "#/components/responses/Unauthorized"
|
||||||
|
404:
|
||||||
|
$ref: "#/components/responses/NotFound"
|
||||||
|
500:
|
||||||
|
$ref: "#/components/responses/InternalError"
|
||||||
|
503:
|
||||||
|
$ref: "#/components/responses/ServiceUnavailable"
|
||||||
post:
|
post:
|
||||||
operationId: "addEmployee"
|
operationId: "addEmployee"
|
||||||
description: "Adds an employee to a specific Project"
|
description: "Adds an employee to a specific Project"
|
||||||
|
|
Loading…
Reference in a new issue