create New TA API version v3.1-preview.5 #13851
Merged
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
…ersion to avoid breaking changes in client side code
|
Hi, @laramume Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Guid used in model definition 'JobMetadata' for property 'jobId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json#L2129 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Enum does not match case for: Positive Url: TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json#L1890 JsonUrl: preview/v3.1-preview.5/examples/SuccessfulHealthStatusRequest.json |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 34 Errors, 17 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/v3.1-preview.5/TextAnalytics.json compared with base:preview/v3.1-preview.4/TextAnalytics.json
- current:preview/v3.1-preview.5/TextAnalytics.json compared with base:stable/v3.0/TextAnalytics.json
Only 10 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️🔄CredScan inProgress [Detail]
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
"tag":"release_3_1_preview.5",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
"tag":"release_3_1_preview.5",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
"tag":"release_3_1_preview.5",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️🔄[Staging] Lint(RPaaS) inProgress [Detail]
Swagger Generation Artifacts
|
|
Hi @laramume, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
deyaaeldeen
reviewed
Apr 12, 2021
...ication/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json
Outdated
Show resolved
Hide resolved
...ication/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json
Outdated
Show resolved
Hide resolved
deyaaeldeen
reviewed
Apr 12, 2021
...ication/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json
Outdated
Show resolved
Hide resolved
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
deyaaeldeen
reviewed
Apr 13, 2021
| "type": "string" | ||
| }, | ||
| "loggingOptOut": { | ||
| "default": "true", |
There was a problem hiding this comment.
why loggingOptOut is true by default for pii tasks only?
There was a problem hiding this comment.
for pii sync, pii async, healthcare async this value by default is true because these endpoints usually receive sensitive info and we dont want to log it until customer explicitly says so
There was a problem hiding this comment.
interesting, does logging implies more people will have access to the sensitive data?
There was a problem hiding this comment.
No only engineering team. We were already logging this for 48 hours but now we have the option to opt out of this 48 hour logging
deyaaeldeen
reviewed
Apr 14, 2021
There was a problem hiding this comment.
Thanks for addressing my feedback. However, I tried regenerating off the latest version and I get this error:
dealmaha@dev:~/text-analytics/sdk/textanalytics/ai-text-analytics$ npx autorest swagger/README.md
AutoRest code generation utility [cli version: 3.1.3; node: v14.15.4, max-memory: 4096 MB]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
There is a new version of AutoRest available (3.1.5).
> You can install the newer version with with npm install -g autorest@latest
Loading AutoRest core '/home/dealmaha/.autorest/@autorest_core@3.3.0/node_modules/@autorest/core/dist' (3.3.0)
INFORMATION: > Loading local AutoRest extension '@autorest/typescript' (/home/dealmaha/corev2-v6)
INFORMATION: > Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)
Error: $ref to original location 'https://raw.githubusercontent.com/Azure/azure-rest-api-specs/8ae1f5bb6a6204abf77d7c49a6c4a977747432a2/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json#/components/schemas/c' is not found in the new refs collection
cc @iscai-msft
deyaaeldeen
requested changes
Apr 14, 2021
...ication/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json
Outdated
Show resolved
Hide resolved
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
maririos
reviewed
Apr 16, 2021
...ication/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json
Show resolved
Hide resolved
maririos
approved these changes
Apr 26, 2021
|
@laramume do you have an ETA of when this PR will be merged? We will like to consume it in the SDKs as soon as possible |
This PR is good be merged but I dont have permission to do it. |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
suhas92
approved these changes
May 5, 2021
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Guid used in model definition 'JobMetadata' for property 'jobId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: TextAnalytics/preview/v3.1-preview.5/TextAnalytics.json#L2129 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 34 Errors, 17 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/v3.1-preview.5/TextAnalytics.json compared with base:preview/v3.1-preview.4/TextAnalytics.json
- current:preview/v3.1-preview.5/TextAnalytics.json compared with base:stable/v3.0/TextAnalytics.json
Only 10 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
"tag":"release_3_1_preview.5",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
"tag":"release_3_1_preview.5",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
"tag":"release_3_1_preview.5",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
ghost
pushed a commit
to Azure/azure-sdk-for-js
that referenced
this pull request
May 12, 2021
…14808) - adds support for new text analytics in v3.1-preview.5. Fixes #15128 - removes the word `batch` to simplify names and avoid confusion after talking with @xirzec and the crew. Fixes #15127 - add test cases for analyze sentiment and recognize linked entities actions - update tests for action validation to match new strict validation behavior in the service in the post request - re-enable some disabled tests now that the service fixed those issues - disabled the statistics test for `beginAnalyzeActions` because of wrong answers coming from the service and it is currently being investigated - the CI failures are because the service did not deploy healthcare API yet so this PR can not be merged until then but please review it. - removed the logic for setting model version even if the user does not specify yet. This logic was needed because of a service-side bug that is now fixed. Fixes #14079 [API View](https://apiview.dev/Assemblies/Review/8754191c44914b7e88232f8aba5073de?diffRevisionId=43c78776e4a6490aa4009fb1035ec44d&doc=False&diffOnly=False) [Swagger PR](Azure/azure-rest-api-specs#13851)
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
May 14, 2021
anuchandy
approved these changes
May 14, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* updated model names in preview version to be consistent with stable version to avoid breaking changes in client side code * changed swagger files * new TA API version v3.1-preview.5 * new TA API version v3.1-preview.5 * change input name * resolve PR comments * fix PR comments * change loggingOptOut default value to be string * change loggingOptOut default value to be string * change TextElements_v8 to TextElement_v8 * resolve comments * fix build issues * fix build issues * fix build issues * fix build issues
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.
API CHanges from previous version