[test delete link] Update healthcare-apis.json #3265
Closed
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
[suppression test] add suppression file for pr service link
add python config
This reverts commit 8aad719.
Next Steps to mergeNext steps that must be taken to merge this PR:
|
Swagger Generation Artifacts
|
Generated ApiView
|
Swagger Validation Report
|
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| healthcare-apis.json | 2024-03-01(4af7c0c) | 2024-03-01(main) |
| Rule | Message |
|---|---|
|
The new version is missing an operation that was found in the old version. Was operationId 'Services_CreateOrUpdate' removed or restructured? New: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L37:5 Old: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L37:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-03 | package-2024-03(4af7c0c) | package-2024-03(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The tracked resource ServicesDescription does not have a corresponding put operation. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L2460 |
RPC-Put-V1-22 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L37 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L81 |
|
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L106 |
|
The async patch operation should return 202. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L116 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L126 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L158 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L167 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L299 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L323 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L344 |
|
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L388 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'PrivateEndpointConnections_CreateOrUpdate' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L388 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L388 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L430 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L441 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L468 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L477 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L489 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L490 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L513 |
|
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L531 |
|
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L531 |
|
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L661 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L702 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L750 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L759 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L806 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L815 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L820 |
|
A 202 response should include an Location response header. Location: Microsoft.HealthcareApis/stable/2024-03-01/healthcare-apis.json#L850 |
️️✔️~[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The example JSON file is not referenced from the swagger file. readme: specification/healthcareapis/resource-manager/readme.md json: 2024-03-01/examples/legacy/ServiceCreate.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/healthcareapis/resource-manager/readme.md json: 2024-03-01/examples/legacy/ServiceCreateInDataSovereignRegionWithCmkEnabled.json |
|
The example JSON file is not referenced from the swagger file. readme: specification/healthcareapis/resource-manager/readme.md json: 2024-03-01/examples/legacy/ServiceCreateMinimum.json |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
|
Please address or respond to feedback from the ARM API reviewer. |
|
/azp run |
Swagger Validation Report
|
This was referenced Apr 8, 2024
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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
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
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.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.