From 5359587bdc5ca2234a6a8c267549c14cc3ecdfef Mon Sep 17 00:00:00 2001 From: Richard Zhao Date: Fri, 2 Jul 2021 11:40:53 +0800 Subject: [PATCH 1/2] add missing descriptions to machineLearningServices.json --- .../2021-07-01/machineLearningServices.json | 47 ++++++++++++++++--- 1 file changed, 41 insertions(+), 6 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json index d0a2f26268ad..289bbea6bc7a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json @@ -1473,6 +1473,8 @@ "ProxyOperations" ], "operationId": "Workspaces_PrepareNotebook", + "description": "Prepare a notebook.", + "summary": "Prepare and initialize a Notebook instance.", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" @@ -1521,6 +1523,8 @@ "ProxyOperations" ], "operationId": "Workspaces_ListStorageAccountKeys", + "description": "List storage account keys of a workspace.", + "summary": "List storage account keys", "x-ms-examples": { "List Workspace Keys": { "$ref": "./examples/Workspace/listStorageAccountKeys.json" @@ -1562,6 +1566,8 @@ "ProxyOperations" ], "operationId": "Workspaces_ListNotebookKeys", + "description": "List keys of a notebook.", + "summary": "List storage account keys", "x-ms-examples": { "List Workspace Keys": { "$ref": "./examples/Notebook/listKeys.json" @@ -1975,6 +1981,7 @@ "description": "The sku of the workspace." }, "systemData": { + "description": "System data", "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } } @@ -2471,6 +2478,7 @@ }, "DiagnoseRequestProperties": { "type": "object", + "description": "Properties of a diagnose request", "properties": { "udr": { "description": "Setting for diagnosing user defined routing", @@ -2508,6 +2516,7 @@ }, "DiagnoseWorkspaceParameters": { "type": "object", + "description": "Parameters to diagnose a workspace", "properties": { "value": { "$ref": "#/definitions/DiagnoseRequestProperties" @@ -2516,6 +2525,7 @@ }, "DiagnoseResult": { "type": "object", + "description": "Result of Diagnose", "properties": { "code": { "description": "Code for workspace setup error", @@ -2544,54 +2554,64 @@ }, "DiagnoseResponseResult": { "type": "object", + "description": "Result of DiagnoseResponse", "properties": { "value": { "type": "object", + "description": "Value of DiagnoseResponse", "properties": { "UDR": { "type": "array", + "description": "UDR value", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "NSG": { "type": "array", + "description": "NSG value", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "ResourceLock": { "type": "array", + "description": "Resource Lock", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "DNSResolution": { "type": "array", + "description": "DNS Resolution", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "StorageAccount": { "type": "array", + "description": "Storage Account", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "KeyVault": { "type": "array", + "description": "The KeyVault", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "ContainerRegistry": { "type": "array", + "description": "Container Registry", "items": { "$ref": "#/definitions/DiagnoseResult" } }, "Others": { "type": "array", + "description": "Other items", "items": { "$ref": "#/definitions/DiagnoseResult" } @@ -2975,6 +2995,7 @@ "description": "The sku of the workspace." }, "systemData": { + "description": "System data", "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } } @@ -3140,17 +3161,22 @@ "$ref": "#/definitions/Compute" }, { - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/KubernetesProperties" - } - } + "$ref": "#/definitions/KubernetesSchema" } ], "x-ms-discriminator-value": "Kubernetes" }, + "KubernetesSchema": { + "type": "object", + "description": "Kubernetes Compute Schema", + "properties": { + "properties": { + "$ref": "#/definitions/KubernetesProperties" + } + } + }, + "KubernetesProperties": { "type": "object", "description": "Kubernetes properties", @@ -3806,6 +3832,7 @@ "description": "Counts of various compute node states on the amlCompute." }, "ScaleSettingsInformation": { + "type": "object", "properties": { "scaleSettings": { "$ref": "#/definitions/ScaleSettings", @@ -3865,6 +3892,7 @@ }, "AmlComputeNodesResult": { "type": "object", + "description": "Result of AmlCompute Nodes", "properties": { "nodes": { "readOnly": true, @@ -3968,6 +3996,7 @@ }, "AksComputeSecretsProperties": { "type": "object", + "description": "Properties of AksComputeSecrets", "properties": { "userKubeConfig": { "type": "string", @@ -4015,6 +4044,7 @@ }, "DatabricksComputeSecretsProperties": { "type": "object", + "description": "Properties of Databricks Compute Secrets", "properties": { "databricksAccessToken": { "description": "access token for databricks account.", @@ -4069,6 +4099,7 @@ } }, "PrivateEndpointConnectionListResult": { + "type": "object", "properties": { "value": { "type": "array", @@ -4107,6 +4138,7 @@ "description": "The sku of the workspace." }, "systemData": { + "description": "System data", "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } }, @@ -4238,6 +4270,7 @@ "description": "The sku of the workspace." }, "systemData": { + "description": "System data", "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" } }, @@ -4883,9 +4916,11 @@ "description": "Resource requests/limits for this instance type", "properties": { "requests": { + "description": "Resource requests for this instance type", "$ref": "#/definitions/InstanceResourceSchema" }, "limits": { + "description": "Resource limits for this instance type", "$ref": "#/definitions/InstanceResourceSchema" } } From 71d7e3ad395e804540a09f3542aa66c204928599 Mon Sep 17 00:00:00 2001 From: Richard Zhao Date: Fri, 2 Jul 2021 13:58:21 +0800 Subject: [PATCH 2/2] tiny change --- .../2021-07-01/machineLearningServices.json | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json index 289bbea6bc7a..637cba2ba24e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2021-07-01/machineLearningServices.json @@ -4904,28 +4904,28 @@ "type": "object", "description": "Instance type schema.", "properties": { - "nodeSelector": { - "type": "object", - "description": "NodeSelector", - "additionalProperties": { - "type": "string" - } - }, - "resources": { - "type": "object", - "description": "Resource requests/limits for this instance type", - "properties": { - "requests": { - "description": "Resource requests for this instance type", - "$ref": "#/definitions/InstanceResourceSchema" - }, - "limits": { - "description": "Resource limits for this instance type", - "$ref": "#/definitions/InstanceResourceSchema" - } + "nodeSelector": { + "type": "object", + "description": "Node Selector", + "additionalProperties": { + "type": "string" + } + }, + "resources": { + "type": "object", + "description": "Resource requests/limits for this instance type", + "properties": { + "requests": { + "description": "Resource requests for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" + }, + "limits": { + "description": "Resource limits for this instance type", + "$ref": "#/definitions/InstanceResourceSchema" } } } + } }, "InstanceResourceSchema": { "type": "object",