Skip to content

Commit b9433e4

Browse files
rikogelnrikogeln
authored
Azure Remote Rendering REST API swagger file - for review (#12015)
* 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
1 parent 4f48037 commit b9433e4

File tree

11 files changed

+2150
-5
lines changed

11 files changed

+2150
-5
lines changed

‎custom-words.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,6 +1063,7 @@ MSAZR
10631063
MSAZRDE
10641064
MSAZRUSGO
10651065
MSCONCAT
1066+
mscv
10661067
MSGETACLSTATUS
10671068
MSGETFILESTATUS
10681069
msix
@@ -1417,6 +1418,8 @@ remediate
14171418
remediated
14181419
Remediations
14191420
remoteloginsettings
1421+
remoterendering
1422+
remoterenderingvm
14201423
remoteuser
14211424
REMOVEACL
14221425
REMOVEACLENTRIES

‎specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateConversion.json‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
{
2+
"parameters": {
3+
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
4+
"conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
5+
"body": {
6+
"settings": {
7+
"inputLocation": {
8+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
9+
"blobPrefix": "models/",
10+
"relativeInputAssetPath": "house.fbx"
11+
},
12+
"outputLocation": {
13+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
14+
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
15+
"outputAssetFilename": "convertedHouse.arrAsset"
16+
}
17+
}
18+
}
19+
},
20+
"responses": {
21+
"201": {
22+
"headers": {
23+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
24+
},
25+
"body": {
26+
"id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
27+
"creationTime": "2021-01-01T11:11:11.111Z",
28+
"settings": {
29+
"inputLocation": {
30+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
31+
"blobPrefix": "models/",
32+
"relativeInputAssetPath": "house.fbx"
33+
},
34+
"outputLocation": {
35+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
36+
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
37+
"outputAssetFilename": "convertedHouse.arrAsset"
38+
}
39+
},
40+
"status": "NotStarted",
41+
"error": null
42+
}
43+
},
44+
"200": {
45+
"headers": {
46+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
47+
},
48+
"body": {
49+
"id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
50+
"creationTime": "2021-01-01T11:11:11.111Z",
51+
"settings": {
52+
"inputLocation": {
53+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
54+
"blobPrefix": "models/",
55+
"relativeInputAssetPath": "house.fbx"
56+
},
57+
"outputLocation": {
58+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
59+
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
60+
"outputAssetFilename": "convertedHouse.arrAsset"
61+
}
62+
},
63+
"status": "NotStarted",
64+
"error": null
65+
}
66+
},
67+
"400": {
68+
"headers": {
69+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
70+
},
71+
"body": {
72+
"error": {
73+
"code": "BadRequest",
74+
"message": "The request was malformed."
75+
}
76+
}
77+
},
78+
"409": {
79+
"headers": {
80+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
81+
},
82+
"body": {
83+
"error": {
84+
"code": "Conflict",
85+
"message": "A resource already exists under the given ID."
86+
}
87+
}
88+
},
89+
"401": {
90+
"headers": {
91+
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
92+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
93+
}
94+
},
95+
"403": {
96+
"headers": {
97+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
98+
}
99+
},
100+
"429": {
101+
"headers": {
102+
"Retry-After": 15,
103+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
104+
}
105+
},
106+
"500": {
107+
"headers": {
108+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
109+
},
110+
"body": {
111+
"error": {
112+
"code": "InternalServerError",
113+
"message": "An internal server error occurred."
114+
}
115+
}
116+
}
117+
}
118+
}

‎specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/CreateSession.json‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
{
2+
"parameters": {
3+
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
4+
"session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
5+
"body": {
6+
"maxLeaseTimeMinutes": 60,
7+
"size": "Standard"
8+
}
9+
},
10+
"responses": {
11+
"201": {
12+
"headers": {
13+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
14+
},
15+
"body": {
16+
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
17+
"creationTime": "2020-11-11T11:11:11.111Z",
18+
"maxLeaseTimeMinutes": 60,
19+
"size": "Standard",
20+
"status": "Starting",
21+
"error": null
22+
}
23+
},
24+
"200": {
25+
"headers": {
26+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
27+
},
28+
"body": {
29+
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
30+
"creationTime": "2020-11-11T11:11:11.111Z",
31+
"maxLeaseTimeMinutes": 60,
32+
"size": "Standard",
33+
"status": "Starting",
34+
"error": null
35+
}
36+
},
37+
"400": {
38+
"headers": {
39+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
40+
},
41+
"body": {
42+
"error": {
43+
"code": "BadRequest",
44+
"message": "The request was malformed."
45+
}
46+
}
47+
},
48+
"409": {
49+
"headers": {
50+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
51+
},
52+
"body": {
53+
"error": {
54+
"code": "Conflict",
55+
"message": "A resource already exists under the given ID."
56+
}
57+
}
58+
},
59+
"401": {
60+
"headers": {
61+
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
62+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
63+
}
64+
},
65+
"403": {
66+
"headers": {
67+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
68+
}
69+
},
70+
"429": {
71+
"headers": {
72+
"Retry-After": 15,
73+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
74+
}
75+
},
76+
"500": {
77+
"headers": {
78+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
79+
},
80+
"body": {
81+
"error": {
82+
"code": "InternalServerError",
83+
"message": "An internal server error occurred."
84+
}
85+
}
86+
}
87+
}
88+
}

‎specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetConversion.json‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"parameters": {
3+
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
4+
"conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e"
5+
},
6+
"responses": {
7+
"200": {
8+
"headers": {
9+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
10+
},
11+
"body": {
12+
"id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
13+
"creationTime": "2021-01-01T11:11:11.111Z",
14+
"settings": {
15+
"inputLocation": {
16+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput",
17+
"blobPrefix": "models/",
18+
"relativeInputAssetPath": "house.fbx"
19+
},
20+
"outputLocation": {
21+
"storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput",
22+
"blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
23+
"outputAssetFilename": "convertedHouse.arrAsset"
24+
}
25+
},
26+
"status": "Succeeded",
27+
"error": null,
28+
"output": {
29+
"outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset"
30+
}
31+
}
32+
},
33+
"401": {
34+
"headers": {
35+
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
36+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
37+
}
38+
},
39+
"403": {
40+
"headers": {
41+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
42+
}
43+
},
44+
"404": {
45+
"headers": {
46+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
47+
}
48+
},
49+
"429": {
50+
"headers": {
51+
"Retry-After": 15,
52+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
53+
}
54+
},
55+
"500": {
56+
"headers": {
57+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
58+
},
59+
"body": {
60+
"error": {
61+
"code": "InternalServerError",
62+
"message": "An internal server error occurred."
63+
}
64+
}
65+
}
66+
}
67+
}

