Add swagger specification for a new path called /randomnumbers (Azure…

…#13680) * Add swagger specification for a new path called /randomnumbers * Fix the errors got back from the pull request * Update the maximum of bytesLength parameter for /randomnumbers
AzureSDKAutomation · Mar 29, 2021 · 8830e8d · 8830e8d
1 parent 155d3d7
commit 8830e8d
Show file tree

Hide file tree

Showing 3 changed files with 86 additions and 0 deletions.
diff --git a/custom-words.txt b/custom-words.txt
@@ -1414,6 +1414,7 @@ racyscore
 RAGRS
 RAGZRS
 randint
+randomnumbers
 Rankable
 ratelimit
 ravbhatnagar

diff --git a/...ult/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/RandomNumbers-example.json b/...ult/data-plane/Microsoft.KeyVault/preview/7.3-preview/examples/RandomNumbers-example.json
@@ -0,0 +1,16 @@
+{
+  "parameters": {
+    "vaultBaseUrl": "https://myhsm.managedhsm.azure.net/",
+    "api-version": "7.3-preview",
+    "parameters": {
+      "bytesLength": 4
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": "MTIzNA"
+      }
+    }
+  }
+}
diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json
@@ -1088,9 +1088,78 @@
           }
         }
       }
+    },
+    "/randomnumbers": {
+      "post": {
+        "tags": [
+          "RandomNumbers"
+        ],
+        "operationId": "getRandomNumbers",
+        "summary": "Get the requested number of bytes containing random values.",
+        "description": "Get the requested number of bytes containing random values from a managed HSM.",
+        "parameters": [
+          {
+            "name": "parameters",
+            "in": "body",
+            "required": true,
+            "x-ms-client-flatten": true,
+            "schema": {
+              "$ref": "#/definitions/GetRandomNumbersRequest"
+            },
+            "description": "The request object to get random numbers."
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The bytes encoded as a base64url string.",
+            "schema": {
+              "$ref": "#/definitions/GetRandomNumbersResponse"
+            }
+          },
+          "default": {
+            "description": "Key Vault error response describing why the operation failed.",
+            "schema": {
+              "$ref": "common.json#/definitions/KeyVaultError"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "GetRandomNumbers": {
+            "$ref": "./examples/RandomNumbers-example.json"
+          }
+        }
+      }
     }
   },
   "definitions": {
+    "GetRandomNumbersRequest": {
+      "properties": {
+        "bytesLength": {
+          "type": "integer",
+          "format": "int32",
+          "minimum": 1,
+          "maximum": 128,
+          "description": "The requested number of random bytes."
+        }
+      },
+      "description": "The get random numbers request object.",
+      "required": [
+        "bytesLength"
+      ]
+    },
+    "GetRandomNumbersResponse": {
+      "properties": {
+        "value": {
+          "type": "string",
+          "format": "base64url",
+          "description": "The bytes encoded as a base64url string."
+        }
+      },
+      "description": "The get random numbers response object containing the bytes."
+    },
     "KeyReleasePolicy": {
       "properties": {
         "contentType": {