[Hub Generated] Review request for Microsoft.NotificationHubs to add version stable/2023-09-01 #25060
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
…w/2023-01-01-preview to version 2023-09-01
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| notificationhubs.json | 2023-09-01(bc6233a) | 2017-04-01(main) |
| notificationhubs.json | 2023-09-01(bc6233a) | 2023-01-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version does not support 'application/json' as a request body format. Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L12:3 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L316:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L547:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L594:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L645:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1037:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1263:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/listKeys' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1317:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys' removed or restructured? Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1375:5 |
|
The new version is missing a definition that was found in the old version. Was 'NamespaceCreateOrUpdateParameters' removed or renamed? New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1879:3 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1494:3 |
|
The new version is missing a definition that was found in the old version. Was 'SharedAccessAuthorizationRuleCreateOrUpdateParameters' removed or renamed? New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1879:3 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1494:3 |
|
The new version is missing a definition that was found in the old version. Was 'PolicykeyResource' removed or renamed? New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1879:3 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1494:3 |
|
The new version is missing a definition that was found in the old version. Was 'NotificationHubCreateOrUpdateParameters' removed or renamed? New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1879:3 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1494:3 |
|
The new version is missing a definition that was found in the old version. Was 'DebugSendParameters' removed or renamed? New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1879:3 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L1494:3 |
|
The operation id has been changed from 'Namespaces_Patch' to 'Namespaces_Update'. This will impact generated code. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L938:7 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L173:7 |
|
The operation id has been changed from 'NotificationHubs_Patch' to 'NotificationHubs_Update'. This will impact generated code. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L181:7 Old: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json#L823:7 |
|
The new version adds a response code 'default'. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L815:11 |
|
The new version adds a response code 'default'. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L860:11 |
|
The new version adds a response code 'default'. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L921:11 |
|
The new version adds a response code 'default'. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L980:11 |
|
The new version adds a response code 'default'. New: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1023:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-09 | package-2023-09(bc6233a) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The 'subscriptionId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L886 |
RPC-Put-V1-05 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'NotificationHubs' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L19 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1533 |
|
Top level property names should not be repeated inside the properties bag for ARM resource 'NamespaceResource'. Properties [properties.name] conflict with ARM top level properties. Please rename these. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2601 |
|
Top level property names should not be repeated inside the properties bag for ARM resource 'NotificationHubResource'. Properties [properties.name] conflict with ARM top level properties. Please rename these. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2761 |
|
Tracked resource 'SharedAccessAuthorizationRuleResource' must have patch operation that at least supports the update of tags. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L3375 |
| OperationId should contain the verb: 'checknamespaceavailability' in:'Namespaces_CheckAvailability'. Consider updating the operationId Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L784 |
|
| 'PUT' operation 'PrivateEndpointConnections_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L1560 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2120 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2131 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2149 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2418 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2519 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2524 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json#L2796 |
️❌Avocado: 9 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/AuthorizationRules/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/AuthorizationRules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/AuthorizationRules/{}/listKeys is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/notificationHubs/{}/AuthorizationRules/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/notificationHubs/{}/AuthorizationRules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/notificationHubs/{}/AuthorizationRules/{}/listKeys is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/AuthorizationRules/{}/regenerateKeys is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NotificationHubs/namespaces/{}/notificationHubs/{}/AuthorizationRules/{}/regenerateKeys is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/notificationhubs/resource-manager/readme.md json: Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.NotificationHubs' for api version '2023-09-01'. The supported api-versions are '2014-09-01, 2016-03-01, 2017-04-01, 2020-01-01-preview'." |
️⚠️~[NotRequired_Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️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.
️️✔️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).
️️✔️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.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
|
Hi, @kmiecikt! 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 Generation Artifacts
|
Generated ApiView
|
This was referenced Jul 31, 2023
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @kmiecikt! The automation detected breaking changes in this pull request. As a result, it added the |
This was referenced Jul 31, 2023
AzureRestAPISpecReview
added
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
|
Hi @kmiecikt! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
|
Breaking changes previously reviewed and approved in #24072 |
mikekistler
added
the
Approved-BreakingChange
|
@rkmanda: the stable version in this PR is exactly the same as already-approved API version The linter / Avocado errors are either reported for previous versions (not updated in the PR), or also appeared in the previous PR and cannot be fixed without adding breaking changes. We will update the RP manifest next week. Is there any other action needed? |
Next Steps to Merge |
|
Please fix the |
ms-henglu
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
The Swagger Avocado errors & warnings are incorrect - they are reported for older API version and files that did not change in this Pull Request. The remaining LintDiff errors cannot be fixed without introducing breaking changes. The same set of errors was already approved in the PR for |
kmiecikt
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
LintDiff previously reviewed and approved in #24072 |
ms-henglu
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
Alancere
added
the
Approved-SdkBreakingChange-Go
|
this js sdk breaking is caused by base apiversion not this one. |
|
Hi @rkmanda. Is there any other approval we need before completing the PR? |
|
Hi @kmiecikt , please get the following errors fixed or approved. ❌ Swagger Avocado |
Hi @ms-henglu. The Swagger Avocado errors are false positives - they are reported for files from previous version, not changes in this PR (please take a look at comments above). How can we approve the Python breaking changes? It was approved for version '2023-01-01-preview`, which is exactly the same as the stable one we try to add now. |
|
Here's the list of sdk breakign changes and other checks approvers. |
|
Approved for python sdk breaking: |
|
All reported errors / warnings were approved. Is there anything else we have to do before completing this PR? |
Please get the Avocado error approved label, you could find the contact from the list. |
mentat9
approved these changes
Sep 6, 2023
mentat9
deleted the
kmiecikt-notificationhubs-Microsoft.NotificationHubs-2023-09-01
branch
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
…version stable/2023-09-01 (#25060) * Adds base for updating Microsoft.NotificationHubs from version preview/2023-01-01-preview to version 2023-09-01 * Updates readme * Updates API version in new specs and examples
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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.
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 request review from an ARM API Review board.
ARM API changes review
ARMReviewlabel.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
and https://aka.ms/ci-fix.