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. <br/>
+    Each endpoints are organised by endpoints **AND** by extensions making it easier to navigate.
   version: 0.0.1
 
 servers:
@@ -51,6 +53,8 @@ paths:
       summary: get informations about yourself 
       tags:
         - Users
+      security:
+        - bearer: []
       responses:
         '200':
           description: Ok
@@ -58,6 +62,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/User"
+        '401':
+          $ref: '#/components/responses/UnauthorizedError'
     post:
       summary: Create user
       tags:
@@ -377,7 +383,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,
@@ -392,7 +398,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: