Repository navigation
[SQL][DO NOT MERGE] Reader endpoint pre-fix ARM review comparison - #47529
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Thank you for your contribution rajashree012! We will review the pull request and get back to you soon. |
|
Azure Pipelines: Successfully started running 7 pipeline(s). 3 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Next Steps to MergeNext steps that must be taken to merge this PR:
Important checks have failed. As of today they are not blocking this PR, but in near future they may. Addressing the following failures is highly recommended:
Comment generated by summarize-checks workflow run. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
Comment generated by After APIView workflow run. |
|
/arm-review |
1 similar comment
|
/arm-review |
|
/arm-review |
ARM API reviewReviewed commit Approval labels observed: none. Blocking findings
All four findings are new at this head and were independently verified by Critic (PASS). No prior ARM findings or review threads required reconciliation. Finding 4 from the review analysis concerning new
|
| }, | ||
| "nextLink": { | ||
| "type": "string", | ||
| "description": "Link to retrieve the next page of results.", |
There was a problem hiding this comment.
Blocking — nextLink is not formatted as a URI. The generated list wrapper declares nextLink as a plain string. ARM list responses require nextLink to be URI-formatted; update the TypeSpec source so generation emits "format": "uri". See Section 13.1 — List API Must Follow ARM Contract. No applicable approval label was observed.
| } | ||
|
|
||
| /** Properties of a reader endpoint. */ | ||
| #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "The existing API exposes completion through Location polling, not a provisioningState property." |
There was a problem hiding this comment.
Blocking — missing provisioningState on an asynchronous resource. ReaderEndpoint supports asynchronous PUT/PATCH, but ReaderEndpointProperties omits the required read-only provisioningState. Please add the property with the required terminal states (Succeeded, Failed, Canceled) and remove the arm-resource-provisioning-state suppression. See RPC-Async-V1-02. No applicable approval label was observed.
| } | ||
|
|
||
| /** Properties of a reader endpoint. */ | ||
| #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "The existing API exposes completion through Location polling, not a provisioningState property." |
There was a problem hiding this comment.
Blocking — error-level rules are suppressed. This change adds suppressions for error rules including arm-resource-provisioning-state, arm-resource-invalid-envelope-property, and PUT/DELETE response-code validation (see also ReaderEndpointFeatureRegistration.tsp). Error-level rules must be fixed rather than suppressed; remove these suppressions and correct the underlying contracts. See TypeSpec suppression policy §4.1. No applicable approval label was observed.
| /** A list of reader endpoints. */ | ||
| @added(Versions.v2026_11_01_preview) | ||
| model ReaderEndpointListResult { | ||
| /** Array of results. */ |
There was a problem hiding this comment.
Blocking — list value must be required. ReaderEndpointListResult declares value as optional, and the generated schema consequently omits required: ["value"]. ARM list responses require a required array-valued value property. Make value required in the TypeSpec source. See Section 13.1 — List API Must Follow ARM Contract. No applicable approval label was observed.
|
rajashree012 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
Summary
This draft freezes the reader endpoint specifications at commit
d8ec3adb64c26a8731697a46ec3332e6b8f2fd26, before the F1-F11 review fixes in4842c335955cf4e694c5743acc30831c71682a29.The active implementation PR is #47504. This comparison PR deliberately retains the older
contracts and suppressions to measure which issues the automated ARM review detects.
It does not replace #47504 and is not intended for release or merging.
Target:
release-sql-Microsoft.Sql-2026-11-01-preview.Validation
Local validation of this exact snapshot passed TypeSpec compilation, repository TypeSpec
validation, generated-file reproducibility, Swagger semantic/example validation, and Avocado.
Local ARM lint detected contract issues, and eight TypeSpec suppressions require approval.
These results are not official ARM signoff or a full GitHub CI run.
Review procedure
An authorized reviewer with the required repository permissions should post
/arm-reviewon this PR. The review has not yet been triggered. Compare its findings with the original
review and the fixes in #47504, then close this temporary PR without merging.
Due diligence checklist
Additional information
Comparison only. Known contract issues are intentionally preserved. No deployment or release
readiness is asserted. Keep this PR in draft state.