[Service Bus] - Adding status code 202 to Private endpoints PUT #19125
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
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
rkmanda
added
the
WaitForARMFeedback
|
/azp run |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L442:11 |
️⚠️LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
| Rule | Message |
|---|---|
| The operation 'PrivateEndpointConnections_CreateOrUpdate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L389 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Missing identifier id in array item property Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L941 |
| Since operation 'PrivateLinkResources_Get' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L558 |
|
| The operation 'Namespaces_Update' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L281 |
|
| Based on the response model schema, operation 'PrivateLinkResources_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L554 |
|
| The child tracked resource, 'privateEndpointConnections' with immediate parent 'SBNamespace', must have a list by immediate parent operation. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L989 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneRedundant Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L740 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L759 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L830 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: requireInfrastructureEncryption Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L961 |
|
| 'groupId' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L1118 |
|
| 'userAssignedIdentityProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L1154 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: NameSpaceCreate Location: Microsoft.ServiceBus/preview/2022-01-01-preview/namespace-preview.json#L346 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
Hi @v-Ajnava, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced May 19, 2022
JeffreyRichter
added
the
Approved-BreakingChange
raosuhas
reviewed
Jun 8, 2022
| "schema": { | ||
| "$ref": "#/definitions/PrivateEndpointConnection" | ||
| } | ||
| }, |
There was a problem hiding this comment.
PUTs should not be returning 202s. Why do you need to make this change in existing API ? :
Please read through the details here :
https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#creating-or-updating-resources-asynchronously
There was a problem hiding this comment.
@raosuhas , we have made this change in a previous api version as well in this PR #19155 and no questions were raised. The reason we made this change is that otherwise it renders out CreateOrUpdate command useless since it majorly returns 202. And it would be difficult to work on a service side fix for this now. We have already released the fix in 2021-11-01 SDK, please allow it in 2022-01-01-preview as well. Thank you.
|
Please remove "ARMCHangesRequested" label when this PR is ready to be looked at again by ARM reviewers |
raosuhas
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
damodaravadhani
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
ruowan
removed
the
WaitForARMFeedback
ruowan
approved these changes
Jul 13, 2022
This was referenced Jul 13, 2022
ruowan
added a commit
that referenced
this pull request
Jul 13, 2022
25 tasks
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.