Deploying to gh-pages from @ cef6dbe 🚀

rarimo · May 13, 2024 · db1353b · db1353b
1 parent 61cf4c1
commit db1353b
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 25 deletions.
diff --git a/openapi.json b/openapi.json
@@ -75,23 +75,23 @@
         }
       }
     },
-    "/integrations/airdrop-svc/airdrops/{id}": {
+    "/integrations/airdrop-svc/airdrops/{nullifier}": {
       "get": {
         "tags": [
           "Airdrop"
         ],
         "summary": "Get an airdrop",
         "description": "Get an airdrop for unique user.",
-        "operationId": "createAirdrop",
+        "operationId": "getAirdrop",
         "parameters": [
           {
             "in": "path",
-            "name": "id",
+            "name": "nullifier",
             "description": "User nullifier",
             "required": true,
             "schema": {
               "type": "string",
-              "example": "0x04a32216f2425dc7343031352de3d62a7b0d3b4bf7a66d6c8c2aa8c9f4f2632b"
+              "example": "48274927346589028382136333339484890005759403737728382873187445992373311929001"
             }
           }
         ],
@@ -153,9 +153,9 @@
                 "type": "object",
                 "required": [
                   "address",
+                  "nullifier",
                   "status",
                   "amount",
-                  "tx_hash",
                   "created_at",
                   "updated_at"
                 ],
@@ -165,6 +165,11 @@
                     "description": "Destination address for the airdrop",
                     "example": "rarimo1qlyq3ej7j7rrkw6sluz658pzne88ymf66vjcap"
                   },
+                  "nullifier": {
+                    "type": "string",
+                    "description": "User nullifier",
+                    "example": "48274927346589028382136333339484890005759403737728382873187445992373311929001"
+                  },
                   "status": {
                     "type": "string",
                     "description": "Status of the airdrop transaction",
@@ -210,8 +215,8 @@
         "properties": {
           "id": {
             "type": "string",
-            "description": "User nullifier",
-            "example": "0x04a32216f2425dc7343031352de3d62a7b0d3b4bf7a66d6c8c2aa8c9f4f2632b"
+            "description": "Airdrop UUID",
+            "example": "4bf0b086-decf-4ffb-8d30-7c28665adef9"
           },
           "type": {
             "type": "string",
@@ -237,7 +242,6 @@
                 "type": "object",
                 "required": [
                   "address",
-                  "algorithm",
                   "zk_proof"
                 ],
                 "properties": {
@@ -246,11 +250,6 @@
                     "description": "Destination address for the airdrop",
                     "example": "rarimo1qlyq3ej7j7rrkw6sluz658pzne88ymf66vjcap"
                   },
-                  "algorithm": {
-                    "type": "string",
-                    "description": "Signing algorithm used in proof. The value from passport document SOD is assumed.",
-                    "example": "sha256_ecdsa"
-                  },
                   "zk_proof": {
                     "type": "string",
                     "format": "types.ZKProof",

diff --git a/openapi.yaml b/openapi.yaml
@@ -46,21 +46,21 @@ paths:
                 $ref: '#/components/schemas/Errors'
         '500':
           $ref: '#/components/responses/internalError'
-  '/integrations/airdrop-svc/airdrops/{id}':
+  '/integrations/airdrop-svc/airdrops/{nullifier}':
     get:
       tags:
         - Airdrop
       summary: Get an airdrop
       description: Get an airdrop for unique user.
-      operationId: createAirdrop
+      operationId: getAirdrop
       parameters:
         - in: path
-          name: id
+          name: nullifier
           description: User nullifier
           required: true
           schema:
             type: string
-            example: '0x04a32216f2425dc7343031352de3d62a7b0d3b4bf7a66d6c8c2aa8c9f4f2632b'
+            example: '48274927346589028382136333339484890005759403737728382873187445992373311929001'
       responses:
         '200':
           content:
@@ -97,16 +97,20 @@ components:
               type: object
               required:
                 - address
+                - nullifier
                 - status
                 - amount
-                - tx_hash
                 - created_at
                 - updated_at
               properties:
                 address:
                   type: string
                   description: Destination address for the airdrop
                   example: rarimo1qlyq3ej7j7rrkw6sluz658pzne88ymf66vjcap
+                nullifier:
+                  type: string
+                  description: User nullifier
+                  example: '48274927346589028382136333339484890005759403737728382873187445992373311929001'
                 status:
                   type: string
                   description: Status of the airdrop transaction
@@ -139,8 +143,8 @@ components:
       properties:
         id:
           type: string
-          description: User nullifier
-          example: '0x04a32216f2425dc7343031352de3d62a7b0d3b4bf7a66d6c8c2aa8c9f4f2632b'
+          description: Airdrop UUID
+          example: 4bf0b086-decf-4ffb-8d30-7c28665adef9
         type:
           type: string
           enum:
@@ -157,17 +161,12 @@ components:
               type: object
               required:
                 - address
-                - algorithm
                 - zk_proof
               properties:
                 address:
                   type: string
                   description: Destination address for the airdrop
                   example: rarimo1qlyq3ej7j7rrkw6sluz658pzne88ymf66vjcap
-                algorithm:
-                  type: string
-                  description: Signing algorithm used in proof. The value from passport document SOD is assumed.
-                  example: sha256_ecdsa
                 zk_proof:
                   type: string
                   format: types.ZKProof