Skip to content

[Hub Generated] Review request for Microsoft.NotificationHubs to add version preview/2023-10-01-preview#26443

Merged
raosuhas merged 6 commits into
mainfrom
jessHuh-notificationhubs-Microsoft.NotificationHubs-2023-10-01-preview-fcm
Nov 22, 2023
Merged

[Hub Generated] Review request for Microsoft.NotificationHubs to add version preview/2023-10-01-preview#26443
raosuhas merged 6 commits into
mainfrom
jessHuh-notificationhubs-Microsoft.NotificationHubs-2023-10-01-preview-fcm

Conversation

@jessHuh
Copy link
Copy Markdown
Contributor

@jessHuh jessHuh commented Oct 27, 2023 •
edited
Loading

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.

diagram

[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!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • 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:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Oct 27, 2023 •
edited
Loading

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).

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Oct 27, 2023 •
edited
Loading

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
notificationhubs.json 2023-10-01-preview(8a1deb5) 2023-09-01(main)
notificationhubs.json 2023-10-01-preview(8a1deb5) 2023-01-01-preview(main)
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2023-10 package-preview-2023-10(8a1deb5) default(main)

The following errors/warnings exist before current PR submission:

Rule Message
❌ OperationIdNounVerb 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/preview/2023-10-01-preview/notificationhubs.json#L19
❌ RepeatedPathInfo The 'subscriptionId' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json#L886
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json#L1533
❌ ArmResourcePropertiesBag 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/preview/2023-10-01-preview/notificationhubs.json#L2659
❌ ArmResourcePropertiesBag 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/preview/2023-10-01-preview/notificationhubs.json#L2822
❌ TrackedResourcePatchOperation Tracked resource 'SharedAccessAuthorizationRuleResource' must have patch operation that at least supports the update of tags.
Location: Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json#L3439
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'checknamespaceavailability' in:'Namespaces_CheckAvailability'. Consider updating the operationId
Location: Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json#L784
⚠️ PutInOperationName '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/preview/2023-10-01-preview/notificationhubs.json#L1560
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json#L2120
⚠️ EnumInsteadOfBoolean 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/preview/2023-10-01-preview/notificationhubs.json#L2131
⚠️ EnumInsteadOfBoolean 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/preview/2023-10-01-preview/notificationhubs.json#L2149
⚠️ EnumInsteadOfBoolean 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/preview/2023-10-01-preview/notificationhubs.json#L2476
⚠️ EnumInsteadOfBoolean 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/preview/2023-10-01-preview/notificationhubs.json#L2577
⚠️ EnumInsteadOfBoolean 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/preview/2023-10-01-preview/notificationhubs.json#L2582
⚠️ EnumInsteadOfBoolean 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/preview/2023-10-01-preview/notificationhubs.json#L2857
️️✔️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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Oct 27, 2023 •
edited
Loading

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌SDK Breaking Change Tracking failed [Detail]

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 succeeded [Detail] [Expand]

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 warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Oct 27, 2023 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/notificationhubs/armnotificationhubs https://apiview.dev/Assemblies/Review/0aaa24bdd8e6426b8bfad6fe15f71500
Java azure-resourcemanager-notificationhubs https://apiview.dev/Assemblies/Review/b62d6c4190cf4c6b9853a9e3547df4ad
JavaScript @azure/arm-notificationhubs https://apiview.dev/Assemblies/Review/c7d30e5077554836941bfdc0d8ae0a7b
Swagger Microsoft.NotificationHubs https://apiview.dev/Assemblies/Review/0258132539734136b90b1646b33c2530

This was referenced Oct 27, 2023
Draft
Closed
@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version resource-manager labels Oct 27, 2023
@azure-sdk azure-sdk mentioned this pull request Oct 27, 2023
Closed
@azure-sdk azure-sdk mentioned this pull request Oct 27, 2023
Closed
This was referenced Oct 27, 2023
Closed
Closed
@jessHuh
Copy link
Copy Markdown
Contributor Author

jessHuh commented Oct 27, 2023

/azp run unifiedPipeline

@azure-pipelines
Copy link
Copy Markdown

azure-pipelines Bot commented Oct 27, 2023

No pipelines are associated with this pull request.

@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 27, 2023
@jessHuh jessHuh marked this pull request as ready for review October 27, 2023 22:58
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 27, 2023
@rkmanda
Copy link
Copy Markdown
Member

rkmanda commented Oct 31, 2023 

      "description": "Not used and deprecated since API version 2023-01-01-preview",

pl provide an explanation why this is being changed

Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:2132 in 8a1deb5. [](commit_id = 8a1deb5, deletion_comment = False)

@rkmanda
Copy link
Copy Markdown
Member

rkmanda commented Oct 31, 2023 

      }

should this be an enum?

Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:2420 in 8a1deb5. [](commit_id = 8a1deb5, deletion_comment = False)

