Adding app version settings APIs to swagger file. (#3850)

Azure · Sep 17, 2018 · f23d6ff · f23d6ff
1 parent 3df1915
commit f23d6ff
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 0 deletions.
diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json
@@ -7472,6 +7472,91 @@
           }
         }
       }
+    },
+    "/apps/{appId}/versions/{versionId}/settings": {
+      "get": {
+        "description": "Gets the application version settings.",
+        "operationId": "Settings_List",
+        "parameters": [
+          {
+            "$ref": "#/parameters/AppIdInPath"
+          },
+          {
+            "$ref": "#/parameters/VersionIdInPath"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A list of the application version settings.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/AppVersionSettingObject"
+              }
+            }
+          },
+          "default": {
+            "description": "Error Response.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "produces": [
+          "application/json"
+        ],
+        "x-ms-examples": {
+          "Successful Get Application Version settings request": {
+            "$ref": "./examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json"
+          }
+        }
+      },
+      "put": {
+        "description": "Updates the application version settings.",
+        "operationId": "Settings_Update",
+        "parameters": [
+          {
+            "$ref": "#/parameters/AppIdInPath"
+          },
+          {
+            "$ref": "#/parameters/VersionIdInPath"
+          },
+          {
+            "name": "listOfAppVersionSettingObject",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/AppVersionSettingObject"
+            },
+            "description": "A list of the updated application version settings."
+          }
+        ],
+        "consumes": [
+          "application/json"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation.",
+            "schema": {
+              "$ref": "#/definitions/OperationStatus"
+            }
+          },
+          "default": {
+            "description": "Error Response.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "produces": [
+          "application/json"
+        ],
+        "x-ms-examples": {
+          "Successful Update Application Version settings request": {
+            "$ref": "./examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json"
+          }
+        }
+      }
     }
   },
   "definitions": {
@@ -9723,6 +9808,20 @@
           "type": "string"
         }
       }
+    },
+    "AppVersionSettingObject": {
+      "description": "Object model of an application version setting.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The application version setting name.",
+          "type": "string"
+        },
+        "value": {
+          "description": "The application version setting value.",
+          "type": "string"
+        }
+      }
     }
   },
   "parameters": {

diff --git a/...thoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json b/...thoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json
@@ -0,0 +1,19 @@
+{
+  "parameters": {
+    "Endpoint": "{Endpoint}",
+    "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
+    "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
+    "versionId": "0.1"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": [
+        {
+          "name": "UseNegativeSampling",
+          "value": "false"
+        }
+      ]
+    }
+  }
+}
diff --git a/...ring/stable/v2.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json b/...ring/stable/v2.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json
@@ -0,0 +1,23 @@
+{
+	"parameters": {
+		"Endpoint": "{Endpoint}",
+		"Ocp-Apim-Subscription-Key": "00000000000000000000000000000000",
+		"appId": "363187f1-c573-46b3-bc4c-ae01d686e68e",
+		"versionId": "0.1",
+		"listOfAppVersionSettingObject": [
+			{
+				"name": "UseNegativeSampling",
+				"value": "false"
+			}
+		]
+	},
+	"responses": {
+		"200": {
+			"headers": {},
+			"body": {
+				"code": "Success",
+				"message": "Operation Successful"
+			}
+		}
+	}
+}