[Azure AI - Health Insights] - Typespec revision for Health Insights API V3 (Radiology Insights) #27614
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| openapi.json | 2024-04-01(7343a0d) | 2023-09-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.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/onco-phenotype/jobs' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L64:5 |
|
| The new version is missing a path that was found in the old version. Was path '/onco-phenotype/jobs/{id}' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L198:5 |
|
| The new version is missing a path that was found in the old version. Was path '/patient-timeline/jobs' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L253:5 |
|
| The new version is missing a path that was found in the old version. Was path '/patient-timeline/jobs/{id}' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L387:5 |
|
| The new version is missing a path that was found in the old version. Was path '/radiology-insights/jobs' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L442:5 |
|
| The new version is missing a path that was found in the old version. Was path '/trial-matcher/jobs' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L631:5 |
|
| The new version is missing a path that was found in the old version. Was path '/trial-matcher/jobs/{id}' removed or restructured? Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L765:5 |
|
| The new version is missing a definition that was found in the old version. Was 'ClinicalTrials' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a definition that was found in the old version. Was 'OncoPhenotypeData' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a definition that was found in the old version. Was 'OncoPhenotypeModelConfiguration' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a definition that was found in the old version. Was 'PatientTimelineData' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a definition that was found in the old version. Was 'PatientTimelineModelConfiguration' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a definition that was found in the old version. Was 'TrialMatcherData' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a definition that was found in the old version. Was 'TrialMatcherModelConfiguration' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L223:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L821:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L2993:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4867:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId' removed or renamed? New: HealthInsights/stable/2024-04-01/openapi.json#L2993:3 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4867:3 |
|
| The '$ref' property points to different models in the old and new versions. New: HealthInsights/stable/2024-04-01/openapi.json#L85:13 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L600:13 |
|
| The '$ref' property points to different models in the old and new versions. New: HealthInsights/stable/2024-04-01/openapi.json#L2736:9 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4431:9 |
|
| The '$ref' property points to different models in the old and new versions. New: HealthInsights/stable/2024-04-01/openapi.json#L103:13 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L613:13 |
|
| The '$ref' property points to different models in the old and new versions. New: HealthInsights/stable/2024-04-01/openapi.json#L2483:11 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L3996:11 |
|
| The new version has a different format '' than the previous one 'AutoRest.Swagger.Model.SwaggerParameter'. New: HealthInsights/stable/2024-04-01/openapi.json#L68:11 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L588:11 |
|
| The new version has a different format '' than the previous one 'AutoRest.Swagger.Model.Schema'. New: HealthInsights/stable/2024-04-01/openapi.json#L2736:9 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4431:9 |
|
| The read only property has changed from 'false' to 'true'. New: HealthInsights/stable/2024-04-01/openapi.json#L2736:9 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4431:9 |
|
| The new version is missing a property found in the old version. Was 'createdDateTime' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L2722:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4430:7 |
|
| The new version is missing a property found in the old version. Was 'expirationDateTime' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L2722:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4430:7 |
|
| The new version is missing a property found in the old version. Was 'lastUpdateDateTime' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L2722:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L4430:7 |
|
| The new version is missing a property found in the old version. Was 'dateTime' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L1974:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L3140:7 |
|
| The new version is missing a property found in the old version. Was 'effectiveDateTime' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L2010:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L3174:7 |
|
| The new version is missing a property found in the old version. Was 'createdDateTime' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L2395:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L3882:7 |
|
| The new version is missing a property found in the old version. Was 'info' renamed or removed? New: HealthInsights/stable/2024-04-01/openapi.json#L2470:7 Old: HealthInsights/preview/2023-09-01-preview/openapi.json#L3983:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-04-01 | package-2024-04-01(7343a0d) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| OperationId for put method should contain both 'Create' and 'Update' Location: HealthInsights/stable/2024-04-01/openapi.json#L126 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| 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/stable/2024-04-01/openapi.json#L988 |
|
| 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/stable/2024-04-01/openapi.json#L1195 |
|
| 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/stable/2024-04-01/openapi.json#L1316 |
|
| 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/stable/2024-04-01/openapi.json#L1965 |
|
| 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/stable/2024-04-01/openapi.json#L1992 |
|
| 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/stable/2024-04-01/openapi.json#L2028 |
|
| 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/stable/2024-04-01/openapi.json#L2032 |
|
| 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/stable/2024-04-01/openapi.json#L2036 |
|
| 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/stable/2024-04-01/openapi.json#L2040 |
|
| 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/stable/2024-04-01/openapi.json#L2067 |
|
| 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/stable/2024-04-01/openapi.json#L2071 |
|
| 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/stable/2024-04-01/openapi.json#L2075 |
|
| 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/stable/2024-04-01/openapi.json#L2782 |
|
| 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/stable/2024-04-01/openapi.json#L2787 |
️️✔️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.
️️✔️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
|
Generated ApiView
|
AzureRestAPISpecReview
added
CI-MissingBaseCommit
data-plane
new-api-version
TypeSpec
|
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. |
This was referenced Feb 1, 2024
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
…specs into asaflevi/healthinsights-radiologyinsights-api-v3
mikekistler
approved these changes
Apr 1, 2024
Thank you @mikekistler |
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
/pr RequestMerge |
specification/ai/HealthInsights/HealthInsights.Common/model.common.request.tsp
Outdated
Show resolved
Hide resolved
specification/ai/HealthInsights/HealthInsights.Common/model.common.response.tsp
Outdated
Show resolved
Hide resolved
specification/ai/HealthInsights/HealthInsights.Common/model.common.shared.tsp
Outdated
Show resolved
Hide resolved
specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp
Outdated
Show resolved
Hide resolved
specification/ai/HealthInsights/HealthInsights.Common/primitives.tsp
Outdated
Show resolved
Hide resolved
specification/ai/HealthInsights/HealthInsights.RadiologyInsights/route.radiologyinsights.tsp
Show resolved
Hide resolved
specification/ai/HealthInsights/HealthInsights.RadiologyInsights/model.radiologyinsights.tsp
Show resolved
Hide resolved
|
@mikekistler Is there anything we need to complete? |
|
This API was reviewed in the internal repo: https://github.com/Azure/azure-rest-api-specs-pr/issues/12510 The conclusion there was:
I've confirmed that all the requested changes have been adopting, so adding the signedOff label. |
mikekistler
added
the
APIStewardshipBoard-SignedOff
catalinaperalta
approved these changes
Apr 4, 2024
mikeharder
added a commit
that referenced
this pull request
Apr 4, 2024
- Introduced in #27614 - Check TSV was not re-run after TSP was updated in main
wiboris
pushed a commit
to wiboris/azure-rest-api-specs
that referenced
this pull request
May 7, 2024
…API V3 (Radiology Insights) (Azure#27614) * V3 - remove OncoPhenotype, TrialMatcher, PatientTimeline interfaces * update readme file * remove client.tsp from all models except RadiologyInsights * Revert "remove client.tsp from all models except RadiologyInsights" This reverts commit b238f6f. * revert and return client.tsp files * remove version dependency, also remove all other models except RI * Fix: request example * prettier * remove model RadiologyInsightsResult * remove deprecated operation templates * move imports to main.tsp * add imports to rout.radiologyinsights * revert - remove imports from rout file * rename patientInfo * add expand trait * update example with details property * add imports to rout.radiologyinsights * fix: API Stewardship board review comments * fix: tsv * prettier * communication.communicatedAt , recommendation.effectiveAt * expand format csv * comments * fix: tsv * remove unused client.tsp * update spec * python package version * spread extensions * remove retry-after from put operation * Update specification/ai/data-plane/HealthInsights/readme.md Co-authored-by: Praven Kuttappan <[email protected]> * Update specification/ai/data-plane/HealthInsights/readme.md Co-authored-by: Praven Kuttappan <[email protected]> * Update specification/ai/data-plane/HealthInsights/readme.md Co-authored-by: Praven Kuttappan <[email protected]> * Update specification/ai/data-plane/HealthInsights/readme.md Co-authored-by: Praven Kuttappan <[email protected]> * update readme package version * add x-ms-request-id to default error response * fix: tsv * use Azure.Core.ExpandQueryParameter * fix: tsv * order procedure spread extendible * fix: tsv * remove tspconfig files from Onco,PTL,CTM * update openapi.json * fix: PUT/GET same schema * fix: PR comments * alias retry after traits * revert interface rout(radiology-insights) --------- Co-authored-by: Praven Kuttappan <[email protected]>
wiboris
pushed a commit
to wiboris/azure-rest-api-specs
that referenced
this pull request
May 7, 2024
- Introduced in Azure#27614 - Check TSV was not re-run after TSP was updated in main
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Health Insights just released to Public Jan 2024.
This API version will focus on Radiology Insights feature only as a stable API version.
Based on : #27223
Is this review for (select one):
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.
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 ApiViewcomment 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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
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.