diff --git a/Documents/proto/general/openapi.yaml b/Documents/proto/general/openapi.yaml index 64fa70c..621e382 100644 --- a/Documents/proto/general/openapi.yaml +++ b/Documents/proto/general/openapi.yaml @@ -1,7 +1,9 @@ openapi: 3.0.0 info: title: ClydeAPI - description: Clyde's api + description: + This is the Clyde's api documentation.
+ Each endpoints are organised by endpoints **AND** by extensions making it easier to navigate. version: 0.0.1 servers: @@ -24,6 +26,7 @@ paths: get: summary: list all users tags: + - General - SI security: - bearer: [] @@ -50,17 +53,30 @@ paths: get: summary: get informations about yourself tags: + - General - Users - responses: + security: + - bearer: [] + parameters: + - in: query + name: type + required: false + schema: + type: string + enum: [teacher, student, secretary] + responses: '200': description: Ok content: application/json: schema: $ref: "#/components/schemas/User" + '401': + $ref: '#/components/responses/UnauthorizedError' post: summary: Create user tags: + - General - Users requestBody: required: true @@ -98,6 +114,7 @@ paths: patch: summary: Change informations about yourself tags: + - General - Users security: - bearer: [] @@ -123,6 +140,7 @@ paths: get: summary: Get user's informations tags: + - General - Admin responses: '200': @@ -134,6 +152,7 @@ paths: patch: summary: Alter user's informations tags: + - General - Admin security: - bearer: [] @@ -152,6 +171,7 @@ paths: post: summary: Create new course tags: + - General - Courses - Secretariat security: @@ -178,6 +198,7 @@ paths: get: summary: see courses informations tags: + - General - Courses responses: '200': @@ -195,6 +216,7 @@ paths: delete: summary: delete a course tags: + - General - Courses - Secretariat security: @@ -207,6 +229,7 @@ paths: patch: summary: Change course options tags: + - General - Secretariat - Courses security: @@ -249,6 +272,7 @@ paths: post: summary: Create a cursus tags: + - General - cursus security: - bearer: [] @@ -280,6 +304,7 @@ paths: get: summary: See Cursus's informations tags: + - General - cursus responses: '200': @@ -297,6 +322,7 @@ paths: delete: summary: Delete cursus tags: + - General - cursus security: - bearer: [] @@ -308,6 +334,7 @@ paths: patch: summary: Modify cursus tags: + - General - cursus security: - bearer: [] @@ -605,7 +632,7 @@ components: "firstName": "John", "email": "John.Doe@example.com", "address": { - "address": "Rue de Tounais 42", + "address": "Rue de Tournais 42", "country": "BE"}, "birthDate": "1941-02-22", "staffMember": true, @@ -620,7 +647,7 @@ components: description: Follow the ISO-3166-1 alpha-2 standard. example: { - "address": "Rue de Tounais 42", + "address": "Rue de Tournais 42", "country": "BE" } Course: @@ -726,4 +753,4 @@ components: } responses: UnauthorizedError: - description: Unauthorized access or missing bearer \ No newline at end of file + description: Unauthorized access or missing bearer