Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Azure AI - Health Insights] - Typespec revision for Health Insights API Version 2 #27223

Merged
merged 44 commits into from
Jan 31, 2024

tspconfig

9e1bfd7
Select commit
Loading
Failed to load commit list.
Merged

[Azure AI - Health Insights] - Typespec revision for Health Insights API Version 2 #27223

tspconfig
9e1bfd7
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Breaking Change(Cross-Version) succeeded Jan 31, 2024 in 9m 31s

Breaking Change(Cross-Version) succeeded

CrossVersionBreakingChange
View Azure DevOps build log for more details.

Important

To see the full list of breaking change messages, with all the details available:
In the relevant ADO build (see the link above), find the job CrossVersionBreakingChange, then the task within, also called CrossVersionBreakingChange.
In the task's build log, search for Full list of messages.

Details

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 have been detected in comparison to the latest stable version

No breaking changes detected in this comparison.

The following breaking changes have been detected in comparison to the latest preview version

⚠️ 1005 - RemovedPath

Displaying 4 out of 4 occurrences.

Index Description
1 The new version is missing a path that was found in the old version. Was path '/oncophenotype/jobs' removed or restructured?
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L58:5
2 The new version is missing a path that was found in the old version. Was path '/oncophenotype/jobs/{jobId}' removed or restructured?
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L152:5
3 The new version is missing a path that was found in the old version. Was path '/trialmatcher/jobs' removed or restructured?
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L200:5
4 The new version is missing a path that was found in the old version. Was path '/trialmatcher/jobs/{jobId}' removed or restructured?
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L294:5

⚠️ 1017 - ReferenceRedirection

Displaying 2 out of 2 occurrences.

Index Description
1 The '$ref' property points to different models in the old and new versions.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L1414:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1070:11
2 The '$ref' property points to different models in the old and new versions.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3947:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1690:11

⚠️ 1019 - RemovedEnumValue

Displaying 5 out of 5 occurrences.

Index Description
1 The new version is removing enum value(s) 'imaging, pathology' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3887:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1645:9
2 The new version is removing enum value(s) 'imaging, pathology' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L967:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L555:5
3 The new version is removing enum value(s) 'partiallyCompleted' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3445:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1349:5
4 The new version is removing enum value(s) 'partiallyCompleted' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3821:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1588:9
5 The new version is removing enum value(s) 'partiallyCompleted' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4829:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1936:9

⚠️ 1025 - RequiredStatusChange

Displaying 3 out of 3 occurrences.

Index Description
1 The 'required' status changed from the old version('True') to the new version('False').
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
2 The 'required' status changed from the old version('True') to the new version('False').
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3815:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1564:7
3 The 'required' status changed from the old version('True') to the new version('False').
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4823:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1912:7

⚠️ 1032 - DifferentAllOf

Displaying 1 out of 1 occurrences.

Index Description
1 The new version has a different 'allOf' property than the previous one.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L1414:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1070:11

⚠️ 1033 - RemovedProperty

Displaying 17 out of 17 occurrences.

Index Description
1 The new version is missing a property found in the old version. Was 'code' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3020:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L532:7
2 The new version is missing a property found in the old version. Was 'data' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3983:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1727:7
3 The new version is missing a property found in the old version. Was 'demographics' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
4 The new version is missing a property found in the old version. Was 'eligibilityCriteriaText' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
5 The new version is missing a property found in the old version. Was 'errors' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3815:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1564:7
6 The new version is missing a property found in the old version. Was 'errors' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4823:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1912:7
7 The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3793:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1542:7
8 The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4655:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1772:7
9 The new version is missing a property found in the old version. Was 'id' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4797:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1887:7
10 The new version is missing a property found in the old version. Was 'jobId' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3815:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1564:7
11 The new version is missing a property found in the old version. Was 'jobId' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4823:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1912:7
12 The new version is missing a property found in the old version. Was 'metadata' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
13 The new version is missing a property found in the old version. Was 'name' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3020:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L532:7
14 The new version is missing a property found in the old version. Was 'results' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3815:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1564:7
15 The new version is missing a property found in the old version. Was 'results' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4823:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1912:7
16 The new version is missing a property found in the old version. Was 'system' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3020:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L532:7
17 The new version is missing a property found in the old version. Was 'value' renamed or removed?
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3020:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L532:7

