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

Jump to bottom

Update swagger for Custom Speech v2.0 and v3.0 (GA) #18151

Merged
merged 14 commits into from
Apr 6, 2022
Merged

Update swagger for Custom Speech v2.0 and v3.0 (GA) #18151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
99cd07c
Update swagger/documentation
bexxx Mar 9, 2022
d417578
rename version directories
bexxx Mar 9, 2022
06df3dd
Add descriptions to enums
bexxx Mar 15, 2022
0e2ebf8
clean up typo and unnecessary error response descriptions.
bexxx Mar 15, 2022
f487e3e
add parameter locations
bexxx Mar 16, 2022
696591b
update quoting
bexxx Mar 16, 2022
2a7d2c1
share security
bexxx Mar 17, 2022
0b69b17
improve operation ids
bexxx Mar 17, 2022
ab2feb2
fix swagger by adding missing schema element
bexxx Mar 18, 2022
e9f0574
fix security
bexxx Mar 18, 2022
a02547d
share schema
bexxx Mar 18, 2022
86b5af2
fix operation id of health status
bexxx Mar 18, 2022
5eded7e
REvert operation id changes to be less breaking for existing versions
bexxx Mar 25, 2022
654ba5c
even less breaking changes
bexxx Mar 25, 2022
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
23 changes: 4 additions & 19 deletions ...iveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_accuracy_test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,10 @@
"Content-Type": "application/json"
},
"responses": {
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
Comment on lines -25 to -28
Copy link
Member

@weidongxu-microsoft weidongxu-microsoft Mar 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I am not mistaken, error response should be

{
  "error": {
    "code":
    "message":
  }
}

https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors

But given it is GA, we cannot change it.

},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
"202": {
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/accuracytests/0000e4c4-0b0e-437f-b41d-bcfe7ebf7060",
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/accuracytests/0000e4c4-0b0e-437f-b41d-bcfe7ebf7060"
}
}
}
Expand Down
31 changes: 3 additions & 28 deletions ...ognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,9 @@
},
"responses": {
"202": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/8fa0669c-a01e-4693-ae3a-93baf40f26d9",
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/8fa0669c-a01e-4693-ae3a-93baf40f26d9"
}
}
}
Expand Down
38 changes: 3 additions & 35 deletions ...ces/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_endpoint_data_exports.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,41 +11,9 @@
},
"responses": {
"202": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"404": {
"headers": {},
"body": {
"code": "NotFound",
"message": "The specified entity cannot be found."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/{endpointId}9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a",
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/endpoints/{endpointId}9cf1e320-41b1-41e6-bdd3-8fb27cb2c90a"
}
}
}
Expand Down
31 changes: 3 additions & 28 deletions ...n/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/create_model.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,9 @@
},
"responses": {
"202": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/models/827712a5-f942-4997-91c3-7c6cde35600b",
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/models/827712a5-f942-4997-91c3-7c6cde35600b"
}
}
}
Expand Down
31 changes: 3 additions & 28 deletions ...e/v2.0/examples/create_transcription.json → ....0/examples/create_uri_transcription.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,9 @@
},
"responses": {
"202": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
"headers": {
"Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
"Operation-Location": "https://westus.api.cognitive.microsoft.com/speechtotext/v2.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
}
}
}
Expand Down
21 changes: 0 additions & 21 deletions ...iveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_accuracy_test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,6 @@
"responses": {
"204": {
"headers": {}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
}
}
}
28 changes: 0 additions & 28 deletions ...cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_dataset.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,6 @@
"responses": {
"204": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
}
}
}
21 changes: 0 additions & 21 deletions ...ognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,6 @@
"responses": {
"204": {
"headers": {}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
}
}
}
21 changes: 0 additions & 21 deletions ...iveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,6 @@
"responses": {
"204": {
"headers": {}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
}
}
}
28 changes: 0 additions & 28 deletions ...ices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_endpoint_data_export.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,6 @@
"responses": {
"204": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
}
}
}
28 changes: 0 additions & 28 deletions ...n/cognitiveservices/data-plane/Speech/SpeechToText/stable/v2.0/examples/delete_model.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,6 @@
"responses": {
"204": {
"headers": {}
},
"400": {
"headers": {},
"body": {
"code": "BadRequest",
"message": "The request has been incorrect."
}
},
"401": {
"headers": {},
"body": {
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
},
"403": {
"headers": {},
"body": {
"code": "Forbidden",
"message": "No permission to access this resource."
}
},
"429": {
"headers": {},
"body": {
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
}
}
}
Loading