Skip to content

Commit

Permalink
Azure Remote Rendering REST API swagger file - for review (#12015)
Browse files Browse the repository at this point in the history
* Azure Remote Rendering API specifcation

* fix schema issue

* fix examples

* fix request bodies integer values, :stop path

* pointing readme.md to open api spec for ARR

* fix typo, add custom words

* add msvc to custom words

* fix readme.md

* ran prettifier

* fix reference to json

* reference sts from file as well

* fix readme.md

* changes to readme.md

* remove example from error to fix error

* add 200 OK status for retried PUT for conversions and sessiosn

* ran prettier

* make autorest linter not crash

* fix casing of nextLinkName paramter

* factor out conversion list response

* add examples for conversions

* adding examples for sessions, prettify files
  • Loading branch information
rikogeln authored Jan 4, 2021
1 parent 4f48037 commit b9433e4
Show file tree
Hide file tree
Showing 11 changed files with 2,150 additions and 5 deletions.
3 changes: 3 additions & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1063,6 +1063,7 @@ MSAZR
MSAZRDE
MSAZRUSGO
MSCONCAT
mscv
MSGETACLSTATUS
MSGETFILESTATUS
msix
Expand Down Expand Up @@ -1417,6 +1418,8 @@ remediate
remediated
Remediations
remoteloginsettings
remoterendering
remoterenderingvm
remoteuser
REMOVEACL
REMOVEACLENTRIES
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
{
"parameters": {
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
"conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"body": {
"settings": {
"inputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
"blobPrefix": "models/",
"relativeInputAssetPath": "house.fbx"
},
"outputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"outputAssetFilename": "convertedHouse.arrAsset"
}
}
}
},
"responses": {
"201": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"creationTime": "2021-01-01T11:11:11.111Z",
"settings": {
"inputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
"blobPrefix": "models/",
"relativeInputAssetPath": "house.fbx"
},
"outputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"outputAssetFilename": "convertedHouse.arrAsset"
}
},
"status": "NotStarted",
"error": null
}
},
"200": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"creationTime": "2021-01-01T11:11:11.111Z",
"settings": {
"inputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
"blobPrefix": "models/",
"relativeInputAssetPath": "house.fbx"
},
"outputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"outputAssetFilename": "convertedHouse.arrAsset"
}
},
"status": "NotStarted",
"error": null
}
},
"400": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "BadRequest",
"message": "The request was malformed."
}
}
},
"409": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "Conflict",
"message": "A resource already exists under the given ID."
}
}
},
"401": {
"headers": {
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"403": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"429": {
"headers": {
"Retry-After": 15,
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"500": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "InternalServerError",
"message": "An internal server error occurred."
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
{
"parameters": {
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
"session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"body": {
"maxLeaseTimeMinutes": 60,
"size": "Standard"
}
},
"responses": {
"201": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"creationTime": "2020-11-11T11:11:11.111Z",
"maxLeaseTimeMinutes": 60,
"size": "Standard",
"status": "Starting",
"error": null
}
},
"200": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"creationTime": "2020-11-11T11:11:11.111Z",
"maxLeaseTimeMinutes": 60,
"size": "Standard",
"status": "Starting",
"error": null
}
},
"400": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "BadRequest",
"message": "The request was malformed."
}
}
},
"409": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "Conflict",
"message": "A resource already exists under the given ID."
}
}
},
"401": {
"headers": {
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"403": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"429": {
"headers": {
"Retry-After": 15,
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"500": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "InternalServerError",
"message": "An internal server error occurred."
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
{
"parameters": {
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
"conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e"
},
"responses": {
"200": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"creationTime": "2021-01-01T11:11:11.111Z",
"settings": {
"inputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
"blobPrefix": "models/",
"relativeInputAssetPath": "house.fbx"
},
"outputLocation": {
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
"outputAssetFilename": "convertedHouse.arrAsset"
}
},
"status": "Succeeded",
"error": null,
"output": {
"outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset"
}
}
},
"401": {
"headers": {
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"403": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"404": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"429": {
"headers": {
"Retry-After": 15,
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"500": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "InternalServerError",
"message": "An internal server error occurred."
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"parameters": {
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
"session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28"
},
"responses": {
"200": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
"creationTime": "2020-11-11T11:11:11.111Z",
"arrInspectorPort": 50052,
"handshakePort": 50051,
"elapsedTimeMinutes": 10,
"hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
"maxLeaseTimeMinutes": 60,
"size": "Standard",
"status": "Ready",
"error": null,
"teraflops": 10.6
}
},
"401": {
"headers": {
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"403": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"404": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"429": {
"headers": {
"Retry-After": 15,
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
}
},
"500": {
"headers": {
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
},
"body": {
"error": {
"code": "InternalServerError",
"message": "An internal server error occurred."
}
}
}
}
}
Loading

0 comments on commit b9433e4

Please sign in to comment.