⚠️ 1034 - AddedRequiredProperty

Displaying 13 out of 13 occurrences.

Index Description
1 The new version has new required property 'id' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3812:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1561:5
2 The new version has new required property 'id' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3815:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1564:7
3 The new version has new required property 'id' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4820:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1909:5
4 The new version has new required property 'id' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4823:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1912:7
5 The new version has new required property 'patientId' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3790:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1539:5
6 The new version has new required property 'patientId' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3793:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1542:7
7 The new version has new required property 'patientId' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4794:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1884:5
8 The new version has new required property 'patientId' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4797:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1887:7
9 The new version has new required property 'resourceType' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
10 The new version has new required property 'resourceType' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3020:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L532:7
11 The new version has new required property 'resourceType' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3947:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1690:11
12 The new version has new required property 'status, resourceType' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L1414:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1070:11
13 The new version has new required property 'status' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7

⚠️ 1036 - ConstraintChanged

Displaying 1 out of 1 occurrences.

Index Description
1 The new version has a different 'minLength' value than the previous one.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3025:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L683:9

💬 1020 - AddedEnumValue

Displaying 8 out of 8 occurrences.

Index Description
1 The new version is adding enum value(s) 'canceled' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3445:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1349:5
2 The new version is adding enum value(s) 'canceled' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3821:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1588:9
3 The new version is adding enum value(s) 'canceled' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L4829:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1936:9
4 The new version is adding enum value(s) 'diagnosisDate' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3646:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1422:9
5 The new version is adding enum value(s) 'diagnosisDate' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3705:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1459:5
6 The new version is adding enum value(s) 'diagnosisDate' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3779:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1528:11
7 The new version is adding enum value(s) 'radiologyReport, pathologyReport' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3887:9
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1645:9
8 The new version is adding enum value(s) 'radiologyReport, pathologyReport' from the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L967:5
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L555:5

💬 1021 - AddedAdditionalProperties

Displaying 1 out of 1 occurrences.

Index Description
1 The new version adds an 'additionalProperties' element.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L3947:11
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L1690:11

💬 1038 - AddedPath

Displaying 8 out of 8 occurrences.

Index Description
1 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L198:5
2 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L253:5
3 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L387:5
4 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L442:5
5 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L576:5
6 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L631:5
7 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L64:5
8 The new version is adding a path that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L765:5

💬 1045 - AddedOptionalProperty

Displaying 29 out of 29 occurrences.

Index Description
1 The new version has a new optional property 'arm' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
2 The new version has a new optional property 'category' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
3 The new version has a new optional property 'condition' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
4 The new version has a new optional property 'contact' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
5 The new version has a new optional property 'contained' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
6 The new version has a new optional property 'description' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
7 The new version has a new optional property 'enrollment' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
8 The new version has a new optional property 'extension' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
9 The new version has a new optional property 'focus' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
10 The new version has a new optional property 'identifier' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
11 The new version has a new optional property 'implicitRules' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
12 The new version has a new optional property 'keyword' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
13 The new version has a new optional property 'language' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
14 The new version has a new optional property 'location' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
15 The new version has a new optional property 'meta' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
16 The new version has a new optional property 'modifierExtension' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
17 The new version has a new optional property 'note' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
18 The new version has a new optional property 'objective' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
19 The new version has a new optional property 'partOf' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
20 The new version has a new optional property 'period' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
21 The new version has a new optional property 'phase' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
22 The new version has a new optional property 'primaryPurposeType' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
23 The new version has a new optional property 'principalInvestigator' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
24 The new version has a new optional property 'protocol' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
25 The new version has a new optional property 'reasonStopped' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
26 The new version has a new optional property 'site' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
27 The new version has a new optional property 'sponsor' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
28 The new version has a new optional property 'text' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7
29 The new version has a new optional property 'title' that was not found in the old version.
New: HealthInsights/preview/2023-09-01-preview/openapi.json#L2761:7
Old: HealthInsights/preview/2023-03-01-preview/openapi.json#L682:7