feat(openapi): add tags
This commit is contained in:
parent
14587e612f
commit
d1e0607812
1 changed files with 31 additions and 1 deletions
|
|
@ -1,6 +1,6 @@
|
||||||
openapi: "3.1.0"
|
openapi: "3.1.0"
|
||||||
info:
|
info:
|
||||||
version: 1.0.2
|
version: 1.1.0
|
||||||
title: Backoffice API
|
title: Backoffice API
|
||||||
license:
|
license:
|
||||||
name: Proprietary
|
name: Proprietary
|
||||||
|
|
@ -20,6 +20,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: List all trainings
|
summary: List all trainings
|
||||||
operationId: listTrainings
|
operationId: listTrainings
|
||||||
|
tags:
|
||||||
|
- trainings
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: A list of trainings
|
description: A list of trainings
|
||||||
|
|
@ -38,6 +40,8 @@ paths:
|
||||||
post:
|
post:
|
||||||
summary: Create a new training
|
summary: Create a new training
|
||||||
operationId: createTraining
|
operationId: createTraining
|
||||||
|
tags:
|
||||||
|
- trainings
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
|
|
@ -67,6 +71,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: Get a training by ID
|
summary: Get a training by ID
|
||||||
operationId: getTraining
|
operationId: getTraining
|
||||||
|
tags:
|
||||||
|
- trainings
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -96,6 +102,8 @@ paths:
|
||||||
put:
|
put:
|
||||||
summary: Update a training by ID
|
summary: Update a training by ID
|
||||||
operationId: updateTraining
|
operationId: updateTraining
|
||||||
|
tags:
|
||||||
|
- trainings
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -138,6 +146,8 @@ paths:
|
||||||
delete:
|
delete:
|
||||||
summary: Delete a training by ID
|
summary: Delete a training by ID
|
||||||
operationId: deleteTraining
|
operationId: deleteTraining
|
||||||
|
tags:
|
||||||
|
- trainings
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -165,6 +175,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: List all dates of a training
|
summary: List all dates of a training
|
||||||
operationId: listTrainingDates
|
operationId: listTrainingDates
|
||||||
|
tags:
|
||||||
|
- training dates
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -191,6 +203,8 @@ paths:
|
||||||
post:
|
post:
|
||||||
summary: Create a new date for a training
|
summary: Create a new date for a training
|
||||||
operationId: createTrainingDate
|
operationId: createTrainingDate
|
||||||
|
tags:
|
||||||
|
- training dates
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -229,6 +243,8 @@ paths:
|
||||||
delete:
|
delete:
|
||||||
summary: Delete a date of a training
|
summary: Delete a date of a training
|
||||||
operationId: deleteTrainingDate
|
operationId: deleteTrainingDate
|
||||||
|
tags:
|
||||||
|
- training dates
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -262,6 +278,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: List all attendees of a date of a training
|
summary: List all attendees of a date of a training
|
||||||
operationId: listTrainingDateAttendees
|
operationId: listTrainingDateAttendees
|
||||||
|
tags:
|
||||||
|
- training dates attendees
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -294,6 +312,8 @@ paths:
|
||||||
post:
|
post:
|
||||||
summary: Add an attendee to a date of a training
|
summary: Add an attendee to a date of a training
|
||||||
operationId: createTrainingDateAttendee
|
operationId: createTrainingDateAttendee
|
||||||
|
tags:
|
||||||
|
- training dates attendees
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -337,6 +357,8 @@ paths:
|
||||||
delete:
|
delete:
|
||||||
summary: Delete an attendee of a date of a training
|
summary: Delete an attendee of a date of a training
|
||||||
operationId: deleteTrainingDateAttendee
|
operationId: deleteTrainingDateAttendee
|
||||||
|
tags:
|
||||||
|
- training dates attendees
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -376,6 +398,8 @@ paths:
|
||||||
post:
|
post:
|
||||||
summary: Submit feedback for an attendee of a date of a training
|
summary: Submit feedback for an attendee of a date of a training
|
||||||
operationId: createTrainingDateAttendeeFeedback
|
operationId: createTrainingDateAttendeeFeedback
|
||||||
|
tags:
|
||||||
|
- training attendee feedback
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -425,6 +449,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: List all feedback of a date of a training
|
summary: List all feedback of a date of a training
|
||||||
operationId: listTrainingDateFeedback
|
operationId: listTrainingDateFeedback
|
||||||
|
tags:
|
||||||
|
- training attendee feedback
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -458,6 +484,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: List all feedback of a training
|
summary: List all feedback of a training
|
||||||
operationId: listTrainingFeedback
|
operationId: listTrainingFeedback
|
||||||
|
tags:
|
||||||
|
- training attendee feedback
|
||||||
parameters:
|
parameters:
|
||||||
- name: trainingID
|
- name: trainingID
|
||||||
in: path
|
in: path
|
||||||
|
|
@ -485,6 +513,8 @@ paths:
|
||||||
get:
|
get:
|
||||||
summary: List all upcoming dates of all trainings
|
summary: List all upcoming dates of all trainings
|
||||||
operationId: listUpcomingTrainingDates
|
operationId: listUpcomingTrainingDates
|
||||||
|
tags:
|
||||||
|
- training dates
|
||||||
parameters:
|
parameters:
|
||||||
- name: from
|
- name: from
|
||||||
in: query
|
in: query
|
||||||
|
|
|
||||||
Reference in a new issue