docs(gateway API): update with last json response version

zama-ai · Sep 30, 2024 · 26086d6 · 26086d6
1 parent 95603d7
commit 26086d6
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 137 deletions.
diff --git a/docs/fundamentals/coprocessor/inputs.md b/docs/fundamentals/coprocessor/inputs.md
diff --git a/docs/references/gateway_api.md b/docs/references/gateway_api.md
@@ -7,13 +7,11 @@
 
 #### Description
 
-This endpoint returns a JSON object containing URLs from an S3 bucket, allowing the client to download important files such as the blockchain public key, CRS files for generating input proofs, and the bootstrap key. 
+This endpoint returns a JSON object containing URLs from an S3 bucket, allowing the client to download key files such as the blockchain public key, CRS files for input proof generation, and the bootstrap key.
 
-For each item, multiple URLs are provided to improve availability, but all URLs point to the same file. This ensures redundancy and reliable access. 
+For each file, a list of cryptographic signatures is provided to ensure the integrity and authenticity of the downloaded content. These signatures are generated using a threshold signature scheme. This means that instead of needing all the signatures to validate the content, only a subset—specifically one-third of the total signatures (if n nodes are signing)—is required to verify that the content is legitimate. 
 
-Each URL is accompanied by a cryptographic signature, enabling users to verify the integrity and authenticity of the downloaded files. 
-
-No query parameters are needed, as the gateway is already configured for a specific blockchain.
+No query parameters are required, as the gateway is already preconfigured for a specific blockchain.
 
 
 
@@ -33,41 +31,35 @@ The request is successful, and the response will include a JSON object with the
 
 ```json
 {
-  "keyId": "12345",
-  "publicKey": [
-    {
-      "url": "https://s3.amazonaws.com/bucket-name/pks1",
-      "signature": "a5d2c5e8f7b60f..."
+    "keyId": "ab12cd",
+    "crsId": "34ef67",
+    "publicKey": {
+        "url": "https://s3.amazonaws.com/bucket-name/pubkey",
+        "signatures": [
+            "a5d2...",
+            "a8cd...",
+            "c0ff..."
+        ]
     },
-    {
-      "url": "https://s3.amazonaws.com/bucket-name1/pks1",
-      "signature": "a5d2c5e8f7b60f..."
-    }
-  ],
-  "crs": {
-    "2048": [
-      {
-        "url": "https://s3.amazonaws.com/bucket-name/crs1",
-        "signature": "c3f5d6e1e2f8b3..."
-      },
-      {
-        "url": "https://s3.amazonaws.com/bucket-name1/crs1",
-        "signature": "c3f5d6e1e2f8b3..."
-      }
-    ]
-  },
-  "bootstrapKey": [
-    {
-      "url": "https://s3.amazonaws.com/bucket-name/sks1",
-      "signature": "b4a1d8f9c7e1a2..."
+    "bootstrapKey": {
+        "url": "https://s3.amazonaws.com/bucket-name/bootstrapkey",
+        "signatures": [
+            "fd7a...",
+            "487b...",
+            "20fe..."
+        ]
     },
-    {
-      "url": "https://s3.amazonaws.com/bucket-name1/sks1",
-      "signature": "b4a1d8f9c7e1a2..."
+    "crs": {
+        "2048": {
+            "url": "https://s3.amazonaws.com/bucket-name/crs",
+            "signatures": [
+                "ffee...",
+                "012f...",
+                "1ab5..."
+            ]
+        }
     }
-  ]
 }
-
 ```
 
 **Error Responses**