-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Service Fabric Managed Clusters - API version 2023-11-01-preview #26178
Conversation
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
managedapplication.json | 2023-11-01-preview(7542520) | 2022-01-01(main) |
managedapplication.json | 2023-11-01-preview(7542520) | 2023-09-01-preview(main) |
managedcluster.json | 2023-11-01-preview(7542520) | 2022-01-01(main) |
managedcluster.json | 2023-11-01-preview(7542520) | 2023-09-01-preview(main) |
nodetype.json | 2023-11-01-preview(7542520) | 2022-01-01(main) |
nodetype.json | 2023-11-01-preview(7542520) | 2023-09-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 10 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-11-preview | package-2023-11-preview(7542520) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutResponseCodes |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L82 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L189 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L223 |
ProvisioningStateSpecifiedForLROPut |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L335 |
PutResponseCodes |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L335 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L468 |
ProvisioningStateSpecifiedForLROPut |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L808 |
PutResponseCodes |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L808 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L908 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L938 |
ProvisioningStateSpecifiedForLROPut |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L1094 |
PutResponseCodes |
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.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L1094 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L1230 |
SystemDataDefinitionsCommonTypes |
System data references must utilize common types. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json#L2063 |
ProvisioningStateSpecifiedForLROPut |
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.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L162 |
PutResponseCodes |
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.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L162 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L287 |
GetCollectionResponseSchema |
The response in the GET collection operation 'ManagedClusterVersion_List' does not match the response definition in the individual GET operation 'ManagedClusterVersion_Get' . Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L561 |
GetCollectionResponseSchema |
The response in the GET collection operation 'ManagedClusterVersion_ListByEnvironment' does not match the response definition in the individual GET operation 'ManagedClusterVersion_GetByEnvironment' . Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L601 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L777 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L807 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L816 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L854 |
SystemDataDefinitionsCommonTypes |
System data references must utilize common types. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/managedcluster.json#L2154 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json#L84 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json#L154 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json#L227 |
ProvisioningStateSpecifiedForLROPut |
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.ServiceFabric/preview/2023-11-01-preview/nodetype.json#L390 |
PutResponseCodes |
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.ServiceFabric/preview/2023-11-01-preview/nodetype.json#L390 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.ServiceFabric/preview/2023-11-01-preview/nodetype.json#L542 |
️️✔️
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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
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
|
Hi @a-santamaria! 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. |
Please address or respond to feedback from the ARM API reviewer. |
for LintDiff error with have a work item to fix it this semester https://msazure.visualstudio.com/One/_workitems/edit/24841215 . but its going to take some time because we generate the swagger from an internal repo that currently cant reference the common types.
Breaking Change(Cross-Version): Those are changes we already got approval in older versions. non are introduced in this new api |
Please add a suppression for the lint diff errors and provide a link to the work item in the description of the suppression |
same for all other places. In reply to: 1772094825 Refers to: specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json:1433 in 732e562. [](commit_id = 732e562, deletion_comment = False) |
Pl explain why you cannot define a concrete type for the property In reply to: 1772106615 Refers to: specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/managedapplication.json:1433 in 732e562. [](commit_id = 732e562, deletion_comment = False) |
I see many more properties using additionalProperties. My comment was for all such instances not just this one. Please either provide an exaplanation for why these cannot be concrete types or remove them. |
managedapplication, managedcluster and nodetype all are showing up as newly added json files so its unclear to me what the new changes are. |
Please come to one of our office hours and we can review this together instead of the back and forth. Either that or please follow the comment on how to create a PR for a new version that make the review easy |
f5c4dfe
to
7542520
Compare
@rkmanda, please take a look at this commit 7542520. I squashed all the commits that address comments in this pr so its easy to see the changes compared to the old api |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
) * remove default on eviction type * copy from 2023-09-01-preview * update specs with version 2023-11-01-preview --------- Co-authored-by: Alfredo Santamaria Gomez <[email protected]>
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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 ApiView
comment 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.
Getting help
and https://aka.ms/ci-fix.