Regenerate openapi.yaml

openapi.yaml

@@ -1,8 +1,19 @@
 openapi: 3.0.0
 paths:
-  /api/v4/ping:
+  /:
     get:
-      operationId: PingSend
+      operationId: AppHome
+      parameters: []
+      responses:
+        "200":
+          description: ""
+        "302":
+          description: Redirects to the API documentation.
+      tags: &a1
+        - default
+  /ping:
+    get:
+      operationId: AppPing
       summary: ""
       description: >-
         # Health check endpoint<br>
@@ -17,19 +28,13 @@ paths:
       parameters: []
       responses:
         "200":
-          description: ""
+          description: Pong
+          example: pong
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/Ping"
-        "500":
-          description: Internal Server Error
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/AxiosErrorDto"
-      tags:
-        - ping
+                type: string
+      tags: *a1
   /api/v4/auth/login:
     get:
       operationId: AuthLogin
@@ -39,26 +44,53 @@ paths:
           description: ""
         "302":
           description: Redirects to the AuthSch login page.
-        "401": &a1
+        "401": &a5
           description: Unauthorized
+          example: &a2
+            response:
+              data:
+                statusCode: 401
+                error: Unauthorized
+                message: Human readable error
+            status: 401
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AxiosErrorDto"
-        "403": &a2
+              example: *a2
+        "403": &a6
           description: Forbidden
+          example: &a3
+            response:
+              data:
+                statusCode: 403
+                error: Forbidden
+                message: Human readable error
+            status: 403
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AxiosErrorDto"
-        "500": &a3
+              example: *a3
+        "500": &a7
           description: Internal Server Error
+          example: &a4
+            response:
+              data:
+                statusCode: 500
+                error: Internal Server Error
+                message: Human readable error
+            status: 500
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AxiosErrorDto"
-      tags: &a4
+              example: *a4
+      tags: &a8
         - auth
+      security: &a9
+        - bearer: []
+        - jwt: []
   /api/v4/auth/callback:
     get:
       operationId: AuthOauthRedirect
@@ -72,10 +104,11 @@ paths:
           description: ""
         "302":
           description: Redirects to the frontend and sets cookie with JWT.
-        "401": *a1
-        "403": *a2
-        "500": *a3
-      tags: *a4
+        "401": *a5
+        "403": *a6
+        "500": *a7
+      tags: *a8
+      security: *a9
   /api/v4/auth/logout:
     get:
       operationId: AuthLogout
@@ -85,10 +118,11 @@ paths:
           description: ""
         "302":
           description: Redirects to the frontend and clears the JWT cookie.
-        "401": *a1
-        "403": *a2
-        "500": *a3
-      tags: *a4
+        "401": *a5
+        "403": *a6
+        "500": *a7
+      tags: *a8
+      security: *a9
   /api/v4/auth/me:
     get:
       operationId: AuthMe
@@ -100,10 +134,11 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/UserDto"
-        "401": *a1
-        "403": *a2
-        "500": *a3
-      tags: *a4
+        "401": *a5
+        "403": *a6
+        "500": *a7
+      tags: *a8
+      security: *a9
   /api/v4/group:
     post:
       operationId: GroupCreate
@@ -121,26 +156,53 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/GroupDto"
-        "401": &a5
+        "401": &a13
           description: Unauthorized
+          example: &a10
+            response:
+              data:
+                statusCode: 401
+                error: Unauthorized
+                message: Human readable error
+            status: 401
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AxiosErrorDto"
-        "403": &a6
+              example: *a10
+        "403": &a14
           description: Forbidden
+          example: &a11
+            response:
+              data:
+                statusCode: 403
+                error: Forbidden
+                message: Human readable error
+            status: 403
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AxiosErrorDto"
-        "500": &a7
+              example: *a11
+        "500": &a15
           description: Internal Server Error
+          example: &a12
+            response:
+              data:
+                statusCode: 500
+                error: Internal Server Error
+                message: Human readable error
+            status: 500
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AxiosErrorDto"
-      tags: &a8
+              example: *a12
+      tags: &a16
         - group
+      security: &a17
+        - bearer: []
+        - jwt: []
     get:
       operationId: GroupFindAll
       parameters:
@@ -165,10 +227,11 @@ paths:
                 type: array
                 items:
                   $ref: "#/components/schemas/GroupListItemDto"
-        "401": *a5
-        "403": *a6
-        "500": *a7
-      tags: *a8
+        "401": *a13
+        "403": *a14
+        "500": *a15
+      tags: *a16
+      security: *a17
   /api/v4/group/{id}:
     get:
       operationId: GroupFindOne
@@ -185,10 +248,11 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/GroupDto"
-        "401": *a5
-        "403": *a6
-        "500": *a7
-      tags: *a8
+        "401": *a13
+        "403": *a14
+        "500": *a15
+      tags: *a16
+      security: *a17
     put:
       operationId: GroupUpdate
       parameters:
@@ -210,10 +274,11 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/GroupDto"
-        "401": *a5
-        "403": *a6
-        "500": *a7
-      tags: *a8
+        "401": *a13
+        "403": *a14
+        "500": *a15
+      tags: *a16
+      security: *a17
     delete:
       operationId: GroupRemove
       parameters:
@@ -227,10 +292,11 @@ paths:
           description: ""
         "204":
           description: Delete group
-        "401": *a5
-        "403": *a6
-        "500": *a7
-      tags: *a8
+        "401": *a13
+        "403": *a14
+        "500": *a15
+      tags: *a16
+      security: *a17
 info:
   title: PÉK API
   description: Profiles and Groups
@@ -243,6 +309,10 @@ tags: []
 servers: []
 components:
   securitySchemes:
+    bearer:
+      scheme: bearer
+      bearerFormat: JWT
+      type: http
     cookie:
       type: apiKey
       in: cookie
@@ -253,9 +323,9 @@ components:
       properties:
         message:
           type: string
-          default: JWT cookie not found
+          default: JWT cookie or Bearer token not found
           enum:
-            - JWT cookie not found
+            - Authorization token not found
         statusCode:
           type: number
           default: 401
@@ -337,13 +407,6 @@ components:
       required:
         - response
         - status
-    Ping:
-      type: object
-      properties:
-        ping:
-          type: string
-      required:
-        - ping
     UserDto:
       type: object
       properties: