From c3caa43012ce447cc7f2b37e6939f1e060336c75 Mon Sep 17 00:00:00 2001 From: Aleksandar Tomic Date: Mon, 8 Feb 2021 19:29:47 +0000 Subject: [PATCH 1/6] Updating descriptions Updating enum names Updating STS description --- .../preview/2021-01-01-preview/mr-arr.json | 217 +++++++++++------- 1 file changed, 138 insertions(+), 79 deletions(-) diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index 3a94c263ada6..6e5207e4cbba 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -54,7 +54,7 @@ ], "responses": { "200": { - "description": "Ok. A new conversion was created. A status code of 200 indicates that there was already a conversion with the same settings present. This is expected when a conversion creation is retried.", + "description": "OK. Indicates that there was already a conversion with the same settings present. This is expected when a conversion creation is retried.", "headers": { "MS-CV": { "description": "Microsoft Correlation Vector. Include this value when reporting issues.", @@ -91,7 +91,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -105,7 +105,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -128,7 +128,7 @@ } }, "429": { - "description": "Too Many Requests. In case the rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -142,7 +142,7 @@ } }, "500": { - "description": "Internal server error", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "schema": { "$ref": "#/definitions/error_response" @@ -152,7 +152,6 @@ "tags": [ "conversion" ], - "description": "Creates a conversion using an asset stored in an Azure Blob Storage account.\nIf the remote rendering account has been linked with the storage account no Shared Access Signatures (storageContainerReadListSas, storageContainerWriteSas) for storage access need to be provided.\nDocumentation how to link your Azure Remote Rendering account with the Azure Blob Storage account can be found in the [documentation](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts).\n \nAll files in the input container starting with the blobPrefix will be retrieved to perform the conversion. To cut down on conversion times only necessary files should be available under the blobPrefix.\n", "summary": "Creates a conversion using an asset stored in an Azure Blob Storage account." }, "get": { @@ -178,7 +177,7 @@ }, "responses": { "200": { - "description": "OK", + "description": "OK.", "headers": { "MS-CV": { "description": "Microsoft Correlation Vector. Include this value when reporting issues.", @@ -194,7 +193,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -208,7 +207,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -218,7 +217,7 @@ } }, "404": { - "description": "Not found. No conversion with the provided conversion id exists", + "description": "Not found. No conversion with the provided conversion ID exists.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -228,7 +227,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -242,7 +241,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -258,7 +257,7 @@ "tags": [ "conversion" ], - "summary": "Gets the status of a previously created asset conversion" + "summary": "Gets the status of a particular conversion." } }, "/accounts/{account_id}/conversions": { @@ -282,7 +281,7 @@ }, "responses": { "200": { - "description": "OK", + "description": "OK.", "headers": { "MS-CV": { "description": "Microsoft Correlation Vector. Include this value when reporting issues.", @@ -294,7 +293,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -308,7 +307,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -318,7 +317,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -332,7 +331,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -352,7 +351,7 @@ "tags": [ "conversion" ], - "summary": "Gets a list of all conversions. Returns a batch of conversions- if more conversions are available the @nextLink property contains the a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API." + "summary": "Gets a list of all conversions." } }, "/accounts/{account_id}/sessions/{session_id}": { @@ -375,7 +374,7 @@ "$ref": "#/parameters/session_id" }, { - "description": "Settings of the session to be created", + "description": "Settings of the session to be created.", "in": "body", "name": "body", "required": true, @@ -391,7 +390,7 @@ }, "responses": { "200": { - "description": "Ok. The session was created successfully. A status code of 200 indicates that there was already a session with the same settings present. This is expected when session creation is retried.", + "description": "OK. Indicates that there was already a session with the same settings present. This is expected when session creation is retried.", "schema": { "$ref": "#/definitions/session_properties" } @@ -409,7 +408,7 @@ } }, "400": { - "description": "BadRequest", + "description": "BadRequest.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -422,7 +421,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -436,7 +435,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -453,7 +452,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -467,7 +466,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -483,7 +482,7 @@ "tags": [ "rendering session" ], - "summary": "Creates a new rendering session" + "summary": "Creates a new rendering session." }, "get": { "operationId": "GetSession", @@ -508,13 +507,13 @@ }, "responses": { "200": { - "description": "OK - returns a session properties object", + "description": "OK.", "schema": { "$ref": "#/definitions/session_properties" } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -528,7 +527,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -538,7 +537,7 @@ } }, "404": { - "description": "The specified resource was not found.", + "description": "Not found. No session with the provided session ID exists.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -548,7 +547,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -562,7 +561,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -578,7 +577,7 @@ "tags": [ "rendering session" ], - "summary": "Gets properties of a particular rendering session" + "summary": "Gets the properties of a particular rendering session." }, "patch": { "operationId": "UpdateSession", @@ -615,13 +614,13 @@ }, "responses": { "200": { - "description": "OK", + "description": "OK. Session has been updated.", "schema": { "$ref": "#/definitions/session_properties" } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -635,7 +634,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -645,7 +644,7 @@ } }, "404": { - "description": "The specified resource was not found.", + "description": "Not found. No session with the provided session ID exists.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -655,7 +654,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -682,7 +681,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -698,7 +697,7 @@ "tags": [ "rendering session" ], - "summary": "Updates a particular rendering session" + "summary": "Updates a particular rendering session." } }, "/accounts/{account_id}/sessions/{session_id}/:stop": { @@ -725,7 +724,7 @@ }, "responses": { "204": { - "description": "NoContent - stop request was successful. The rendering session is stopped.", + "description": "NoContent. Stop request was successful. The rendering session is stopped.", "headers": { "MS-CV": { "description": "Microsoft Correlation Vector. Include this value when reporting issues.", @@ -734,7 +733,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -748,7 +747,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -758,7 +757,7 @@ } }, "404": { - "description": "The specified resource was not found.", + "description": "Not found. No session with the provided session ID exists.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -768,7 +767,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -782,7 +781,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -798,7 +797,7 @@ "tags": [ "rendering session" ], - "summary": "Stops a particular rendering session" + "summary": "Stops a particular rendering session." } }, "/accounts/{account_id}/sessions": { @@ -826,13 +825,13 @@ }, "responses": { "200": { - "description": "OK - returns the list of sessions which are in a Starting or Ready state", + "description": "OK. Returns the list of sessions which are in a 'Starting' or 'Ready' state.", "schema": { "$ref": "#/definitions/sessions_list" } }, "401": { - "description": "Unauthorized", + "description": "Unauthorized. Missing or invalid authorization.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -846,7 +845,7 @@ } }, "403": { - "description": "Forbidden", + "description": "Forbidden. Authorization insufficient for given resource.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -856,7 +855,7 @@ } }, "429": { - "description": "In case the rate limit has been exceeded.", + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -870,7 +869,7 @@ } }, "500": { - "description": "InternalError", + "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -886,7 +885,7 @@ "tags": [ "rendering session" ], - "summary": "Get a list of all rendering sessions" + "summary": "Gets a list of all rendering sessions." } } }, @@ -895,7 +894,7 @@ "properties": { "id": { "type": "string", - "description": "The id of the conversion supplied when the conversion was created." + "description": "The ID of the conversion supplied when the conversion was created." }, "settings": { "$ref": "#/definitions/conversion_settings" @@ -940,6 +939,7 @@ "type": "object" }, "conversion_list": { + "description": "List of conversions.", "properties": { "conversions": { "items": { @@ -949,7 +949,7 @@ "description": "The list of conversions." }, "@nextLink": { - "description": "If more conversions are available this link with the same authentication header can be used to retrieve further values", + "description": "If more conversions are available this property will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", "type": "string", "readOnly": true } @@ -973,12 +973,12 @@ }, "blobPrefix": { "type": "string", - "description": "Only Blobs starting with this prefix will be downloaded to perform the conversion.", + "description": "Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded.", "example": "models/" }, "relativeInputAssetPath": { "type": "string", - "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not specified) to the input model. Must point to file with a supported file format ending.", + "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to file with a supported file format ending. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/conversion/model-conversion for details.", "example": "house.fbx" } }, @@ -1003,12 +1003,12 @@ }, "blobPrefix": { "type": "string", - "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treaded as a virtual folder.", + "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treaded as a virtual folder. Optional. If not provided, output files will be stored at container root.", "example": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e" }, "outputAssetFilename": { "type": "string", - "description": "The file name of the output asset. Must end in '.arrAsset'.", + "description": "The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension", "example": "house.arrAsset" } }, @@ -1047,7 +1047,7 @@ "type": "object" }, "conversion_status": { - "description": "The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'", + "description": "The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'.", "enum": [ "NotStarted", "Running", @@ -1057,11 +1057,34 @@ ], "type": "string", "x-ms-enum": { - "name": "ConversionStatus", - "modelAsString": true + "name": "conversion_status", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The conversion was created but hasn't started." + }, + { + "value": "Running", + "description": "The conversion is running." + }, + { + "value": "Cancelled", + "description": "The conversion was cancelled. This is a terminal state." + }, + { + "value": "Failed", + "description": "The conversion has failed. Check the 'error' field for more details. This is a terminal state." + }, + { + "value": "Succeeded", + "description": "The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state." + } + ] } }, "error_response": { + "description": "The error response containing details of why the request failed.", "properties": { "error": { "description": "The error object containing details of why the request failed.", @@ -1075,14 +1098,15 @@ ] }, "error": { + "description": "The error object containing details of why the request failed.", "properties": { "code": { "type": "string", - "description": "Error code" + "description": "Error code." }, "message": { "type": "string", - "description": "A human-readable representation of the error" + "description": "A human-readable representation of the error." }, "details": { "type": "array", @@ -1111,11 +1135,12 @@ ] }, "session_properties": { + "description": "The properties of a rendering session.", "properties": { "id": { "example": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", "type": "string", - "description": "The id of the session supplied when the sessions was created." + "description": "The ID of the session supplied when the sessions was created." }, "arrInspectorPort": { "example": 50052, @@ -1134,7 +1159,7 @@ "readOnly": true }, "elapsedTimeMinutes": { - "description": "Amount of time in minutes the session is or has been in Ready state. Time is rounded down to a full minute.", + "description": "Amount of time in minutes the session is or has been in the Ready state. Time is rounded down to a full minute.", "example": 10, "type": "integer", "readOnly": true @@ -1163,7 +1188,7 @@ "example": 10.6, "format": "float", "type": "number", - "description": "The computational power of the rendering session GPU measured in Teraflops.", + "description": "The computational power of the rendering session GPU measured in teraflops.", "readOnly": true }, "error": { @@ -1189,6 +1214,7 @@ ] }, "create_session_settings": { + "description": "Settings of the session to be created.", "properties": { "maxLeaseTimeMinutes": { "example": 60, @@ -1209,7 +1235,7 @@ "type": "object", "properties": { "maxLeaseTimeMinutes": { - "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be bigger than the current value of maxLeaseTimeMinutes.", + "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be bigger than the current value of maxLeaseTimeMinutes.", "example": 72, "type": "integer" } @@ -1227,12 +1253,34 @@ "Stopped" ], "x-ms-enum": { - "name": "SessionStatus", - "modelAsString": true + "name": "session_status", + "modelAsString": true, + "values": [ + { + "value": "Error", + "description": "The rendering session has encountered an error, and is unusable. This is a terminal state." + }, + { + "value": "Expired", + "description": "The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state." + }, + { + "value": "Starting", + "description": "The rendering session is starting, and cannot be connected to yet." + }, + { + "value": "Ready", + "description": "The rendering session is ready for incoming connections." + }, + { + "value": "Stopped", + "description": "The rendering session has been stopped with 'StopSession' operation. This is a terminal state." + } + ] }, "type": "string", "example": "Ready", - "description": "The status of the rendering session. Once the status reached the 'Ready' state it can be connected to. The terminal state is 'Stopped'." + "description": "The status of the rendering session. Once the status reached the 'Ready' state it can be connected to." }, "session_size": { "enum": [ @@ -1240,12 +1288,22 @@ "Premium" ], "x-ms-enum": { - "name": "SessionSize", - "modelAsString": true + "name": "session_size", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard size server has a maximum scene size of 20 million polygons." + }, + { + "value": "Premium", + "description": "Premium size server does not enforce a hard maximum, but performance may be degraded if your content exceeds the rendering capabilities of the service." + } + ] }, "example": "Standard", "type": "string", - "description": "Size of the server used for the rendering session. Remote Rendering with Standard size server has a maximum scene size of 20 million polygons. Remote Rendering with Premium size does not enforce a hard maximum, but performance may be degraded if your content exceeds the rendering capabilities of the service." + "description": "Size of the server used for the rendering session. The size of the server impacts the number of polygons the server can render." }, "sessions_list": { "description": "The result of a list sessions request.", @@ -1259,7 +1317,7 @@ } }, "@nextLink": { - "description": "If more rendering sessions are available this link with the same authentication header can be used to retrieve further values", + "description": "If more rendering sessions are available this property will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", "type": "string", "readOnly": true } @@ -1272,7 +1330,7 @@ "parameters": { "Endpoint": { "name": "endpoint", - "description": "The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com a list can be found at https://docs.microsoft.com/en-us/azure/remote-rendering/reference/regions", + "description": "The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/en-us/azure/remote-rendering/reference/regions.", "required": true, "type": "string", "in": "path", @@ -1290,7 +1348,7 @@ }, "account_id": { "name": "account_id", - "description": "the Azure Remote Rendering account id", + "description": "The Azure Remote Rendering account ID.", "format": "uuid", "in": "path", "required": true, @@ -1321,7 +1379,8 @@ "MrcBearerAuth": { "in": "header", "name": "Authorization", - "type": "apiKey" + "type": "apiKey", + "description": "A token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/tokens for details." } }, "security": [ From 6f09e12269e62e88bd732000e653aa3c2f5f9dd9 Mon Sep 17 00:00:00 2001 From: Aleksandar Tomic Date: Tue, 9 Feb 2021 14:02:28 +0000 Subject: [PATCH 2/6] Fixing tags and operation IDs --- .../preview/2021-01-01-preview/mr-arr.json | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index 6e5207e4cbba..714c0cf8e87d 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -20,7 +20,7 @@ "paths": { "/accounts/{account_id}/conversions/{conversion_id}": { "put": { - "operationId": "CreateConversion", + "operationId": "Conversion_CreateConversion", "consumes": [ "application/json" ], @@ -150,12 +150,12 @@ } }, "tags": [ - "conversion" + "Conversion" ], "summary": "Creates a conversion using an asset stored in an Azure Blob Storage account." }, "get": { - "operationId": "GetConversion", + "operationId": "Conversion_GetConversion", "produces": [ "application/json" ], @@ -255,14 +255,14 @@ } }, "tags": [ - "conversion" + "Conversion" ], "summary": "Gets the status of a particular conversion." } }, "/accounts/{account_id}/conversions": { "get": { - "operationId": "ListConversions", + "operationId": "Conversion_ListConversions", "produces": [ "application/json" ], @@ -349,14 +349,14 @@ "nextLinkName": "@nextLink" }, "tags": [ - "conversion" + "Conversion" ], "summary": "Gets a list of all conversions." } }, "/accounts/{account_id}/sessions/{session_id}": { "put": { - "operationId": "CreateSession", + "operationId": "RenderingSession_CreateSession", "consumes": [ "application/json" ], @@ -480,12 +480,12 @@ } }, "tags": [ - "rendering session" + "RenderingSession" ], "summary": "Creates a new rendering session." }, "get": { - "operationId": "GetSession", + "operationId": "RenderingSession_GetSession", "produces": [ "application/json" ], @@ -575,12 +575,12 @@ } }, "tags": [ - "rendering session" + "RenderingSession" ], "summary": "Gets the properties of a particular rendering session." }, "patch": { - "operationId": "UpdateSession", + "operationId": "RenderingSession_UpdateSession", "consumes": [ "application/json" ], @@ -695,14 +695,14 @@ } }, "tags": [ - "rendering session" + "RenderingSession" ], "summary": "Updates a particular rendering session." } }, "/accounts/{account_id}/sessions/{session_id}/:stop": { "post": { - "operationId": "StopSession", + "operationId": "RenderingSession_StopSession", "produces": [ "application/json" ], @@ -795,14 +795,14 @@ } }, "tags": [ - "rendering session" + "RenderingSession" ], "summary": "Stops a particular rendering session." } }, "/accounts/{account_id}/sessions": { "get": { - "operationId": "ListSessions", + "operationId": "RenderingSession_ListSessions", "produces": [ "application/json" ], @@ -883,7 +883,7 @@ } }, "tags": [ - "rendering session" + "RenderingSession" ], "summary": "Gets a list of all rendering sessions." } From e571c240ed0846525ecaacf7b0536201c9a4304b Mon Sep 17 00:00:00 2001 From: Aleksandar Tomic Date: Tue, 9 Feb 2021 14:26:01 +0000 Subject: [PATCH 3/6] Tags update v2 --- .../preview/2021-01-01-preview/mr-arr.json | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index 714c0cf8e87d..e8fef3a4eee0 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -20,7 +20,7 @@ "paths": { "/accounts/{account_id}/conversions/{conversion_id}": { "put": { - "operationId": "Conversion_CreateConversion", + "operationId": "RemoteRendering_CreateConversion", "consumes": [ "application/json" ], @@ -150,12 +150,12 @@ } }, "tags": [ - "Conversion" + "conversion" ], "summary": "Creates a conversion using an asset stored in an Azure Blob Storage account." }, "get": { - "operationId": "Conversion_GetConversion", + "operationId": "RemoteRendering_GetConversion", "produces": [ "application/json" ], @@ -255,14 +255,14 @@ } }, "tags": [ - "Conversion" + "conversion" ], "summary": "Gets the status of a particular conversion." } }, "/accounts/{account_id}/conversions": { "get": { - "operationId": "Conversion_ListConversions", + "operationId": "RemoteRendering_ListConversions", "produces": [ "application/json" ], @@ -349,14 +349,14 @@ "nextLinkName": "@nextLink" }, "tags": [ - "Conversion" + "conversion" ], "summary": "Gets a list of all conversions." } }, "/accounts/{account_id}/sessions/{session_id}": { "put": { - "operationId": "RenderingSession_CreateSession", + "operationId": "RemoteRendering_CreateSession", "consumes": [ "application/json" ], @@ -480,12 +480,12 @@ } }, "tags": [ - "RenderingSession" + "rendering session" ], "summary": "Creates a new rendering session." }, "get": { - "operationId": "RenderingSession_GetSession", + "operationId": "RemoteRendering_GetSession", "produces": [ "application/json" ], @@ -575,12 +575,12 @@ } }, "tags": [ - "RenderingSession" + "rendering session" ], "summary": "Gets the properties of a particular rendering session." }, "patch": { - "operationId": "RenderingSession_UpdateSession", + "operationId": "RemoteRendering_UpdateSession", "consumes": [ "application/json" ], @@ -695,14 +695,14 @@ } }, "tags": [ - "RenderingSession" + "rendering session" ], "summary": "Updates a particular rendering session." } }, "/accounts/{account_id}/sessions/{session_id}/:stop": { "post": { - "operationId": "RenderingSession_StopSession", + "operationId": "RemoteRendering_StopSession", "produces": [ "application/json" ], @@ -795,14 +795,14 @@ } }, "tags": [ - "RenderingSession" + "rendering session" ], "summary": "Stops a particular rendering session." } }, "/accounts/{account_id}/sessions": { "get": { - "operationId": "RenderingSession_ListSessions", + "operationId": "RemoteRendering_ListSessions", "produces": [ "application/json" ], @@ -883,7 +883,7 @@ } }, "tags": [ - "RenderingSession" + "rendering session" ], "summary": "Gets a list of all rendering sessions." } From 698384a29ac2b484c4a3aa2d0bdd29349ba52b13 Mon Sep 17 00:00:00 2001 From: Aleksandar Tomic Date: Tue, 9 Feb 2021 20:48:39 +0000 Subject: [PATCH 4/6] Further documentation improvements --- .../preview/2021-01-01-preview/mr-arr.json | 58 ++++++++++--------- 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index e8fef3a4eee0..b6430d36c942 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -78,7 +78,7 @@ } }, "400": { - "description": "Bad Request. An error object describes which issues occurred.", + "description": "Bad Request. Returned error object describes which issues occurred.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -142,7 +142,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "schema": { "$ref": "#/definitions/error_response" @@ -241,7 +241,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -331,7 +331,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -408,7 +408,7 @@ } }, "400": { - "description": "BadRequest.", + "description": "Bad Request. Returned error object describes which issues occurred.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -466,7 +466,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -561,7 +561,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -598,7 +598,7 @@ "$ref": "#/parameters/session_id" }, { - "description": "Settings of the session to be updated", + "description": "Settings used to update the session.", "in": "body", "name": "body", "required": true, @@ -681,7 +681,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -697,7 +697,7 @@ "tags": [ "rendering session" ], - "summary": "Updates a particular rendering session." + "summary": "Updates the max lease time of a particular rendering session." } }, "/accounts/{account_id}/sessions/{session_id}/:stop": { @@ -781,7 +781,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -869,7 +869,7 @@ } }, "500": { - "description": "InternalError. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -891,6 +891,7 @@ }, "definitions": { "conversion": { + "description": "The properties of the conversion.", "properties": { "id": { "type": "string", @@ -949,7 +950,7 @@ "description": "The list of conversions." }, "@nextLink": { - "description": "If more conversions are available this property will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", + "description": "If more conversions are available this field will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", "type": "string", "readOnly": true } @@ -969,7 +970,7 @@ }, "storageContainerReadListSas": { "type": "string", - "description": "An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. For security purposes this field will never be filled out in responses bodies." + "description": "An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." }, "blobPrefix": { "type": "string", @@ -987,7 +988,7 @@ "relativeInputAssetPath" ], "type": "object", - "description": "Settings for the conversion input." + "description": "Conversion input settings describe the origin of conversion input." }, "conversion_output_settings": { "properties": { @@ -999,7 +1000,7 @@ }, "storageContainerWriteSas": { "type": "string", - "description": "An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. For security purposes this field will never be filled out in responses bodies." + "description": "An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." }, "blobPrefix": { "type": "string", @@ -1016,7 +1017,7 @@ "storageContainerUri" ], "type": "object", - "description": "Settings for the conversion output." + "description": "Conversion output settings describe the destination of conversion output." }, "create_conversion_settings": { "description": "Request to start a conversion", @@ -1031,7 +1032,7 @@ "type": "object" }, "conversion_settings": { - "description": "Settings for where to retrieve input files from and where to write output files. Supplied when creating the conversion.", + "description": "Conversion settings describe the origin of input files and destination of output files.", "properties": { "inputLocation": { "$ref": "#/definitions/conversion_input_settings" @@ -1155,7 +1156,7 @@ "maximum": 65534, "minimum": 49152, "type": "integer", - "description": "The TCP port used for the handshake.", + "description": "The TCP port used for the handshake when establishing a connection.", "readOnly": true }, "elapsedTimeMinutes": { @@ -1219,7 +1220,7 @@ "maxLeaseTimeMinutes": { "example": 60, "type": "integer", - "description": "The time in minutes the session will run after reaching the 'Ready' state." + "description": "The time in minutes the session will run after reaching the 'Ready' state. It has to be between 0 and 1440." }, "size": { "$ref": "#/definitions/session_size" @@ -1232,10 +1233,11 @@ ] }, "update_session_settings": { + "description": "Settings used to update the session.", "type": "object", "properties": { "maxLeaseTimeMinutes": { - "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be bigger than the current value of maxLeaseTimeMinutes.", + "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be bigger than the current value of maxLeaseTimeMinutes and less than 1440.", "example": 72, "type": "integer" } @@ -1266,7 +1268,7 @@ }, { "value": "Starting", - "description": "The rendering session is starting, and cannot be connected to yet." + "description": "The rendering session is starting, but not accepting incoming connections yet." }, { "value": "Ready", @@ -1274,13 +1276,13 @@ }, { "value": "Stopped", - "description": "The rendering session has been stopped with 'StopSession' operation. This is a terminal state." + "description": "The rendering session has been stopped with 'Stop Session' operation. This is a terminal state." } ] }, "type": "string", "example": "Ready", - "description": "The status of the rendering session. Once the status reached the 'Ready' state it can be connected to." + "description": "The status of the rendering session." }, "session_size": { "enum": [ @@ -1293,11 +1295,11 @@ "values": [ { "value": "Standard", - "description": "Standard size server has a maximum scene size of 20 million polygons." + "description": "Standard size has a maximum scene size of 20 million polygons." }, { "value": "Premium", - "description": "Premium size server does not enforce a hard maximum, but performance may be degraded if your content exceeds the rendering capabilities of the service." + "description": "Premium size does not enforce a hard maximum polygon count, but performance may be degraded if your content exceeds the rendering capabilities of the service." } ] }, @@ -1317,7 +1319,7 @@ } }, "@nextLink": { - "description": "If more rendering sessions are available this property will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", + "description": "If more rendering sessions are available this field will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", "type": "string", "readOnly": true } @@ -1380,7 +1382,7 @@ "in": "header", "name": "Authorization", "type": "apiKey", - "description": "A token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/tokens for details." + "description": "A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/tokens for details." } }, "security": [ From 4fd3a76f2f24701bc19dcf59fee798e1f2a7a94a Mon Sep 17 00:00:00 2001 From: Aleksandar Tomic Date: Wed, 10 Feb 2021 13:11:20 +0000 Subject: [PATCH 5/6] Addressing PR comments --- .../preview/2021-01-01-preview/mr-arr.json | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index b6430d36c942..13c49310be61 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -142,7 +142,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "schema": { "$ref": "#/definitions/error_response" @@ -241,7 +241,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -331,7 +331,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -466,7 +466,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -561,7 +561,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -681,7 +681,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -781,7 +781,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -869,7 +869,7 @@ } }, "500": { - "description": "Internal Error. Server has encountered internal error. Retrying the request may produce successful results.", + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", "x-ms-error-response": true, "headers": { "MS-CV": { @@ -906,7 +906,7 @@ "properties": { "outputAssetUri": { "type": "string", - "description": "URL of the asset generated by the conversion process.", + "description": "URI of the asset generated by the conversion process.", "format": "uri", "example": "https://contoso.blob.core.windows.net/arr/architecture-output/house.arrAsset", "readOnly": true @@ -970,7 +970,7 @@ }, "storageContainerReadListSas": { "type": "string", - "description": "An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." + "description": "An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." }, "blobPrefix": { "type": "string", @@ -979,7 +979,7 @@ }, "relativeInputAssetPath": { "type": "string", - "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to file with a supported file format ending. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/conversion/model-conversion for details.", + "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details.", "example": "house.fbx" } }, @@ -1000,11 +1000,11 @@ }, "storageContainerWriteSas": { "type": "string", - "description": "An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not is not provided the Azure Remote Rendering rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." + "description": "An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." }, "blobPrefix": { "type": "string", - "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treaded as a virtual folder. Optional. If not provided, output files will be stored at container root.", + "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at container root.", "example": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e" }, "outputAssetFilename": { @@ -1237,7 +1237,7 @@ "type": "object", "properties": { "maxLeaseTimeMinutes": { - "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be bigger than the current value of maxLeaseTimeMinutes and less than 1440.", + "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be larger than the current value of maxLeaseTimeMinutes and less than 1440.", "example": 72, "type": "integer" } @@ -1295,17 +1295,17 @@ "values": [ { "value": "Standard", - "description": "Standard size has a maximum scene size of 20 million polygons." + "description": "Standard rendering session size." }, { "value": "Premium", - "description": "Premium size does not enforce a hard maximum polygon count, but performance may be degraded if your content exceeds the rendering capabilities of the service." + "description": "Premium rendering session size." } ] }, "example": "Standard", "type": "string", - "description": "Size of the server used for the rendering session. The size of the server impacts the number of polygons the server can render." + "description": "Size of the server used for the rendering session. The size of the server impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details." }, "sessions_list": { "description": "The result of a list sessions request.", @@ -1332,7 +1332,7 @@ "parameters": { "Endpoint": { "name": "endpoint", - "description": "The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/en-us/azure/remote-rendering/reference/regions.", + "description": "The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions.", "required": true, "type": "string", "in": "path", @@ -1382,7 +1382,7 @@ "in": "header", "name": "Authorization", "type": "apiKey", - "description": "A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/en-us/azure/remote-rendering/how-tos/tokens for details." + "description": "A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens for details." } }, "security": [ From ac493553d57aee5487edcf709d1625c2d072e725 Mon Sep 17 00:00:00 2001 From: Aleksandar Tomic Date: Wed, 10 Feb 2021 13:41:01 +0000 Subject: [PATCH 6/6] Further description improvements --- .../preview/2021-01-01-preview/mr-arr.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json index 13c49310be61..68c16774cb36 100644 --- a/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/mr-arr.json @@ -979,7 +979,7 @@ }, "relativeInputAssetPath": { "type": "string", - "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details.", + "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details.", "example": "house.fbx" } }, @@ -1004,7 +1004,7 @@ }, "blobPrefix": { "type": "string", - "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at container root.", + "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root.", "example": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e" }, "outputAssetFilename": { @@ -1048,7 +1048,7 @@ "type": "object" }, "conversion_status": { - "description": "The status of the conversion. Terminal states are 'Cancelled', 'Failed', 'Succeeded'.", + "description": "The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'.", "enum": [ "NotStarted", "Running", @@ -1141,7 +1141,7 @@ "id": { "example": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", "type": "string", - "description": "The ID of the session supplied when the sessions was created." + "description": "The ID of the session supplied when the session was created." }, "arrInspectorPort": { "example": 50052, @@ -1160,7 +1160,7 @@ "readOnly": true }, "elapsedTimeMinutes": { - "description": "Amount of time in minutes the session is or has been in the Ready state. Time is rounded down to a full minute.", + "description": "Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute.", "example": 10, "type": "integer", "readOnly": true @@ -1276,13 +1276,13 @@ }, { "value": "Stopped", - "description": "The rendering session has been stopped with 'Stop Session' operation. This is a terminal state." + "description": "The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state." } ] }, "type": "string", "example": "Ready", - "description": "The status of the rendering session." + "description": "The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'." }, "session_size": { "enum": [ @@ -1305,7 +1305,7 @@ }, "example": "Standard", "type": "string", - "description": "Size of the server used for the rendering session. The size of the server impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details." + "description": "The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details." }, "sessions_list": { "description": "The result of a list sessions request.",