Skip to content

Commit 4ed2eef

Browse files
bexxxbexxx
authored
Update swagger for Custom Speech v2.0 and v3.0 (GA) (#18151)
* Update swagger/documentation * rename version directories * Add descriptions to enums * clean up typo and unnecessary error response descriptions. * add parameter locations * update quoting * share security * improve operation ids * fix swagger by adding missing schema element * fix security * share schema * fix operation id of health status * REvert operation id changes to be less breaking for existing versions * even less breaking changes
1 parent c14d693 commit 4ed2eef

File tree

106 files changed

+2381
-11015
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+2381
-11015
lines changed

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,10 @@
2020
"Content-Type": "application/json"
2121
},
2222
"responses": {
23-
"401": {
24-
"headers": {},
25-
"body": {
26-
"code": "Unauthorized",
27-
"message": "Authentication is required to access the resource."
28-
}
29-
},
30-
"403": {
31-
"headers": {},
32-
"body": {
33-
"code": "Forbidden",
34-
"message": "No permission to access this resource."
35-
}
36-
},
37-
"429": {
38-
"headers": {},
39-
"body": {
40-
"code": "TooManyRequests",
41-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
23+
"202": {
24+
"headers": {
25+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/accuracytests/0000e4c4-0b0e-437f-b41d-bcfe7ebf7060",
26+
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/accuracytests/0000e4c4-0b0e-437f-b41d-bcfe7ebf7060"
4227
}
4328
}
4429
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json‎

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,34 +18,9 @@
1818
},
1919
"responses": {
2020
"202": {
21-
"headers": {}
22-
},
23-
"400": {
24-
"headers": {},
25-
"body": {
26-
"code": "BadRequest",
27-
"message": "The request has been incorrect."
28-
}
29-
},
30-
"401": {
31-
"headers": {},
32-
"body": {
33-
"code": "Unauthorized",
34-
"message": "Authentication is required to access the resource."
35-
}
36-
},
37-
"403": {
38-
"headers": {},
39-
"body": {
40-
"code": "Forbidden",
41-
"message": "No permission to access this resource."
42-
}
43-
},
44-
"429": {
45-
"headers": {},
46-
"body": {
47-
"code": "TooManyRequests",
48-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
21+
"headers": {
22+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/8fa0669c-a01e-4693-ae3a-93baf40f26d9",
23+
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/8fa0669c-a01e-4693-ae3a-93baf40f26d9"
4924
}
5025
}
5126
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json‎

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,9 @@
1111
},
1212
"responses": {
1313
"202": {
14-
"headers": {}
15-
},
16-
"400": {
17-
"headers": {},
18-
"body": {
19-
"code": "BadRequest",
20-
"message": "The request has been incorrect."
21-
}
22-
},
23-
"401": {
24-
"headers": {},
25-
"body": {
26-
"code": "Unauthorized",
27-
"message": "Authentication is required to access the resource."
28-
}
29-
},
30-
"403": {
31-
"headers": {},
32-
"body": {
33-
"code": "Forbidden",
34-
"message": "No permission to access this resource."
35-
}
36-
},
37-
"404": {
38-
"headers": {},
39-
"body": {
40-
"code": "NotFound",
41-
"message": "The specified entity cannot be found."
42-
}
43-
},
44-
"429": {
45-
"headers": {},
46-
"body": {
47-
"code": "TooManyRequests",
48-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
14+
"headers": {
15+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/{endpointId}9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a",
16+
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/{endpointId}9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a"
4917
}
5018
}
5119
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json‎

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,9 @@
2020
},
2121
"responses": {
2222
"202": {
23-
"headers": {}
24-
},
25-
"400": {
26-
"headers": {},
27-
"body": {
28-
"code": "BadRequest",
29-
"message": "The request has been incorrect."
30-
}
31-
},
32-
"401": {
33-
"headers": {},
34-
"body": {
35-
"code": "Unauthorized",
36-
"message": "Authentication is required to access the resource."
37-
}
38-
},
39-
"403": {
40-
"headers": {},
41-
"body": {
42-
"code": "Forbidden",
43-
"message": "No permission to access this resource."
44-
}
45-
},
46-
"429": {
47-
"headers": {},
48-
"body": {
49-
"code": "TooManyRequests",
50-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
23+
"headers": {
24+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/models/827712a5-f942-4997-91c3-7c6cde35600b",
25+
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/models/827712a5-f942-4997-91c3-7c6cde35600b"
5126
}
5227
}
5328
}

specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_transcription.json renamed to specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_uri_transcription.json

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,9 @@
2020
},
2121
"responses": {
2222
"202": {
23-
"headers": {}
24-
},
25-
"400": {
26-
"headers": {},
27-
"body": {
28-
"code": "BadRequest",
29-
"message": "The request has been incorrect."
30-
}
31-
},
32-
"401": {
33-
"headers": {},
34-
"body": {
35-
"code": "Unauthorized",
36-
"message": "Authentication is required to access the resource."
37-
}
38-
},
39-
"403": {
40-
"headers": {},
41-
"body": {
42-
"code": "Forbidden",
43-
"message": "No permission to access this resource."
44-
}
45-
},
46-
"429": {
47-
"headers": {},
48-
"body": {
49-
"code": "TooManyRequests",
50-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
23+
"headers": {
24+
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
25+
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
5126
}
5227
}
5328
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,6 @@
77
"responses": {
88
"204": {
99
"headers": {}
10-
},
11-
"401": {
12-
"headers": {},
13-
"body": {
14-
"code": "Unauthorized",
15-
"message": "Authentication is required to access the resource."
16-
}
17-
},
18-
"403": {
19-
"headers": {},
20-
"body": {
21-
"code": "Forbidden",
22-
"message": "No permission to access this resource."
23-
}
24-
},
25-
"429": {
26-
"headers": {},
27-
"body": {
28-
"code": "TooManyRequests",
29-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
30-
}
3110
}
3211
}
3312
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json‎

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,6 @@
77
"responses": {
88
"204": {
99
"headers": {}
10-
},
11-
"400": {
12-
"headers": {},
13-
"body": {
14-
"code": "BadRequest",
15-
"message": "The request has been incorrect."
16-
}
17-
},
18-
"401": {
19-
"headers": {},
20-
"body": {
21-
"code": "Unauthorized",
22-
"message": "Authentication is required to access the resource."
23-
}
24-
},
25-
"403": {
26-
"headers": {},
27-
"body": {
28-
"code": "Forbidden",
29-
"message": "No permission to access this resource."
30-
}
31-
},
32-
"429": {
33-
"headers": {},
34-
"body": {
35-
"code": "TooManyRequests",
36-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
37-
}
3810
}
3911
}
4012
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,6 @@
77
"responses": {
88
"204": {
99
"headers": {}
10-
},
11-
"401": {
12-
"headers": {},
13-
"body": {
14-
"code": "Unauthorized",
15-
"message": "Authentication is required to access the resource."
16-
}
17-
},
18-
"403": {
19-
"headers": {},
20-
"body": {
21-
"code": "Forbidden",
22-
"message": "No permission to access this resource."
23-
}
24-
},
25-
"429": {
26-
"headers": {},
27-
"body": {
28-
"code": "TooManyRequests",
29-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
30-
}
3110
}
3211
}
3312
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json‎

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,6 @@
77
"responses": {
88
"204": {
99
"headers": {}
10-
},
11-
"401": {
12-
"headers": {},
13-
"body": {
14-
"code": "Unauthorized",
15-
"message": "Authentication is required to access the resource."
16-
}
17-
},
18-
"403": {
19-
"headers": {},
20-
"body": {
21-
"code": "Forbidden",
22-
"message": "No permission to access this resource."
23-
}
24-
},
25-
"429": {
26-
"headers": {},
27-
"body": {
28-
"code": "TooManyRequests",
29-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
30-
}
3110
}
3211
}
3312
}

‎specification/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json‎

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,34 +8,6 @@
88
"responses": {
99
"204": {
1010
"headers": {}
11-
},
12-
"400": {
13-
"headers": {},
14-
"body": {
15-
"code": "BadRequest",
16-
"message": "The request has been incorrect."
17-
}
18-
},
19-
"401": {
20-
"headers": {},
21-
"body": {
22-
"code": "Unauthorized",
23-
"message": "Authentication is required to access the resource."
24-
}
25-
},
26-
"403": {
27-
"headers": {},
28-
"body": {
29-
"code": "Forbidden",
30-
"message": "No permission to access this resource."
31-
}
32-
},
33-
"429": {
34-
"headers": {},
35-
"body": {
36-
"code": "TooManyRequests",
37-
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
38-
}
3911
}
4012
}
4113
}

0 commit comments

Comments
 (0)