-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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-09-01-preview #25779
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 |
---|---|---|
nodetype.json | 2023-07-01-preview(dc827af) | 2023-07-01-preview(main) |
Rule | Message |
---|---|
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L961:9 Old: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L962:9 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L604:5 Old: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L604:5 |
️❌
Breaking Change(Cross-Version): 17 Errors, 4 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
managedapplication.json | 2023-09-01-preview(dc827af) | 2022-01-01(main) |
managedapplication.json | 2023-09-01-preview(dc827af) | 2023-07-01-preview(main) |
managedcluster.json | 2023-09-01-preview(dc827af) | 2022-01-01(main) |
managedcluster.json | 2023-09-01-preview(dc827af) | 2023-07-01-preview(main) |
nodetype.json | 2023-09-01-preview(dc827af) | 2022-01-01(main) |
nodetype.json | 2023-09-01-preview(dc827af) | 2023-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version has a different format than the previous one. New: Microsoft.ServiceFabric/preview/2023-09-01-preview/nodetype.json#L665:9 Old: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L634:9 |
|
The new version has a different format than the previous one. New: Microsoft.ServiceFabric/preview/2023-09-01-preview/nodetype.json#L670:9 Old: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L638:9 |
|
The new version has a different default value than the previous one. New: Microsoft.ServiceFabric/preview/2023-09-01-preview/nodetype.json#L1114:9 Old: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L962:9 |
|
The new version has a different default value than the previous one. New: Microsoft.ServiceFabric/preview/2023-09-01-preview/nodetype.json#L636:5 Old: Microsoft.ServiceFabric/preview/2023-07-01-preview/nodetype.json#L604:5 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-2023-07-preview | package-2023-07-preview(dc827af) | package-2023-07-preview(main) |
package-2023-09-preview | package-2023-09-preview(dc827af) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
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-09-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-09-01-preview/managedcluster.json#L601 |
OperationId should contain the verb: 'getazresiliencystatus' in:'managedAzResiliencyStatus_Get'. Consider updating the operationId Location: Microsoft.ServiceFabric/preview/2023-09-01-preview/managedcluster.json#L353 |
|
OperationId should contain the verb: 'getmaintenancewindowstatus' in:'managedMaintenanceWindowStatus_Get'. Consider updating the operationId Location: Microsoft.ServiceFabric/preview/2023-09-01-preview/managedcluster.json#L396 |
|
OperationId should contain the verb: 'applymaintenancewindow' in:'managedApplyMaintenanceWindow_Post'. Consider updating the operationId Location: Microsoft.ServiceFabric/preview/2023-09-01-preview/managedcluster.json#L439 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Maintenance Window Status Location: Microsoft.ServiceFabric/preview/2023-09-01-preview/managedcluster.json#L454 |
️️✔️
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
|
f280982
to
4b9057d
Compare
Please address or respond to feedback from the ARM API reviewer. |
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. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
This is not a valid path. To fetch the application status you could possibly use this URI "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/applications/{applicationName}/fetchUpgradeStatus" #Resolved Refers to: specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-09-01-preview/managedapplication.json:582 in 4b9057d. [](commit_id = 4b9057d, deletion_comment = False) |
/upgrade/ segment can be removed and action can be /rollbackUpgrade
#Resolved Refers to: specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-09-01-preview/managedapplication.json:582 in 4b9057d. [](commit_id = 4b9057d, deletion_comment = False) |
Please review all the post call paths #Resolved Refers to: specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-09-01-preview/managedapplication.json:682 in 4b9057d. [](commit_id = 4b9057d, deletion_comment = False) |
This is supposed to be List call. Also, the number of segments is more than what is allowed. You may need to model this differently to follow the standards. lso, this is violating the multiple levels of nested types in this URI #Resolved Refers to: specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-09-01-preview/managedapplication.json:1085 in 4b9057d. [](commit_id = 4b9057d, deletion_comment = False) |
...edclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-09-01-preview/nodetype.json
Show resolved
Hide resolved
...edclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-09-01-preview/nodetype.json
Show resolved
Hide resolved
Thanks for the review @sjanamma. Is it not valid because upgrade is not model as a resource? |
@sjanamma what is the allowed number of segments? and what do you mean by "violating the multiple levels of nested types in this URI" ? |
@sjanamma I have reverted app actions. We will add them in the next api because we will need changes on our service |
@rkmanda can you merge the pr please. its already signed off |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
@raosuhas and @a-santamaria hello, I'm having some issues with downstream tooling having consumed this update 👋 This version introduces two versions of the IP Tag definition - in This causes an issue because both types exist in the same namespace, but only vary by case. We use these type names to generate files, but dependant on the case-insensitivity of the filesystem, these two files then conflict with one another. Other versions of this specification only use the capitalized |
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.