TA v3.1-preview.4 - updated examples and definitions for TA for Health

[ctufts]

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.

1. 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
2. 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.
3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
4. 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.

[openapi-workflow-bot]

Hi, @ctufts 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]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️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.4
• 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.4

️️✔️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.

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

[openapi-pipeline-app]

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account. 

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

• ⚠️Warning [Logs] Generate from 516a0678ba1e9413c7daff57fe152539e3b619b7. 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-13 22:43:59 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-python failed [Detail]

• ❌Failed [Logs] Generate from 516a0678ba1e9413c7daff57fe152539e3b619b7. 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-ai-textanalytics [View full logs]  [Preview 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.

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

• ️✔️Succeeded [Logs] Generate from 516a0678ba1e9413c7daff57fe152539e3b619b7. 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

• ️✔️cognitiveservices/v2.1/textanalytics [View full logs]  [Preview SDK Changes]

  info	[Changelog] No exported changes

• ️✔️cognitiveservices/v2.0/textanalytics [View full logs]  [Preview SDK Changes]

  info	[Changelog] No exported changes

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

• ️✔️Succeeded [Logs] Generate from 516a0678ba1e9413c7daff57fe152539e3b619b7. 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]  [Preview 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 151ms

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

[openapi-workflow-bot]

Hi @ctufts, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

[tjprescott]

@ctufts is this ready to merge?

[ctufts]

@ctufts is this ready to merge?
@tjprescott Not yet, I'd like to get a review in from some other TA members first. Will update you when it is ready for merging.

[ctufts]

@ctufts is this ready to merge?
@tjprescott Not yet, I'd like to get a review in from some other TA members first. Will update you when it is ready for merging.

@tjprescott I believe this is ready to merge now.

[abhahn]

One thing that has come up in discussion with the SDK team is about whether or not we could include the different relation types as an enum in the Swagger. I this something that is feasible, or are there reasons we shouldn't do this?

[assafi]

One thing that has come up in discussion with the SDK team is about whether or not we could include the different relation types as an enum in the Swagger. I this something that is feasible, or are there reasons we shouldn't do this?

@abhahn This will tie the set of returned types to a specific API version. So new types for example could only be added in a new API version vs. a new model-version. Although we might be able to use extensible enums via the x-ms-enum extension to mitigate that concern.