Convert Notificationhubs Swagger to Tsp #34320
Open
+8,003
−2,400
Conversation
This file contains hidden or 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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
|
AzureRestAPISpecReview
added
resource-manager
TypeSpec
This was referenced Apr 29, 2025
…into Convert-Notificationhubs
…n/azure-rest-api-specs into Convert-Notificationhubs
…n/azure-rest-api-specs into Convert-Notificationhubs
…n/azure-rest-api-specs into Convert-Notificationhubs
pshao25
added
Versioning-Approved-Benign
AzureRestAPISpecReview
added
the
WaitForARMFeedback
| */ | ||
| @visibility(Lifecycle.Read) | ||
| // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. | ||
| createdTime?: utcDateTime; |
There was a problem hiding this comment.
what was the original documented format?
| */ | ||
| @visibility(Lifecycle.Read) | ||
| privateLinkServiceArmRegion?: string; | ||
| } |
There was a problem hiding this comment.
[ARMBlockingComment] possible antipattern documenting internal private link contracts as if external?
This comment suggests its an internal API contract, in which case it shouldn't even be documented here should it?
/**
- Represents a connectivity information to Notification Hubs namespace. This is part of PrivateLinkService proxy that tell
- the Networking RP how to connect to the Notification Hubs namespace.
*/
|
|
||
| /** | ||
| * A customer-visible sub-resource of Private Endpoint, which describe the connection between Private Endpoint and Notification Hubs namespace. | ||
| */ |
There was a problem hiding this comment.
customer-visible ? that should go without saying, in the public API doc!
| } | ||
|
|
||
| /** | ||
| * Result of the request to list SQL operations. |
| /** | ||
| * Result of the request to list SQL operations. | ||
| */ | ||
| model Operation { |
| model OperationListResult is Azure.Core.Page<Operation>; | ||
|
|
||
| #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" | ||
| model OperationDisplay { |
| * ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. | ||
| */ | ||
| @visibility(Lifecycle.Read) | ||
| id?: string; |
| /** | ||
| * Private Endpoint Connection properties. | ||
| */ | ||
| model PrivateEndpointConnectionProperties { |
| * Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace. | ||
| */ | ||
| @parentResource(NamespaceResource) | ||
| model PrivateEndpointConnectionResource |
|
|
||
| namespace Microsoft.NotificationHubs; | ||
| /** | ||
| * A Private Link Arm Resource. |
| @armResourceOperations | ||
| interface PrivateLinkResources { | ||
| /** | ||
| * Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. |
| getGroupId is ArmResourceRead<PrivateLinkResource>; | ||
|
|
||
| /** | ||
| * Even though this namespace requires subscription id, resource group and namespace name, it returns a constant payload (for a given namespacE) every time it's called. |
Whats a SID? Are sids or package ids actually secrets? I'm a little confused about this, and just want some explanation or sanity check Refers to: specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/preview/2023-10-01-preview/notificationhubs.json:4028 in 1273ec6. [](commit_id = 1273ec6, deletion_comment = False) |
TimLovellSmith
added
the
ARMChangesRequested
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
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 PR migrates your latest version (identified by the tag in your readme.md) of swagger to TypeSpec. We already tried our best to make sure the TypeSpec represents same as previous swagger. Since we lack the business knowledge, please validate this PR again to make sure it's functional equivalent as before. The local validation step is at Getting started | TypeSpec Azure
Besides, TypeSpec encourages to follow ARM guidelines. Therefore, some representations in your previous swagger will be fixed to follow these guidelines. When you see differences in your local validation, please keep this note in mind.
Please reach out to TypeSpec Discussions Channel if there is any help needed.