@rkmanda
Copy link
Copy Markdown
Member

rkmanda commented Oct 31, 2023 

      },

should this be an enum?

Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:2467 in 8a1deb5. [](commit_id = 8a1deb5, deletion_comment = False)

@openapi-workflow-bot
Copy link
Copy Markdown

openapi-workflow-bot Bot commented Oct 31, 2023

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@openapi-workflow-bot openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 31, 2023
@kmiecikt
Copy link
Copy Markdown
Contributor

kmiecikt commented Nov 8, 2023 

      "description": "Not used and deprecated since API version 2023-01-01-preview",

pl provide an explanation why this is being changed

Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:2132 in 8a1deb5. [](commit_id = 8a1deb5, deletion_comment = False)

We changed the description already in the previous API version.
This input parameter was never recognized by our service, and was added back in 2017 by mistake. Because removing it would be a breaking change, and the previous API version had already too many changes, for now we just updated the description and we will start the formal ARM deprecation process in one of the new API versions.

@jessHuh
Copy link
Copy Markdown
Contributor Author

jessHuh commented Nov 8, 2023

Please address or respond to feedback from the ARM API reviewer. When you are ready to continue the ARM API review, please remove the ARMChangesRequested label. This will notify the reviewer to have another look. If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel. Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

We are following Azure Monitor schema managed by Shoebox manifest team.
https://msazure.visualstudio.com/One/_git/AzureUX-Insights-MonRP?path=/src/Core/Provider/Shoebox/Manifest/schema.json&version=GBdev&line=202&lineEnd=203&lineStartColumn=1&lineEndColumn=1&lineStyle=plain&_a=contents

 "supportedTimeGrainTypes": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "$comment": "Allowed time grain: 1 min, 5 min, 15 min, 30 min, 1 hour, 6 hour, 12 hour, 1 day"
              },

This is the Shoebox manifest team's schema which we need to apply: https://msazure.visualstudio.com/One/_git/AzureUX-Insights-MonRP?path=%2Fsrc%2FCore%2FProvider%2FShoebox%2FManifest%2Fschema.json&version=GBdev&_a=contents
schema.json - Repos (visualstudio.com)

@jessHuh
Copy link
Copy Markdown
Contributor Author

jessHuh commented Nov 8, 2023 

      }

should this be an enum?

Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:2420 in 8a1deb5. [](commit_id = 8a1deb5, deletion_comment = False)

We are following Azure Monitor schema managed by Shoebox manifest team.
https://msazure.visualstudio.com/One/_git/AzureUX-Insights-MonRP?path=/src/Core/Provider/Shoebox/Manifest/schema.json&version=GBdev&line=433&lineEnd=434&lineStartColumn=1&lineEndColumn=1&lineStyle=plain&_a=contents

"categoryGroups": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "$comment": "Log category groups(tags), such as default, all, security etc.,"
              }

This is the Shoebox manifest team's schema which we need to apply: https://msazure.visualstudio.com/One/_git/AzureUX-Insights-MonRP?path=%2Fsrc%2FCore%2FProvider%2FShoebox%2FManifest%2Fschema.json&version=GBdev&_a=contents
schema.json - Repos (visualstudio.com)

@openapi-workflow-bot openapi-workflow-bot Bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2023
@zizw123
Copy link
Copy Markdown

zizw123 commented Nov 8, 2023 

      "description": "Not used and deprecated since API version 2023-01-01-preview",

pl provide an explanation why this is being changed
Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:2132 in 8a1deb5. [](commit_id = 8a1deb5, deletion_comment = False)

We changed the description already in the previous API version. This input parameter was never recognized by our service, and was added back in 2017 by mistake. Because removing it would be a breaking change, and the previous API version had already too many changes, for now we just updated the description and we will start the formal ARM deprecation process in one of the new API versions.

In theory this description will not need to be changed right? Why updating API version also requires changing when this was deprecated?

@zizw123
Copy link
Copy Markdown

zizw123 commented Nov 8, 2023

non-blocking comment, sign off the PR, and you can fix the description if needed

@zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 8, 2023
@openapi-workflow-bot openapi-workflow-bot Bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2023
@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 14, 2023
@jessHuh
Copy link
Copy Markdown
Contributor Author

jessHuh commented Nov 22, 2023

/pr RequestMerge

@raosuhas raosuhas merged commit 21467ec into main Nov 22, 2023
@raosuhas raosuhas deleted the jessHuh-notificationhubs-Microsoft.NotificationHubs-2023-10-01-preview-fcm branch November 22, 2023 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@raosuhas raosuhas raosuhas approved these changes

Assignees

@rkmanda rkmanda

Labels

Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@jessHuh @rkmanda @kmiecikt @zizw123 @raosuhas @Alancere @AzureRestAPISpecReview @msyyc @kazrael2119