Adding Post req JSON format

pclubiitk · Jan 7, 2024 · 805267f · 805267f
1 parent 443cde6
commit 805267f
Show file tree

Hide file tree

Showing 20 changed files with 846 additions and 29 deletions.
diff --git a/docs/dist.json b/docs/dist.json
diff --git a/openapi/components/responses/response.yaml b/openapi/components/responses/response.yaml
@@ -0,0 +1,6 @@
+'200':
+  description: Successful response
+'400':
+  description: Bad request
+'500':
+  description: Internal server error
diff --git a/openapi/components/schemas/admin/user/new.yaml b/openapi/components/schemas/admin/user/new.yaml
@@ -0,0 +1,17 @@
+type: object
+properties:
+  newuser:
+    type: array
+    items:
+      type: object
+      properties:
+        roll:
+          type: string
+        name:
+          type: string
+        email:
+          type: string
+        gender:
+          type: string
+        passHash:
+          type: string
diff --git a/openapi/components/schemas/users/login/first.yaml b/openapi/components/schemas/users/login/first.yaml
@@ -0,0 +1,16 @@
+type: object
+properties:
+  roll:
+    type: string
+  authCode:
+    type: string
+  passHash:
+    type: string
+  pubKey:
+    type: string
+  privKey:
+    type: string
+  data:
+    type: string
+    enum:
+      - FIRST_LOGIN
diff --git a/openapi/components/schemas/users/sendheart.yaml b/openapi/components/schemas/users/sendheart.yaml
@@ -0,0 +1,29 @@
+type: object
+properties:
+  genderofsender:
+    type: string
+  enc1:
+    type: string
+  sha1:
+    type: string
+  enc2:
+    type: string
+  sha2:
+    type: string
+  enc3:
+    type: string
+  sha3:
+    type: string
+  enc4:
+    type: string
+  sha4:
+    type: string
+  returnhearts:
+    type: array
+    items:
+      type: object
+      properties:
+        enc:
+          type: string
+        sha:
+          type: string
diff --git a/openapi/components/schemas/users/sendheartVirtual.yaml b/openapi/components/schemas/users/sendheartVirtual.yaml
@@ -0,0 +1,41 @@
+type: object
+properties:
+  hearts:
+    type: object
+    properties:
+      heart1:
+        type: object
+        properties:
+          enc:
+            type: string
+          sha:
+            type: string
+          id_encrypt:
+            type: string
+      heart2:
+        type: object
+        properties:
+          enc:
+            type: string
+          sha:
+            type: string
+          id_encrypt:
+            type: string
+      heart3:
+        type: object
+        properties:
+          enc:
+            type: string
+          sha:
+            type: string
+          id_encrypt:
+            type: string
+      heart4:
+        type: object
+        properties:
+          enc:
+            type: string
+          sha:
+            type: string
+          id_encrypt:
+            type: string
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -58,7 +58,7 @@ paths:
     $ref: paths/users/verifyreturnhearts.yaml
   /users/sentHeartDecoded:
     $ref: paths/users/sentHeartDecoded.yaml
-  /users/special/returnclaimedheartlate:
+  /special/returnclaimedheartlate:
     $ref: paths/users/special/returnclaimedheartlate.yaml
   /users/publish:
     $ref: paths/users/publish.yaml

diff --git a/openapi/paths/admin/user/delete.yaml b/openapi/paths/admin/user/delete.yaml
@@ -3,4 +3,22 @@ post:
     - Admin
   summary: Delete User
   description: Receive the exact message you've sent
-  operationId: delete
+  operationId: delete
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            roll:
+              type: string
+            name:
+              type: string
+            email:
+              type: string
+            gender:
+              type: string
+  responses:
+    $ref: ../../../components/responses/response.yaml
diff --git a/openapi/paths/admin/user/new.yaml b/openapi/paths/admin/user/new.yaml
@@ -3,4 +3,13 @@ post:
     - Admin
   summary: Add New Users
   description: Receive the exact message you've sent
