Compare commits

..

No commits in common. "7db95aa01cb90d5c7a1b1f4b31982c9420c4b28f" and "248c14df3894f5efe3ee448a9e603c54defdf42f" have entirely different histories.

View File

@ -10,15 +10,6 @@ servers:
- url: https://clyde.herisson.ovh/api - url: https://clyde.herisson.ovh/api
description: default api point for clyde's service description: default api point for clyde's service
tags:
- name: default
- name: General
description: General endpoints
- name: Ext (scientific articles)
description: Scientifics articles extension's endpoints
- name: Ext (Schedule)
description: Schedule extension's endpoints
paths: paths:
/ping: /ping:
get: get:
@ -44,7 +35,8 @@ paths:
name: type name: type
required: false required: false
schema: schema:
$ref: '#components/schemas/Roles' type: string
enum: [teacher, student, secretary]
responses: responses:
'200': '200':
description: OK description: OK
@ -97,8 +89,6 @@ paths:
BirthDate: BirthDate:
type: string type: string
description: Follow the iso 8601 ("YYYY-MM-DD") description: Follow the iso 8601 ("YYYY-MM-DD")
Role:
$ref: "#/components/schemas/Roles"
example: example:
{ {
"LastName": "Doe" , "LastName": "Doe" ,
@ -108,7 +98,6 @@ paths:
"Address": "Rue de Tournais 42", "Address": "Rue de Tournais 42",
"Country": "BE"}, "Country": "BE"},
"BirthDate": "1941-02-22", "BirthDate": "1941-02-22",
"Role": "student"
} }
responses: responses:
'201': '201':
@ -255,8 +244,7 @@ paths:
faculty: faculty:
type: string type: string
teachers: teachers:
type: integer $ref: '#/components/schemas/User'
description: Teacher's identifier
assistants: assistants:
type: array type: array
items: items:
@ -307,6 +295,8 @@ paths:
description: Cursus created description: Cursus created
'401': '401':
$ref: '#/components/responses/UnauthorizedError' $ref: '#/components/responses/UnauthorizedError'
/cursus/{id}: /cursus/{id}:
get: get:
summary: See Cursus's informations summary: See Cursus's informations
@ -922,6 +912,7 @@ paths:
items: items:
$ref: "#/components/schemas/DisplayArticle" $ref: "#/components/schemas/DisplayArticle"
components: components:
securitySchemes: securitySchemes:
bearer: bearer:
@ -946,8 +937,6 @@ components:
birthDate: birthDate:
type: string type: string
description: Follow the iso 8601 ("YYYY-MM-DD") description: Follow the iso 8601 ("YYYY-MM-DD")
role:
$ref: '#/components/schemas/Roles'
example: example:
{ {
"regNo": 42, "regNo": 42,
@ -958,7 +947,7 @@ components:
"address": "Rue de Tournais 42", "address": "Rue de Tournais 42",
"country": "BE"}, "country": "BE"},
"birthDate": "1941-02-22", "birthDate": "1941-02-22",
"role": "student" "staffMember": true,
} }
Address: Address:
type: object type: object
@ -1017,9 +1006,6 @@ components:
"id": 42, "id": 42,
"courses": ['Math', 'Info'] "courses": ['Math', 'Info']
} }
Roles:
type: string
enum: [teacher, student, secretary]
RegRequest: RegRequest:
type : object type : object
@ -1232,8 +1218,9 @@ components:
} }
responses: responses:
UnauthorizedError: UnauthorizedError:
description: Unauthorized access or missing bearer description: Unauthorized access or missing bearer