Frederik/ri healthinsights typespec v4: added 3 models #29181
Merged
Conversation
This file contains hidden or 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
Frederik-Coppens
requested review from
marclerwick and
tg-msft
and removed request for
a team
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| openapi.json | 2024-10-01(c75677f) | 2024-04-01(main) |
| openapi.json | 2024-10-01(c75677f) | 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.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-10-01 | package-2024-10-01(c75677f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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-10-01/openapi.json#L2196 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| OperationId for put method should contain both 'Create' and 'Update' Location: HealthInsights/stable/2024-10-01/openapi.json#L141 |
|
| 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-10-01/openapi.json#L1021 |
|
| 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-10-01/openapi.json#L1228 |
|
| 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-10-01/openapi.json#L1349 |
|
| Schema should have a description or title. Location: HealthInsights/stable/2024-10-01/openapi.json#L1964 |
|
| Schema should have a description or title. Location: HealthInsights/stable/2024-10-01/openapi.json#L1968 |
|
| Schema should have a description or title. Location: HealthInsights/stable/2024-10-01/openapi.json#L1972 |
|
| 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-10-01/openapi.json#L1998 |
|
| 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-10-01/openapi.json#L2025 |
|
| 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-10-01/openapi.json#L2061 |
|
| 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-10-01/openapi.json#L2065 |
|
| 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-10-01/openapi.json#L2069 |
|
| 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-10-01/openapi.json#L2073 |
|
| 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-10-01/openapi.json#L2100 |
|
| 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-10-01/openapi.json#L2104 |
|
| 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-10-01/openapi.json#L2108 |
|
| 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-10-01/openapi.json#L3208 |
|
| 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-10-01/openapi.json#L3213 |
️️✔️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
data-plane
new-api-version
TypeSpec
This was referenced May 21, 2024
…dentation changes in cSpell.
…to the 3 new inferences
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
microsoft-github-policy-service
bot
added
no-recent-activity
…ub.com/Frederik-Coppens/azure-rest-api-specs into frederik/ri-healthinsights-typespec-v4
microsoft-github-policy-service
bot
added
the
no-recent-activity
asaflevi-ms
removed
the
no-recent-activity
microsoft-github-policy-service
bot
added
the
no-recent-activity
microsoft-github-policy-service
bot
removed
the
no-recent-activity
…ub.com/Frederik-Coppens/azure-rest-api-specs into frederik/ri-healthinsights-typespec-v4
microsoft-github-policy-service
bot
added
the
no-recent-activity
microsoft-github-policy-service
bot
removed
the
no-recent-activity
Frederik-Coppens
added
the
PublishToCustomers
pjpatel12
pushed a commit
to pjpatel12/azure-rest-api-specs
that referenced
this pull request
Apr 29, 2025
* Added 3 more typespec models * refactor: Update HealthInsights API specification * Changed date * Corrected spelling error in comment * Added some words that should not be marked "misspellings" by swagger spellcheck * Added text for the latest openapi version to readme; and just some indentation changes in cSpell. * Corrected mistake in file path * Replaced versions 2024-04-01 with 2024-10-01 * Replaced version of "current release" with latest version * Changed all old 09-31 versions to 10-01; and added "added"-decorator to the 3 new inferences * Some changes based on doc from Ann, mainly different @docs * Some more changes, deleted enum * Minor changes * Minor changes * No more type for guidance proposals * Some more changes, again enum for scoring and assessment category, and documention was adapted so that the previous version is the same again. * One more small documentation change for previous version * Small doc change * With new open api specs * MAde "presentGuidanceValues" optional, because it might not be filled if "sizes" or "maximumDiameterAsInText" is filled * More changes, agreed with Asaf and Gil * Replaced old version date with new one in more places * Added words to cSpell, solved one real spelling mistake * Corrected mistake, and regenerated open api spec * Changes after running "tsv"" * For sizes, changes an array of components to one Observation. And replaced field "extension" with "...Fihr.R4.Extendible". * Fix readme file * Changed readme files, but there some unexpected changes. * REmove '^' in version * Just removed "^" * Ran "npx prettier" for 2 files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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.
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
Getting help
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.fix #29204