[Text Analytics] Add AnalyzeJobMetadata #12242

deyaaeldeen · 2020-12-28T21:46:43Z

There is no way to set a displayName for healthcare jobs so their job metadata in their responses should not have displayName either. This PR adds AnalyzeJobMetadata with displayName for analyze jobs and removes displayName from the job metadata for healthcare jobs.

This was already discussed in the design review for the healthcare API meeting.

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.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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.
- Adding new API(s)
- Adding a new API version
- Adding a new service
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 API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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.

…m healthcare metadata

openapi-workflow-bot · 2020-12-28T21:46:45Z

Hi, @deyaaeldeen Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2020-12-28T21:46:46Z

Swagger Validation Report

️❌BreakingChange: 2 Errors, 2 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.5)
- original: preview/v3.1-preview.3/TextAnalytics.json <---> new: preview/v3.1-preview.3/TextAnalytics.json

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'displayName' renamed or removed? New: azure-rest-api-specs/blob/489f780a56b705ed5340886e7a557028836403bf/
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'displayName' renamed or removed? New: TextAnalytics/preview/v3.1-preview.3/TextAnalytics.json#L1922:7 Old: TextAnalytics/preview/v3.1-preview.3/TextAnalytics.json#L1922:7
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: TextAnalytics/preview/v3.1-preview.3/TextAnalytics.json#L128:13 Old: TextAnalytics/preview/v3.1-preview.3/TextAnalytics.json#L128:13
⚠️ 1032 - DifferentAllOf	The new version has a different 'allOf' property than the previous one. New: TextAnalytics/preview/v3.1-preview.3/TextAnalytics.json#L954:5 Old: TextAnalytics/preview/v3.1-preview.3/TextAnalytics.json#L954:5

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.3
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- data-plane/TextAnalytics/readme.md tag:release_3_1_preview.3

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2020-12-28T21:46:47Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from a5dcb30. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/data-plane/TextAnalytics/readme.md

️✔️@azure/cognitiveservices-textanalytics [View full logs] [Release SDK Changes]

azure-cognitiveservices-textanalytics-4.0.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/textAnalyticsClient.js → ./dist/cognitiveservices-textanalytics.js...
cmderr	[npmPack] created ./dist/cognitiveservices-textanalytics.js in 196ms

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from a5dcb30. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-01-06 17:36:00 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

️❌ azure-sdk-for-go failed [Detail]

❌Failed [Logs]Release - Generate from a5dcb30. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
HttpError: Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
    at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit/request@5.4.9/node_modules/@octokit/request/dist-node/index.js:66:23
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async workflowPkgUpdatePR (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:305:21)
    at async Object.exports.workflowPkgMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:40:5)
    at async workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:170:9)
    at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
    at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
    at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:18:20

️✔️cognitiveservices/v2.1/textanalytics [View full logs]

info	[Changelog] No exported changes
error	Fatal error: Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
error	The following packages are still pending:
error		cognitiveservices/v2.1/textanalytics
error		cognitiveservices/v2.0/textanalytics

️✔️cognitiveservices/v2.0/textanalytics

️❌ azure-sdk-for-python failed [Detail]

❌Failed [Logs]Release - Generate from a5dcb30. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	python3 -m venv venv
command	pip install --upgrade setuptools wheel pip
command	pip install pathlib jinja2 msrestazure
command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/cognitiveservices/data-plane/TextAnalytics/readme.md

⚠️azure-cognitiveservices-language-textanalytics [View full logs] [Release SDK Changes]

cmderr	[buildConf] INFO:packaging_tools:Building template azure-cognitiveservices-language-textanalytics
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
cmderr	[buildConf] INFO:packaging_tools:Template done azure-cognitiveservices-language-textanalytics
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.cognitiveservices.language.textanalytics
cmderr	[changelogReport] INFO:__main__:Found azure.cognitiveservices.language.textanalytics
cmderr	[changelogReport] INFO:__main__:Working on azure.cognitiveservices.language.textanalytics
cmderr	[changelogReport] INFO:__main__:Report written to sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-cognitiveservices-language-textanalytics on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.2.0 of azure-cognitiveservices-language-textanalytics in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.cognitiveservices.language.textanalytics
cmderr	[changelogReportLatest] INFO:__main__:Found azure.cognitiveservices.language.textanalytics
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.cognitiveservices.language.textanalytics
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/code_reports/0.2.0/report.json
cmderr	[Changelog] Traceback (most recent call last):
cmderr	[Changelog]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
cmderr	[Changelog]     "__main__", mod_spec)
cmderr	[Changelog]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
cmderr	[Changelog]     exec(code, run_globals)
cmderr	[Changelog]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 200, in <module>
cmderr	[Changelog]     change_log = build_change_log(old_report, new_report)
cmderr	[Changelog]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 146, in build_change_log
cmderr	[Changelog]     if diff_line[0][0] == "operations":
cmderr	[Changelog] IndexError: list index out of range
cmdout	[Changelog] Size of delta 100.023% size of original (original: 30807 chars, delta: 30814 chars)
warn	Script return with result [warning] code [1] signal [null] cwd [azure-sdk-for-python/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics]: python

❌azure-ai-textanalytics [View full logs] [Release SDK Changes]

cmderr	[buildConf] INFO:packaging_tools:Building template azure-ai-textanalytics
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Package azure-ai-textanalytics has no auto-packaging update enabled
cmderr	[buildPackage] Traceback (most recent call last):
cmderr	[buildPackage]   File "setup.py", line 39, in <module>
cmderr	[buildPackage]     with open(os.path.join(package_folder_path, '_version.py'), 'r') as fd:
cmderr	[buildPackage] FileNotFoundError: [Errno 2] No such file or directory: 'azure/ai/textanalytics/_version.py'
cmderr	[buildPackage] Traceback (most recent call last):
cmderr	[buildPackage]   File "./build_package.py", line 33, in <module>
cmderr	[buildPackage]     create_package(args.name, args.dest)
cmderr	[buildPackage]   File "./build_package.py", line 22, in create_package
cmderr	[buildPackage]     check_call(['python', 'setup.py', 'bdist_wheel', '-d', dest_folder], cwd=absdirpath)
cmderr	[buildPackage]   File "/usr/lib/python3.6/subprocess.py", line 311, in check_call
cmderr	[buildPackage]     raise CalledProcessError(retcode, cmd)
cmderr	[buildPackage] subprocess.CalledProcessError: Command '['python', 'setup.py', 'bdist_wheel', '-d', 'sdk/textanalytics/azure-ai-textanalytics']' returned non-zero exit status 1.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: python
warn	Skip command for failed context: python ./scripts/dev_setup.py -p azure-ai-textanalytics
warn	Skip command for failed context: python -m packaging_tools.code_report azure-ai-textanalytics
warn	Skip command for failed context: python -m packaging_tools.code_report azure-ai-textanalytics --last-pypi
warn	Not exact 2 reports found:
warn	Not generating changelog.

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2020-12-28T21:49:07Z

Hi @deyaaeldeen, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

jhendrixMSFT · 2021-01-04T19:42:22Z

@deyaaeldeen does anybody from your team need to review this?

deyaaeldeen · 2021-01-05T02:26:32Z

@jhendrixMSFT I have everyone now! Please merge it :)

[Text Analytics] Add AnalyzeJobMetadata to remove its displayName fro…

489f780

…m healthcare metadata

deyaaeldeen requested review from maririos, suhas92, iscai-msft, mssfang and abhahn December 28, 2020 21:46

deyaaeldeen requested a review from yangyuan as a code owner December 28, 2020 21:46

openapi-assignment-bot bot assigned jhendrixMSFT Dec 28, 2020

deyaaeldeen requested a review from assafi December 28, 2020 21:47

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Dec 28, 2020

jhendrixMSFT approved these changes Jan 4, 2021

View reviewed changes

mssfang approved these changes Jan 4, 2021

View reviewed changes

ctufts self-requested a review January 4, 2021 22:04

ctufts approved these changes Jan 4, 2021

View reviewed changes

iscai-msft approved these changes Jan 6, 2021

View reviewed changes

lmazuel merged commit a5dcb30 into Azure:master Jan 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Text Analytics] Add AnalyzeJobMetadata #12242

[Text Analytics] Add AnalyzeJobMetadata #12242

deyaaeldeen commented Dec 28, 2020

openapi-workflow-bot bot commented Dec 28, 2020

openapi-pipeline-app bot commented Dec 28, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 28, 2020 •

edited

Loading

openapi-workflow-bot bot commented Dec 28, 2020

jhendrixMSFT commented Jan 4, 2021

deyaaeldeen commented Jan 5, 2021

[Text Analytics] Add AnalyzeJobMetadata #12242

[Text Analytics] Add AnalyzeJobMetadata #12242

Conversation

deyaaeldeen commented Dec 28, 2020

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Dec 28, 2020

openapi-pipeline-app bot commented Dec 28, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 28, 2020 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Dec 28, 2020

jhendrixMSFT commented Jan 4, 2021

deyaaeldeen commented Jan 5, 2021

openapi-pipeline-app bot commented Dec 28, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 28, 2020 •

edited

Loading