azure-rest-api-specs
azure-rest-api-specs copied to clipboard
swagger changes for cloudservice new get calls
ARM (Control Plane) API Specification Update Pull Request
Purpose of this PR
This PR contains a new api defined using the Extension Resource design to support Get calls on Cloud Service networking resources. Design Doc Link
Swagger changes in private branch What's the purpose of this PR? Check all that apply. This is mandatory!
- [x] new service onboarding
- [ ] New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
- [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
- [ ] Update existing version to fix swagger quality issues in S360.
- [ ] Other, please clarify:
- edit this with your clarification
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:
- [x] I have reviewed the general guidance on the spec PR review process: https://aka.ms/specprreview.
- [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data-plane related specifications.
- [x] I commit to follow the Breaking Change Policy.
- [x] I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can request review from an ARM API Review board.
ARM API changes review
- If you want for the ARM team to review this PR, you must add the
ARMReviewlabel. - The automation may automatically add the
ARMReviewlabel, if appropriate.
If this happens, proceed according to guidance given in GitHub comments also added by the automation.
Breaking change review
If you have any breaking changes as defined in the Breaking Change Policy, follow the process outlined in the High-level Breaking Change Process doc.
Getting help
- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
- For additional help, see https://aka.ms/azsdk/support/spectools.
Hi, @sharufbaig! Thank you for your pull request. To help get your PR merged:
Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| network.json | 2023-04-01(6e9b269) | 2023-02-01(main) |
| network.json | 2023-04-01(6e9b269) | 2022-06-01-preview(main) |
️⚠️LintDiff: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(6e9b269) | package-2023-04(release-network-Microsoft.Network-official-2023-04-01-2) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.Network/stable/2023-04-01/network.json#L301 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Network/stable/2023-04-01/network.json#L321 |
XmsParameterLocation |
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Network/stable/2023-04-01/network.json#L410 |
XmsParameterLocation |
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Network/stable/2023-04-01/network.json#L417 |
XmsParameterLocation |
The parameter 'ApiVersionVmssParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Network/stable/2023-04-01/network.json#L424 |
| :warning: LocationMustHaveXmsMutability | Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.Network/stable/2023-04-01/network.json#L156 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Please ignore, experimental check succeeded [Detail] [Expand]
Validation passes for 'Please ignore, experimental check'.
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️SDK Breaking Change Tracking warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-net-track2 failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️⚠️ azure-sdk-for-java warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-go failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️🔄 azure-resource-manager-schemas inProgress [Detail]
️❌ azure-powershell failed [Detail]
Only 0 items are rendered, please refer to log for more details.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Java | azure-resourcemanager-network-generated | https://apiview.dev/Assemblies/Review/e11390fef60f46f09831f65dfce98ec1 |
| JavaScript | @azure/arm-network | https://apiview.dev/Assemblies/Review/4b2756b1705b4cdca49ae7911146290d |
Hi @sharufbaig! Your PR has some issues. Please fix the CI issues, if present, in following order: Avocado, SemanticValidation, ModelValidation, Breaking Change, LintDiff.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic Validation | Fix-SemanticValidation-Error | High |
| Model Validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | High |
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel.
Hi @sharufbaig could you please set the priority to merge this PR by 7/12? As we will complete on 7/13.
[like] Sharuf Baig reacted to your message:
From: Joanna-Yang-Art @.> Sent: Wednesday, July 12, 2023 12:21:36 AM To: Azure/azure-rest-api-specs @.> Cc: Sharuf Baig @.>; Mention @.> Subject: Re: [Azure/azure-rest-api-specs] swagger changes for cloudservice new get calls (PR #24726)
Hi @sharufbaighttps://github.com/sharufbaig could you please set the priority to merge this PR by 7/12? As we will complete on 7/13
— Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-rest-api-specs/pull/24726#issuecomment-1631673537, or unsubscribehttps://github.com/notifications/unsubscribe-auth/A5K2AU4PP7J4A4JXGYOP2ELXPXUZBANCNFSM6AAAAAA2BRTNXU. You are receiving this because you were mentioned.Message ID: @.***>
We need the same swagger specs as cloudServiceNetworkInterface and cloudServicePublicIpAddress for the newly defined properties cloudServiceNetworkInterfaceList and clouServicePublicIpAddressList but the lintdiff asks for ResourceNameRestriction which was not defined earlier. @rkmanda so can i ignore that validation?
Hi @Joanna-Yang-Art i am waiting for reviews. ill complete as soon as i get it reviewd
Hi @rkmanda : Could you please review the changes? Thanks!!
@sharufbaig could you merge the PR? We are going to complete the release by 3 pm today
Can you please fix the newly introduced lintdiff errors : https://github.com/Azure/azure-rest-api-specs/pull/24726/checks?check_run_id=14968875680
/azp run
Azure Pipelines successfully started running 1 pipeline(s).
/azp run
No commit pushedDate could be found for PR 24726 in repo Azure/azure-rest-api-specs
Hi @sharufbaig, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.