Updates HealthDataAiService.Deid with feedback from SDK Review Team #29036

GrahamMThomas · 2024-05-08T19:08:58Z

Data Plane API Specification Update Pull Request

Switched from release branch to unprotected branch. First 5 commits have been reviewed already. Please adjust the diff so things aren't re-reviewed (unless you want to).
Updated Diff:
https://github.com/Azure/azure-rest-api-specs/pull/29036/files/371b2ca55cb77c66dab055461acfb921650e6d52..06e87ed008447343cf995a66ef40d8ac8f0673ca

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

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.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

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.}

Design Document:
Previous API Spec Doc:
Updated paths:

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 ApiView comment 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.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
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.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

…7563) Initial Creation of HealthDataAIServices Deid Service Spec. --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

…Token (Azure#28061) * Adds errorCode and explanation; Replaces pagination with continuationToken * Updates to use standard Azure Foundation Error --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

…8349) * Updated CompletedAt to LastUpdatedAt for all terminal states * Updates examples; Moves error order * Set examples to more realistic value * Updates File model for future expansion * Adds Input FileLocation --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

…with etag (Azure#28528) * Updates minor tweaks * Updates examples --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

openapi-pipeline-app · 2024-05-08T19:09:01Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-05-08T19:09:01Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 2 Warnings warning [Detail]

Compared specs (v2.2.2)	new version	base version
package-2024-01-16-preview	package-2024-01-16-preview(b6fd5ea)	default(healthdataaiservices-deidentification-2024-01-16-preview)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
⚠️ PutRequestResponseScheme	A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Deidentification_CreateJob' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: HealthDataAIServices.Deidentification/preview/2024-01-16-preview/HealthDataAIServices.Deidentification.json#L213
⚠️ OperationId	OperationId for put method should contain both 'Create' and 'Update' Location: HealthDataAIServices.Deidentification/preview/2024-01-16-preview/HealthDataAIServices.Deidentification.json#L214

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

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

openapi-pipeline-app · 2024-05-08T19:09:02Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed in generating from 2d49d29. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1]
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  141 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  141 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to packe sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  141 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact

❌Azure.Health.Deidentification [Preview SDK Changes]
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning in generating from 2d49d29. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh] npm notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[automation_init.sh] npm notice
warn		specification/healthdataaiservices/HealthDataAIServices.Deidentification/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
warn	No file changes detected after generation
warn	No package detected after generation

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

❌Failed in generating from 2d49d29. 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
warn	No file changes detected after generation
warn	No package detected after generation

❌azure-health-deidentification [Preview SDK Changes]
- pom.xml

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

⚠️Warning in generating from 2d49d29. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
warn	No file changes detected after generation
warn	No package detected after generation

️✔️@azure-rest/azure-health-deidentification [Preview SDK Changes]
- azure-rest-azure-health-deidentification-1.0.0-beta.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-powershell warning [Detail]

⚠️Warning in generating from 2d49d29. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn		specification/healthdataaiservices/HealthDataAIServices.Deidentification/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

⚠️Az.healthdataaiservices.DefaultTag [Preview SDK Changes]

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

⚠️Warning in generating from 2d49d29. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh]  notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.7.0` to update!
cmderr	[automation_init.sh] npm notice
warn		specification/healthdataaiservices/data-plane/HealthDataAIServices.Deidentification/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-health-deidentification [Preview SDK Changes]
- azure_health_deidentification-1.0.0b1-py3-none-any.whl
- azure-health-deidentification-1.0.0b1.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```

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

openapi-pipeline-app · 2024-05-08T19:09:03Z

Generated ApiView

Language	Package Name	ApiView Link
Python	azure-health-deidentification	Create ApiView failed. To get help, please see [aka.ms/azsdk/pr-getting-help](https://aka.ms/azsdk/pr-getting-help).
JavaScript	@azure-rest/azure-health-deidentification	https://apiview.dev/Assemblies/Review/a738f6f0ae2344998ee7944058040f46?revisionId=f4a9d5d9e2124f74b296e6623a8c2a18
TypeSpec	HealthDataAIServices.Deidentification	https://apiview.dev/Assemblies/Review/0edf04336ffa4656af2fa61b553ca06f?revisionId=8aeab09bc00b443691b53cd5c317d276
Swagger	HealthDataAIServices.Deidentification	https://apiview.dev/Assemblies/Review/0e4cdb5cfebc4d16bfa3f7e603c23a01?revisionId=4d67d80b036043c29e1ee64d082d5a7d

GrahamMThomas · 2024-05-08T19:09:41Z

New unprotected and updated branch from: #29012

GrahamMThomas and others added 17 commits May 8, 2024 12:01

Generate new Service for deidentification

4b12799

[data-plane] Initial Creation of HealthDataAiServices.Deid 2 (Azure#2…

188032c

…7563) Initial Creation of HealthDataAIServices Deid Service Spec. --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

Adds errorCode and explanation; Replaces pagination with continuation…

fda21b2

…Token (Azure#28061) * Adds errorCode and explanation; Replaces pagination with continuationToken * Updates to use standard Azure Foundation Error --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

Updates parameter validators/defaults/nullability; Replaces checksum …

371b2ca

…with etag (Azure#28528) * Updates minor tweaks * Updates examples --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com>

Updates HealthDataAiService.Deid with feedback from SDK Review Team

5e7c412

Updates TSPconfig for c#

1fafc2a

Adds CSharp special

b96f92e

Updates version to match live version

f42d923

Updates java package name

4271e96

Fix java namespace name

ecbbb25

Updates python package name

94e86ed

Updates to match version service is currently using

abb88d1

Updates package names

0876eda

Removes update in cspell

ac8f087

Updates java namespace

4ab7b92

Fixes cspell.json

06e87ed

GrahamMThomas changed the title ~~Gthomas/feat/sdk review~~ Updates HealthDataAiService.Deid with feedback from SDK Review Team May 8, 2024

AzureRestAPISpecReview added data-plane TypeSpec Authored with TypeSpec labels May 8, 2024

Graham Thomas added 2 commits May 8, 2024 12:38

Test1

a37f5e5

Convert to diff long running operation

b6fd5ea

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates HealthDataAiService.Deid with feedback from SDK Review Team #29036

Updates HealthDataAiService.Deid with feedback from SDK Review Team #29036

GrahamMThomas commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

GrahamMThomas commented May 8, 2024

Updates HealthDataAiService.Deid with feedback from SDK Review Team #29036

Are you sure you want to change the base?

Updates HealthDataAiService.Deid with feedback from SDK Review Team #29036

Conversation

GrahamMThomas commented May 8, 2024 • edited

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

openapi-pipeline-app bot commented May 8, 2024 • edited

Next Steps to Merge

openapi-pipeline-app bot commented May 8, 2024 • edited

Swagger Validation Report

openapi-pipeline-app bot commented May 8, 2024 • edited

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 8, 2024 • edited

Generated ApiView

GrahamMThomas commented May 8, 2024

GrahamMThomas commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited

openapi-pipeline-app bot commented May 8, 2024 •

edited