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.

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

Update description of Custom Voice API swagger. #27438

Merged
merged 3 commits into from
Jan 19, 2024
Merged
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{

Check failure on line 1 in specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json

View check run for this annotation

Azure Pipelines / TypeSpec Requirement

specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json#L1

specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json(1,1): error : OpenAPI was not generated from TypeSpec, and spec appears to be new
"swagger": "2.0",
"info": {
"title": "Custom voice API",
Expand Down Expand Up @@ -101,7 +101,7 @@
"tags": [
"Project"
],
"description": "Deletes the project identified by the given ID.",
"description": "Deletes the project identified by the given ID. All data (like consent, training set) in this project will be deleted automatically.",
"operationId": "Projects_Delete",
"produces": [
"application/json"
Expand All @@ -114,7 +114,7 @@
"in": "query",
"name": "forceDelete",
"type": "boolean",
"description": "Set this to true if you want to delete a project with model and endpoint",
"description": "Set this to true if you want to delete a project with model and endpoint. Otherwise, the delete operation will fail.",
"default": false
},
{
Expand Down Expand Up @@ -1405,7 +1405,7 @@
"tags": [
"PersonalVoice"
],
"description": "Creates a new personal voice.",
"description": "Creates a new personal voice with audio files in Azure Blob Storage.",
"operationId": "PersonalVoices_Create",
"consumes": [
"application/json"
Expand Down Expand Up @@ -1469,7 +1469,7 @@
"tags": [
"PersonalVoice"
],
"description": "Creates a new personal voice.",
"description": "Creates a new personal voice with audio files in the client.",
"operationId": "PersonalVoices_Post",
"consumes": [
"multipart/form-data"
Expand Down Expand Up @@ -1607,27 +1607,30 @@
},
"definitions": {
"AzureBlobContentSource": {
"description": "Azure Blob Storage content.",
"description": "Azure Blob Storage content. With the examples below, it represents files https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav",
"type": "object",
"required": [
"containerUrl",
"extensions"
],
"properties": {
"containerUrl": {
"description": "Azure Blob Storage container URL.",
"description": "Azure Blob Storage container URL with [SAS](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview). Need both read and list permissions.",
ForrestGumb marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"format": "url"
"format": "url",
"example": "https://contoso.blob.core.windows.net/voicecontainer?mySasToken"
},
"prefix": {
"description": "Blob name prefix.",
"type": "string"
"type": "string",
"example": "jessica"
},
"extensions": {
"description": "File name extensions.",
"type": "array",
"items": {
"type": "string"
"type": "string",
"example": ".wav"
}
}
}
Expand Down Expand Up @@ -1699,7 +1702,7 @@
"type": "string"
},
"audioUrl": {
"description": "The public accessible URL of the consent audio file.",
"description": "The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with [SAS](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview). This property is only available in request.",
ForrestGumb marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"format": "uri"
},
Expand Down Expand Up @@ -2562,7 +2565,7 @@
"QueryFilter": {
"name": "filter",
"in": "query",
"description": "Filter condition.\r\n <ul><li><b>Supported properties:</b>projectId, createdDateTime, locale, kind\r\n </li><li><b>Operators:</b>\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for created.\r\n </li><li><b>Example:</b>\r\n - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)</li></ul>",
"description": "Filter condition.\r\n - **Supported properties:** projectId, createdDateTime, locale, kind\r\n - **Operators:**\r\n - eq, ne are supported for all properties.\r\n - gt, ge, lt, le are supported for createdDateTime.\r\n - **Example:**\r\n - ```filter=projectId eq 'Jessica'``` (filter by project ID)\r\n - ```filter=kind eq 'ProfessionalVoice'``` (filter project by kind)\r\n - ```filter=locale eq 'en-US'``` (filter training set and model by locale)\r\n - ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource created time after 2023-11-01)</li></ul>",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
Expand Down
Loading