feat: add documentation for social auth routes

Author: simply-alliv

src/jsdocs/providers/facebook.yaml

@@ -0,0 +1,29 @@
+paths:
+  # Endpoint to authenticate a Facebook user
+  /social/facebook:
+    # GET operation
+    get:
+      tags:
+        - providers
+
+      summary: Authenticates with Facebook
+
+      responses:
+        "200":
+          description: Successful operation
+          schema:
+            type: object
+            properties:
+              status:
+                type: string
+                example: success
+              data:
+                type: object
+                properties:
+                  authenticationUrl:
+                    type: string
+                    example: https://www.facebook.com/v4.0/dialog/oauth
+        "400":
+          description: Invalid body supplied
+          schema:
+            $ref: "#/definitions/BadRequest"

src/jsdocs/providers/github.yaml

@@ -0,0 +1,29 @@
+paths:
+  # Endpoint to authenticate a GitHub user
+  /social/github:
+    # GET operation
+    get:
+      tags:
+        - providers
+
+      summary: Authenticates with GitHub
+
+      responses:
+        "200":
+          description: Successful operation
+          schema:
+            type: object
+            properties:
+              status:
+                type: string
+                example: success
+              data:
+                type: object
+                properties:
+                  authenticationUrl:
+                    type: string
+                    example: https://github.com/login/oauth/authorize
+        "400":
+          description: Invalid body supplied
+          schema:
+            $ref: "#/definitions/BadRequest"

src/jsdocs/providers/google.yaml

@@ -1,16 +1,13 @@
 paths:
-  # Endpoint to authenticate a user
-  /google:
+  # Endpoint to authenticate a Google user
+  /social/google:
     # GET operation
     get:
       tags:
         - providers
 
       summary: Authenticates with Google
 
-      security:
-        - AdminToken: []
-
       responses:
         "200":
           description: Successful operation
@@ -23,7 +20,7 @@ paths:
               data:
                 type: object
                 properties:
-                  redirectUrl:
+                  authenticationUrl:
                     type: string
                     example: https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount
         "400":

src/jsdocs/providers/twitter.yaml

@@ -0,0 +1,29 @@
+paths:
+  # Endpoint to authenticate a Twitter user
+  /social/twitter:
+    # GET operation
+    get:
+      tags:
+        - providers
+
+      summary: Authenticates with Twitter
+
+      responses:
+        "200":
+          description: Successful operation
+          schema:
+            type: object
+            properties:
+              status:
+                type: string
+                example: success
+              data:
+                type: object
+                properties:
+                  authenticationUrl:
+                    type: string
+                    example: https://api.twitter.com/oauth/authenticate
+        "400":
+          description: Invalid body supplied
+          schema:
+            $ref: "#/definitions/BadRequest"