Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix common-types specification differences with azure-rest-api-specs #2250

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

AlitzelMendez
Copy link
Member

@AlitzelMendez AlitzelMendez commented Feb 23, 2025

I will be probably doing a similar pr like this next sprint as there are still couple of differences that I am working trough, but this is some of the feedback provided in: Azure/azure-rest-api-specs#32562

TODO: Validate azure-rest-api-specs

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 23, 2025

All changed packages have been documented.

  • @azure-tools/typespec-azure-resource-manager
Show changes

@azure-tools/typespec-azure-resource-manager - fix ✏️

Addressing common type differences with common types in azure-rest-api-specs, such as ordering of elements, lower/upper case in definition names, typos, and incorrect format on the next link.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 23, 2025

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@AlitzelMendez
Copy link
Member Author

AlitzelMendez commented Feb 24, 2025

@markcowl markcowl self-assigned this Mar 6, 2025
@@ -6,34 +6,6 @@
},
"paths": {},
"definitions": {
"CustomerManagedKeyEncryption": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not convinced we want to make these changes to capitalization fo schema for a few reasons:

  • They have no impact on the API on the wire, they only impact swagger references
  • Clients should always use their own naming schemes for their particular language when naming common-types

I would want to see a compelling reason for capitalization-only changes in schema names

@@ -6,8 +6,8 @@ namespace Azure.ResourceManager;
alias InfrastructureEncryption = CommonTypes.InfrastructureEncryption;
alias KeyEncryptionIdentity = CommonTypes.KeyEncryptionKeyIdentity;
alias KeyEncryptionKeyIdentity = CommonTypes.KeyEncryptionKeyIdentity;
alias CustomerManagedKeyEncryption = CommonTypes.CustomerManagedKeyEncryption;
alias EncryptionConfiguration = CommonTypes.Encryption;
alias CustomerManagedKeyEncryption = CommonTypes.customerManagedKeyEncryption;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just reiterating the comment above. This is perpetuating a bug that does not impact the wire API

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants