azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[data-plane] Initial Creation of HealthDataAiServices.Deid
Data Plane API - Pull Request
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: https://github.com/Azure/azure-rest-api-specs-pr/issues/16239
Is this review for (select one):
- [X] 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
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
- Open API Hub
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.
PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
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: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| default | default(b68ecbe) | default(release-healthdataaiservices-deidentification-2024-01-31-preview) |
| package-2024-01-31-preview | package-2024-01-31-preview(b68ecbe) | default(release-healthdataaiservices-deidentification-2024-01-31-preview) |
[must fix]The following errors/warnings are introduced by current PR:
️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: data-plane/Microsoft.HealthDataAIServices/preview/2024-01-31-preview |
|
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: Microsoft.HealthDataAIServices/preview/2024-01-31-preview/examples |
|
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: b68ecbe886fddf02d1a6f623cb7ad02b1f8f7716/specification/deidentification/data-plane |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️❌TypeSpecAPIView: 0 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
| :warning: Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. | "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." |
️️✔️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: 0 Errors, 0 Warnings failed [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 22f6d8c6cf121f36103f043eb1176faebddcdb9a. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. 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 warning [Detail]
⚠️Warning [Logs] Generate from 22f6d8c6cf121f36103f043eb1176faebddcdb9a. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] ge Speed Time Time Time Current cmderr [init.sh] Dload Upload Total Spent Left Speed cmderr [init.sh] 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 100 15916 100 15916 0 0 1195k 0 --:--:-- --:--:-- --:--:-- 1295k cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] ######################## 100.0% cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! 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-healthdataaiservices-deid [View full logs] [Preview SDK Changes]
️⚠️ azure-sdk-for-js warning [Detail]
⚠️Warning [Logs] Generate from 22f6d8c6cf121f36103f043eb1176faebddcdb9a. SDK Automation 14.0.0command 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-healthdataaiservices-deid-rest [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-powershell warning [Detail]
⚠️Warning [Logs] Generate from 22f6d8c6cf121f36103f043eb1176faebddcdb9a. SDK Automation 14.0.0command 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 [View full logs] [Preview SDK Changes]
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from 22f6d8c6cf121f36103f043eb1176faebddcdb9a. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools' cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. 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-healthdataaiservices-deid [View full logs] [Preview SDK Changes]info [Changelog] data-plan skip changelog generation temporarily
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs] Generate from 22f6d8c6cf121f36103f043eb1176faebddcdb9a. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn specification/healthdataaiservices/data-plane/HealthDataAIServices.Deidentification/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk 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.2.3 -> 10.4.0 cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0> cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g [email protected]` to update! cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 141 | [0m [36;1mGeneratePackage `[0m cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 141 | [0m [36;1mGeneratePackage `[0m cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to packe sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 807 | [0m … rtifacts += [36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mCannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1mit does not exist. cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 141 | [0m [36;1mGeneratePackage `[0m cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to generate sdk artifact cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.HealthDataAIServices.Deid [View full logs] [Preview SDK Changes]info [Changelog]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Python | azure-healthdataaiservices-deid | https://apiview.dev/Assemblies/Review/fa813ec0815c4b559e6ba9eb78429cbf?revisionId=62f94bf6dda843e4b8f65e343d068ce7 |
| Java | azure-healthdataaiservices-deid | https://apiview.dev/Assemblies/Review/2c8a3e0db89c414390d3a6724434a3c3?revisionId=3cb138917f954df49c03476c27cd5036 |
| JavaScript | @azure-rest/azure-healthdataaiservices-deid-rest | https://apiview.dev/Assemblies/Review/e56a4110964344538b8751152dc7536e?revisionId=a757589a0431442fb697eb5967291721 |
Hi @GrahamMThomas! 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.
For more details refer to the wiki.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.
Can we get a branch for this PR to merge into instead of main? We are currently in private preview with very few customers and don't want published SDKs yet.
You can use https://openapihub.azure-devex-tools.com/ to create a feature branch.
Select "create openapi specs". And if you need collaboration on the feature branch, select "multiple people working" within.
Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
Hi, @GrahamMThomas, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. Action Required:
Swagger Validation Report
️⌛BreakingChange pending [Detail]
️🔄Breaking Change(Cross-Version) inProgress [Detail]
️⌛LintDiff pending [Detail]
️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: data-plane/Microsoft.HealthDataAIServices/preview/2024-01-31-preview |
|
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: Microsoft.HealthDataAIServices/preview/2024-01-31-preview/examples |
|
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: b68ecbe886fddf02d1a6f623cb7ad02b1f8f7716/specification/deidentification/data-plane |
️⌛SwaggerAPIView pending [Detail]
️⌛TypeSpecAPIView pending [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️🔄SemanticValidation inProgress [Detail]
️⌛SpellCheck pending [Detail]
️⌛PR Summary pending [Detail]
️⌛Automated merging requirements met pending [Detail]
Closing as I think something is wrong with the build pipeline state. Will reopen a new PR.