Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure Remote Rendering REST API swagger file - for review #12015

Merged
merged 21 commits into from
Jan 4, 2021
Merged

Azure Remote Rendering REST API swagger file - for review #12015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
d45b14e
Azure Remote Rendering API specifcation
rikogeln Dec 8, 2020
8bc9d00
fix schema issue
rikogeln Dec 9, 2020
8c0a8ce
fix examples
rikogeln Dec 9, 2020
5dc5f93
fix request bodies integer values, :stop path
rikogeln Dec 10, 2020
ec73bc1
pointing readme.md to open api spec for ARR
rikogeln Dec 14, 2020
bec6402
fix typo, add custom words
rikogeln Dec 14, 2020
48fefed
add msvc to custom words
rikogeln Dec 14, 2020
1a6701f
fix readme.md
rikogeln Dec 14, 2020
d3834b5
ran prettifier
rikogeln Dec 14, 2020
10c7012
fix reference to json
rikogeln Dec 14, 2020
aabfa8d
reference sts from file as well
rikogeln Dec 15, 2020
6808e70
fix readme.md
rikogeln Dec 15, 2020
e0361fe
changes to readme.md
rikogeln Dec 15, 2020
15ce5a2
remove example from error to fix error
rikogeln Dec 15, 2020
96a2d28
add 200 OK status for retried PUT for conversions and sessiosn
rikogeln Dec 15, 2020
ab4e450
ran prettier
rikogeln Dec 15, 2020
842e557
make autorest linter not crash
rikogeln Dec 15, 2020
afe3f16
fix casing of nextLinkName paramter
rikogeln Dec 15, 2020
9a05268
factor out conversion list response
rikogeln Dec 16, 2020
583030c
add examples for conversions
rikogeln Dec 16, 2020
7b0d72f
adding examples for sessions, prettify files
rikogeln Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions custom-words.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1058,6 +1058,7 @@ MSAZR
MSAZRDE
MSAZRUSGO
MSCONCAT
mscv
MSGETACLSTATUS
MSGETFILESTATUS
msix
Expand Down Expand Up @@ -1410,6 +1411,8 @@ remediate
remediated
Remediations
remoteloginsettings
remoterendering
remoterenderingvm
remoteuser
REMOVEACL
REMOVEACLENTRIES
Expand Down
118 changes: 118 additions & 0 deletions ...ta-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateConversion.json
View file
Open in desktop
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."
}
}
}
}
}
88 changes: 88 additions & 0 deletions .../data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateSession.json
View file
Open in desktop
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."
}
}
}
}
}
67 changes: 67 additions & 0 deletions .../data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetConversion.json
View file
Open in desktop
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."
}
}
}
}
}
59 changes: 59 additions & 0 deletions ...ity/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetSession.json
View file
Open in desktop
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