azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Azure AI - Health Insights] - Typespec revision for Health Insights API Version 2
Data Plane API - Pull Request
Health Insights (formaerly Health Decision Support) was released to Public Preview at the end of March 2023. We are working on a new API version which will include some new AI models in preview.
Base on private repo PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/13119
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/12510
Is this review for (select one):
- [ ] a private preview
- [X] 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: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/ai/HealthInsights
- Updated paths: Common, RadiologyInsights (New), PatientTimeline (New), OncoPhenotype, TrialMatcher
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.
Next Steps to Merge
✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).![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): 46 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| openapi.json | 2023-09-01-preview(9e1bfd7) | 2023-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 119 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| 2023-09-01-preview | 2023-09-01-preview(9e1bfd7) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: LongRunningOperationsOptionsValidator | A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L64 |
RPC-Async-V1-05 |
| :warning: ParameterNamesConvention | header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L76 |
|
| :warning: ParameterDescription | Parameter should have a description. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L82 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L86 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L210 |
|
| :warning: LongRunningOperationsOptionsValidator | A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L253 |
RPC-Async-V1-05 |
| :warning: ParameterNamesConvention | header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L265 |
|
| :warning: ParameterDescription | Parameter should have a description. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L271 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L275 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L319 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L319 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L399 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L411 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L411 |
|
| :warning: LongRunningOperationsOptionsValidator | A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L442 |
RPC-Async-V1-05 |
| :warning: ParameterNamesConvention | header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L454 |
|
| :warning: ParameterDescription | Parameter should have a description. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L460 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L464 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L588 |
|
| :warning: LongRunningOperationsOptionsValidator | A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L631 |
RPC-Async-V1-05 |
| :warning: ParameterNamesConvention | header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L643 |
|
| :warning: ParameterDescription | Parameter should have a description. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L649 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L653 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L653 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L653 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L777 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L1414 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L1414 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L1488 |
|
| :warning: AdditionalPropertiesAndProperties | Don't specify additionalProperties as a sibling of properties. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L1488 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: SecurityDefinitionDescription | Security definition should have a description. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L43 |
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L875 |
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L909 |
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L922 |
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L936 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L3766 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L3771 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L3783 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L4775 |
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-09-01-preview/openapi.json#L4780 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️❌TypeSpecAPIView: 0 Errors, 5 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." |
| :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." |
| :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." |
| :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." |
| :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.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️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 warning [Detail]
⚠️Warning [Logs] Generate from 0b86423a8256b66c84c4e0e0d7d52e75105bb4bb. 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/ai/data-plane/HealthInsights/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk warn specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml skipped due to azure-sdk-for-python 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 cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 10.2.3 -> 10.4.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️azure-healthinsights-cancerprofiling [View full logs] [Preview SDK Changes]- azure-healthinsights-cancerprofiling-1.0.0b2.zip
- azure_healthinsights_cancerprofiling-1.0.0b2-py3-none-any.whl
info [Changelog] data-plan skip changelog generation temporarily
️✔️azure-healthinsights-patienttimeline [View full logs] [Preview SDK Changes]- azure_healthinsights_patienttimeline-1.0.0b1-py3-none-any.whl
- azure-healthinsights-patienttimeline-1.0.0b1.zip
info [Changelog] data-plan skip changelog generation temporarily
️✔️azure-healthinsights-radiologyinsights [View full logs] [Preview SDK Changes]- azure_healthinsights_radiologyinsights-1.0.0b1-py3-none-any.whl
- azure-healthinsights-radiologyinsights-1.0.0b1.zip
info [Changelog] data-plan skip changelog generation temporarily
️✔️azure-healthinsights-clinicalmatching [View full logs] [Preview SDK Changes]- azure-healthinsights-clinicalmatching-1.0.0b2.zip
- azure_healthinsights_clinicalmatching-1.0.0b2-py3-none-any.whl
info [Changelog] data-plan skip changelog generation temporarily
️❌ azure-sdk-for-java failed [Detail]
❌Failed [Logs] Generate from 0b86423a8256b66c84c4e0e0d7d52e75105bb4bb. 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] % Total % Received % Xferd Average 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 195k cmderr [init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz... cmderr [init.sh] Computing checksum with sha256sum cmderr [init.sh] Checksums matched! warn specification/ai/data-plane/HealthInsights/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] cmderr [generate.py] npm notice New major version of npm available! 9.5.0 -> 10.4.0 cmderr [generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0> cmderr [generate.py] npm notice Run `npm install -g [email protected]` to update! cmderr [generate.py] npm notice cmderr [generate.py] warning: in the working copy of 'sdk/healthinsights/azure-healthinsights-cancerprofiling/pom.xml', CRLF will be replaced by LF the next time Git touches it
❌azure-healthinsights-cancerprofiling [View full logs] [Preview SDK Changes]❌azure-healthinsights-patienttimeline [View full logs] [Preview SDK Changes]❌azure-healthinsights-radiologyinsights [View full logs] [Preview SDK Changes]❌azure-healthinsights-clinicalmatching [View full logs] [Preview SDK Changes]
️❌ azure-sdk-for-net-track2 failed [Detail]
- Only show 30 items here, please refer to log for details.
❌Failed [Logs] Generate from 0b86423a8256b66c84c4e0e0d7d52e75105bb4bb. SDK Automation 14.0.0cmderr [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 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;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 cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 131 | [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
❌Azure.Health.Insights.CancerProfiling [View full logs] [Preview SDK Changes]info [Changelog]
❌Azure.Health.Insights.PatientTimeline [View full logs] [Preview SDK Changes]info [Changelog]
❌Azure.Health.Insights.RadiologyInsights [View full logs] [Preview SDK Changes]info [Changelog]
❌Azure.Health.Insights.ClinicalMatching [View full logs] [Preview SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 0b86423a8256b66c84c4e0e0d7d52e75105bb4bb. 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 warn specification/ai/data-plane/HealthInsights/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json cmderr [automation_generate.sh] [ERROR] Generate changelog failed: ENOENT: no such file or directory, scandir '/mnt/vss/_work/1/s/azure-sdk-for-js/sdk/healthinsights/azurehealthinsightscancerprofiling-rest/review'
️✔️@azure-rest/health-insights-cancerprofiling [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️✔️@azure-rest/health-insights-patienttimeline [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️✔️@azure-rest/health-insights-radiologyinsights [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️✔️@azure-rest/health-insights-clinicalmatching [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
Generated ApiView
I replaced @tg-msft with @JeffreyRichter in the reviewers list as Ted has stepped away from API Stewardship for a time and Jeff should review the LRO pattern here.
Hi @asaflevi-ms! 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}
Link to API Review issue: https://github.com/Azure/azure-rest-api-specs-pr/issues/12510
The Azure API Stewardship Board has recently modified our LRO guidance to include scenarios similar to what you appear to need, (we never had guidance on these scenarios before) see https://github.com/microsoft/api-guidelines/blob/f11b219cfcb846fab605e80ca72ae96477a412f5/azure/Guidelines.md#long-running-operations-lros.
Could you adopt this guidance and in particular this section: https://github.com/microsoft/api-guidelines/blob/f11b219cfcb846fab605e80ca72ae96477a412f5/azure/Guidelines.md#lro-action-no-resource
Do clients ever need to LIST the LRO operations that are in flight? Your current API does not support this, but the new guidance does offer a way of making this possible.
The Azure API Stewardship Board has recently modified our LRO guidance to include scenarios similar to what you appear to need, (we never had guidance on these scenarios before) see https://github.com/microsoft/api-guidelines/blob/f11b219cfcb846fab605e80ca72ae96477a412f5/azure/Guidelines.md#long-running-operations-lros.
Could you adopt this guidance and in particular this section: https://github.com/microsoft/api-guidelines/blob/f11b219cfcb846fab605e80ca72ae96477a412f5/azure/Guidelines.md#lro-action-no-resource
Do clients ever need to LIST the LRO operations that are in flight? Your current API does not support this, but the new guidance does offer a way of making this possible.
Hi @JeffreyRichter Thanks for you comment. We are going to public preview next week and our GA is planned for end of Match, I prefer to adopt this change right after our public preview.
CC: @gils-ms
The Azure API Stewardship Board has recently modified our LRO guidance to include scenarios similar to what you appear to need, (we never had guidance on these scenarios before) see https://github.com/microsoft/api-guidelines/blob/f11b219cfcb846fab605e80ca72ae96477a412f5/azure/Guidelines.md#long-running-operations-lros. Could you adopt this guidance and in particular this section: https://github.com/microsoft/api-guidelines/blob/f11b219cfcb846fab605e80ca72ae96477a412f5/azure/Guidelines.md#lro-action-no-resource Do clients ever need to LIST the LRO operations that are in flight? Your current API does not support this, but the new guidance does offer a way of making this possible.
Hi @JeffreyRichter Thanks for you comment. We are going to public preview next week and our GA is planned for end of Match, I prefer to adopt this change right after our public preview.
CC: @gils-ms
It's fine to wait until after public preview. I'm curious to know if the new guidelines would be a problem in terms of it working for your customers. So please don't wait too look to look at it (not implement it) to see if it would work well for your scenarios so we have time to address any issues or make tweaks to the guidance.
I’ve added the signedOff label so you can move forward with your preview. -Mike
AvoidAnonymousTypes was supressed to workaround https://github.com/Azure/typespec-azure-pr/issues/3349
NOTE: The following CI failures are pending fixes:
- TypeSpec APIView is currently checking in sub-directories and attempting to generate an APIView for each folder that has a tspconfig.yaml, instead we need to generate the TypeSpec APIView for the whole spec with the tspconfig.yaml file that configures the typespec-autorest emitter. Tracking issue: https://github.com/Azure/azure-sdk-tools/issues/7599
- The SDK auto-generation steps are currently failing due to not considering auto-generating different products under 1 service directory. Tracking issue: https://github.com/Azure/azure-sdk-tools/issues/7603
@weidongxu-microsoft , Java sdk failed in generation step but doesn't have any details for the error when I verified locally. Do you know what caused the failure?
npx tsp compile /home/raychen/repos/tmp/work-dir/azure-sdk-for-java/sdk/healthinsights/azure-healthinsights-cancerprofiling/TempTypeSpecFiles/HealthInsights.OncoPhenotype/client.tsp --emit @azure-tools/typespec-java --option @azure-tools/typespec-java.emitter-output-dir=/home/raychen/repos/tmp/work-dir/azure-sdk-for-java/sdk/healthinsights/azure-healthinsights-cancerprofiling/
Write-Error: Failed to generate sdk project at /home/raychen/repos/tmp/work-dir/azure-sdk-for-java/sdk/healthinsights/azure-healthinsights-cancerprofiling
- The SDK auto-generation steps are currently failing due to not considering auto-generating different products under 1 service directory. Tracking issue: [SDK automation] SDK automation for TypeSpec PRs in the rest repo need to consider multiple products under a service directory azure-sdk-tools#7603
@catalinaperalta , sdk automation supports multiple TypeSpec projects scenario. For instance, see this dotnet run logs. All the four packages failed to be generated. //CC: @weshaggard
+@chunyu3 , can you troubleshoot if the generation failures are caused by spec issue?
"packages": [
{
"language": ".Net",
"changelog": {
"content": null,
"hasBreakingChange": null
},
"result": "failed",
"packageName": "Azure.Health.Insights.CancerProfiling",
"packageFolder": "/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/healthinsights/Azure.Health.Insights.CancerProfiling",
"path": [
"./sdk/healthinsights/Azure.Health.Insights.CancerProfiling",
"sdk/healthinsights/ci.yml"
],
"artifacts": [],
"installInstructions": {
"full": null,
"lite": null
},
"apiViewArtifact": ""
},
{
"path": [
""
],
"result": "failed"
},
{
"path": [
""
],
"result": "failed"
},
{
"path": [
""
],
"result": "failed"
}
]
- The SDK auto-generation steps are currently failing due to not considering auto-generating different products under 1 service directory. Tracking issue: [SDK automation] SDK automation for TypeSpec PRs in the rest repo need to consider multiple products under a service directory azure-sdk-tools#7603
@catalinaperalta , sdk automation supports multiple TypeSpec projects scenario. For instance, see this dotnet run logs. All the four packages failed to be generated. //CC: @weshaggard
+@chunyu3 , can you troubleshoot if the generation failures are caused by spec issue?
"packages": [ { "language": ".Net", "changelog": { "content": null, "hasBreakingChange": null }, "result": "failed", "packageName": "Azure.Health.Insights.CancerProfiling", "packageFolder": "/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/healthinsights/Azure.Health.Insights.CancerProfiling", "path": [ "./sdk/healthinsights/Azure.Health.Insights.CancerProfiling", "sdk/healthinsights/ci.yml" ], "artifacts": [], "installInstructions": { "full": null, "lite": null }, "apiViewArtifact": "" }, { "path": [ "" ], "result": "failed" }, { "path": [ "" ], "result": "failed" }, { "path": [ "" ], "result": "failed" } ]
The error is
It because you put the service.tsp at the top level directory and the tsp-location.yaml does not include the top-level directory, so it does not sync this file to generate. I suggest to put this common tsp in a directory called ***.common or something, then add the common directory in the additionalDirectories in the tsp-location.yaml
Thanks @chunyu3.
@asaflevi-ms @catalinaperalta we should consider moving those back into their own sub directory or moving them under the common project and then add whichever path back to the additionalDirectories in the tspconfig.yaml files.
Follow up about the remaining CI failures [NOT blocking PR merge]:
- TypeSpec APIView: the check will be updated to account for projects with similar structures.
- Tracking issue: https://github.com/Azure/azure-sdk-tools/issues/7599
- SDK azure-sdk-for-net-track2:
- There are some test failures in the SDK due to some renames in the spec. @asaflevi-ms please take a look at these issues and update in the .NET SDK tests where necessary before your next release.
- There is an issue with using a namespace that is not approved. @asaflevi-ms and I will follow up on this.
- SDK azure-sdk-for-java:
- @raych1 @weidongxu-microsoft looks like a tool failure to find the package to build, please help investigate.
- SDK azure-sdk-for-js: JS SDK build succeeded but the PublishTestResults step failed.
- @raych1 could you also please help investigate why the PublishTestResults failed.
Thanks @weshaggard for helping investigate and catching the issues in the PR!
Could be a bug in Java automation, when one PR involves changes to multiple packages (new and existing). Will check on the PR migrating tsp-client. (WIP https://github.com/Azure/azure-sdk-for-java/pull/38563)
@catalinaperalta The failure is due to incorrect tspconfig for java emitter https://github.com/Azure/azure-rest-api-specs/pull/27223#discussion_r1477177911 It is wrong for every package... Fix https://github.com/Azure/azure-rest-api-specs/pull/27646 (considering whether to add a verification in script, this is indeed hard to find)
