Update Custom Voice API to a new version (2024-02-01-preview). #27515
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Compare to previous version (2023-12-01-preview), only one change. Added failureReason property in Consent.
Next Steps to MergeImportant checks have failed. As of today they are not blocking this PR, but in near future they will.Addressing the following failures is highly recommended:
|
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/ccced3e4750f79be55bcc62100ceb6b7756864d0/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2024-02-01-preview/texttospeech.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.90/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp -------------------- 2: ERROR: Schema violation: No enum match for: operation-location -------------------- 3: - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json:1552:10 ($.paths["/personalvoices/id"].post["x-ms-long-running-operation-options"]["final-state-via"]) -------------------- 4: ERROR: Schema violation: No enum match for: operation-location -------------------- 5: - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/Speech/TextToSpeech/preview/2023-12-01-preview/texttospeech.json:1238:10 ($.paths["/endpoints/id:suspend"].post["x-ms-long-running-operation-options"]["final-state-via"]) -------------------- 6: ERROR: Schema violation: No enum match for: operation-location --------------------" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 0 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| release_2024_02_01_preview | release_2024_02_01_preview(ccced3e) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L125 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L270 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L446 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L456 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L462 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L468 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L475 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L482 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L489 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L496 |
|
| Using post for a create operation is discouraged. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L504 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1136 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1179 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1225 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1280 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1294 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1343 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1357 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1506 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1682 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1688 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1694 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1704 |
|
| Check for appropriate use of formData parameters. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1710 |
|
| Using post for a create operation is discouraged. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1718 |
|
| Property should have a description. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1850 |
|
| Property should have a description. Location: TextToSpeech/preview/2024-02-01-preview/texttospeech.json#L1854 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @ForrestGumb! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
|
Approving breaking changes because the breaking change check failed with a runtime exception. Manual inspection of the diff shows no breaking changes. |
mikekistler
added
the
Approved-BreakingChange
konrad-jamrozik
added
Approved-BreakingChange
microsoft-github-policy-service
bot
added
the
no-recent-activity
microsoft-github-policy-service
bot
removed
no-recent-activity
mikekistler
reviewed
Mar 14, 2024
Comment on lines
+1717
to
+1719
| "properties": { | ||
| "$ref": "#/definitions/ConsentProperties" | ||
| }, |
There was a problem hiding this comment.
What is the reason for nesting the failureReason within properties? Levels of nesting should be avoided unless there is good reason for them, and particularly when the nested object contains only one property (as is the case here).
There was a problem hiding this comment.
No strong reason.
In Custom Voice schema definition, we put shared properties (like id, name, description, status, createdDateTime) in top level, and put type specific properties under ‘properties’. Properties under ‘properties’ are optional.
It’s too late to move them up. Other object type (Endpoint, Model, TrainingSet, PersonalVoice) already followed this design.
There was a problem hiding this comment.
Properties that are nested for no good reason are a poor user experience. I'll approve for this preview but please fix this for your next preview.
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
...ognitiveservices/data-plane/Speech/TextToSpeech/preview/2024-02-01-preview/texttospeech.json
Show resolved
Hide resolved
...ognitiveservices/data-plane/Speech/TextToSpeech/preview/2024-02-01-preview/texttospeech.json
Outdated
Show resolved
Hide resolved
weidongxu-microsoft
approved these changes
Mar 18, 2024
|
There is some warning in LintDiff
|
mikekistler
approved these changes
Mar 18, 2024
mikekistler
added
the
APIStewardshipBoard-SignedOff
1. Remove 'None' from modelFailureReason and consentFailureReason. 2. Add x-ms-error-code in header
|
in LintDiff appears to be a false alert. |
vxfield
pushed a commit
that referenced
this pull request
Mar 28, 2024
* Update Custom Voice API to a new version (2024-02-01-preview). Compare to previous version (2023-12-01-preview), only one change. Added failureReason property in Consent. * Fix LintDiff error on CustomVoice API by adding produces on delete method. * Update Custom Voice API according to review feedback. 1. Remove 'None' from modelFailureReason and consentFailureReason. 2. Add x-ms-error-code in header * Response shared "reponses" because LintDiff will report error on that. * Fix markdown grammar in description. --------- Co-authored-by: Jun-wei Gan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Update Custom Voice API to a new version (2024-02-01-preview).
Compare with previous version (2023-12-01-preview), only one change. Added failureReason property in Consent.
I missed failure reason in initial version.
Create consent is a long-running-operation. When it fails, customer need a way to know the failure reason.
It should return failure reason in the same way as Model and PersonalVoice.
So, I added failureReason in Consent.properties follow the same patter as Model and PersonalVoice.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.