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.

Sign up for GitHub

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

Jump to bottom

x-ms-identifiers alternatives #1983

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

x-ms-identifiers alternatives #1983

wants to merge 17 commits into from

Conversation

AlitzelMendez
Copy link
Member

issue: #1473

@azure-sdk
Copy link
Collaborator

azure-sdk commented Dec 12, 2024 •
edited
Loading

All changed packages have been documented.

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

@azure-tools/typespec-autorest - feature ✏️

Use the @Identifiers decorator to identify and utilize identifiers for x-ms-identifiers. Additionally, use the @key decorator to identify identifiers.

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

Use the @Identifiers decorator to identify and utilize identifiers for x-ms-identifiers. Additionally, use the @key decorator to identify identifiers.

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@AlitzelMendez AlitzelMendez changed the title [WIP] x-ms-identifiers alternatives x-ms-identifiers alternatives Dec 17, 2024
@AlitzelMendez AlitzelMendez marked this pull request as ready for review December 17, 2024 17:46
markcowl
markcowl requested changes Dec 17, 2024
View reviewed changes
Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

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

A few changes - there is a subtlety that 'name' and 'id' properties remove the need for x-ms-identifiers.

Also, should have an up-to-date PR showing the changes this creates in azure-rest-api-specs repos

...re/core/data-plane/api-path-parameter/@azure-tools/typespec-autorest/2022-08-31/openapi.json Outdated Show resolved Hide resolved
...re/core/data-plane/api-path-parameter/@azure-tools/typespec-autorest/2022-08-31/openapi.json Outdated Show resolved Hide resolved
packages/typespec-autorest/src/openapi.ts Outdated Show resolved Hide resolved
packages/typespec-azure-resource-manager/src/rules/missing-x-ms-identifiers.ts Show resolved Hide resolved
packages/typespec-azure-resource-manager/src/resource.ts Show resolved Hide resolved
packages/typespec-azure-resource-manager/src/resource.ts Show resolved Hide resolved
packages/typespec-azure-resource-manager/src/lib.ts Outdated Show resolved Hide resolved
packages/typespec-azure-resource-manager/README.md Show resolved Hide resolved
packages/typespec-autorest/test/openapi-output.test.ts Show resolved Hide resolved
@AlitzelMendez AlitzelMendez linked an issue Jan 6, 2025 that may be closed by this pull request
x-ms-identifiers alternative #1473
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markcowl markcowl markcowl requested changes

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@allenjzhang allenjzhang Awaiting requested review from allenjzhang allenjzhang is a code owner

@timotheeguerin timotheeguerin Awaiting requested review from timotheeguerin timotheeguerin is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

x-ms-identifiers alternative
3 participants
@AlitzelMendez @azure-sdk @markcowl