-  operationId: newUsers
+  operationId: newUsers
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          $ref: ../../../components/schemas/admin/user/new.yaml
+  responses:
+    $ref: ../../../components/responses/response.yaml
diff --git a/openapi/paths/session/admin/login.yaml b/openapi/paths/session/admin/login.yaml
@@ -4,4 +4,18 @@ post:
     - Session
   summary: Admin Login
   description: Receive the exact message you've sent
-  operationId: adminLogin
+  operationId: adminLogin
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            id:
+              type: string
+            pass:
+              type: string
+  responses:
+    $ref: ../../../components/responses/response.yaml
diff --git a/openapi/paths/session/login.yaml b/openapi/paths/session/login.yaml
@@ -4,4 +4,18 @@ post:
     - Session
   summary: User Login
   description: Receive the exact message you've sent
-  operationId: userLogin
+  operationId: userLogin
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            _id:
+              type: string
+            passHash:
+              type: string
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/claimheart.yaml b/openapi/paths/users/claimheart.yaml
@@ -4,4 +4,20 @@ post:
     - Verify
   summary: Claim from send_hearts Table
   description: Receive the exact message you've sent
-  operationId: claimHeart
+  operationId: claimHeart
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            enc:
+              type: string
+            sha:
+              type: string
+            genderOfSender:
+              type: string
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/login/first.yaml b/openapi/paths/users/login/first.yaml
@@ -3,4 +3,13 @@ post:
     - User
   summary: Register User
   description: Receive the exact message you've sent
-  operationId: register
+  operationId: register
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          $ref: ../../../components/schemas/users/login/first.yaml
+  responses:
+    $ref: ../../../components/responses/response.yaml
diff --git a/openapi/paths/users/mail:id.yaml b/openapi/paths/users/mail:id.yaml
@@ -3,4 +3,14 @@ post:
     - User
   summary: Mail Authentication Code
   description: Receive the exact message you've sent
-  operationId: mail
+  operationId: mail
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties: {}
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/publish.yaml b/openapi/paths/users/publish.yaml
@@ -3,4 +3,14 @@ post:
     - User
   summary: User Permission to Publish his/her result
   description: Receive the exact message you've sent
-  operationId: permisssion
+  operationId: permisssion
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties: {}
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/sendheart.yaml b/openapi/paths/users/sendheart.yaml
@@ -4,4 +4,13 @@ post:
     - Send
   summary: Send Hearts
   description: Receive the exact message you've sent
-  operationId: sendHearts
+  operationId: sendHearts
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/users/sendheart.yaml
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/sendheartVirtual.yaml b/openapi/paths/users/sendheartVirtual.yaml
@@ -4,4 +4,13 @@ post:
     - Send
   summary: Save User Selections
   description: Receive the exact message you've sent
-  operationId: sendHeartsVirtual
+  operationId: sendHeartsVirtual
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/users/sendheartVirtual.yaml
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/sentHeartDecoded.yaml b/openapi/paths/users/sentHeartDecoded.yaml
@@ -3,4 +3,23 @@ post:
     - User
   summary: Gender Wise Heart Count
   description: Receive the exact message you've sent
-  operationId: heartCount
+  operationId: heartCount
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            decodedHearts:
+              type: array
+              items:
+                type: object
+                properties:
+                  enc:
+                    type: string
+                  genderOfSender:
+                    type: string
+  responses:
+    $ref: ../../components/responses/response.yaml
diff --git a/openapi/paths/users/special/returnclaimedheartlate.yaml b/openapi/paths/users/special/returnclaimedheartlate.yaml
@@ -3,4 +3,23 @@ post:
     - User
   summary: Returning claim in return_hearts Table
   description: Receive the exact message you've sent
-  operationId: late
+  operationId: late
+  requestBody:
+    description:
+    required: true 
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            returnhearts:
+              type: array
+              items:
+                type: object
+                properties:
+                  enc:
+                    type: string
+                  sha:
+                    type: string
+  responses:
+    $ref: ../../../components/responses/response.yaml