‎specification/mixedreality/data-plane/Microsoft.MixedReality/preview/2021-01-01-preview/examples/GetSession.json‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
{
2+
"parameters": {
3+
"account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c",
4+
"session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28"
5+
},
6+
"responses": {
7+
"200": {
8+
"headers": {
9+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
10+
},
11+
"body": {
12+
"id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
13+
"creationTime": "2020-11-11T11:11:11.111Z",
14+
"arrInspectorPort": 50052,
15+
"handshakePort": 50051,
16+
"elapsedTimeMinutes": 10,
17+
"hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
18+
"maxLeaseTimeMinutes": 60,
19+
"size": "Standard",
20+
"status": "Ready",
21+
"error": null,
22+
"teraflops": 10.6
23+
}
24+
},
25+
"401": {
26+
"headers": {
27+
"WWW-Authenticate": "Bearer error=\"invalid_token\"",
28+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
29+
}
30+
},
31+
"403": {
32+
"headers": {
33+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
34+
}
35+
},
36+
"404": {
37+
"headers": {
38+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
39+
}
40+
},
41+
"429": {
42+
"headers": {
43+
"Retry-After": 15,
44+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
45+
}
46+
},
47+
"500": {
48+
"headers": {
49+
"MS-CV": "dKEFmka2kkSlDmp/af+sOw"
50+
},
51+
"body": {
52+
"error": {
53+
"code": "InternalServerError",
54+
"message": "An internal server error occurred."
55+
}
56+
}
57+
}
58+
}
59+
}

0 commit comments

Comments
 (0)