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

no-response-body rule is triggering for some standard templates #1740

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

no-response-body rule is triggering for some standard templates #1740

wants to merge 17 commits into from
+190 −15

Conversation

AlitzelMendez
Copy link
Member

issue: #1552

@azure-sdk
Copy link
Collaborator

azure-sdk commented Oct 24, 2024 •
edited
Loading

All changed packages have been documented.

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

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

Update the arm no-response-body rule to behave similarly to the core rule, but with the additional requirement that the 202 response can and should also be empty

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

Update the arm no-response-body rule to behave similarly to the core rule, but with the additional requirement that the 202 response can and should also be empty

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@AlitzelMendez AlitzelMendez marked this pull request as ready for review October 25, 2024 18:03
markcowl
markcowl requested changes Oct 30, 2024
View reviewed changes
docs/libraries/azure-resource-manager/rules/no-response-body.md Outdated Show resolved Hide resolved
docs/libraries/azure-resource-manager/rules/no-response-body.md Outdated Show resolved Hide resolved
docs/libraries/azure-resource-manager/rules/no-response-body.md Outdated Show resolved Hide resolved
docs/libraries/azure-resource-manager/rules/no-response-body.md Outdated Show resolved Hide resolved
docs/libraries/azure-resource-manager/rules/no-response-body.md Outdated Show resolved Hide resolved
packages/typespec-azure-resource-manager/src/rules/utils.ts Outdated Show resolved Hide resolved
packages/typespec-azure-resource-manager/test/rules/no-response-body.test.ts Outdated Show resolved Hide resolved
packages/typespec-azure-resource-manager/test/rules/no-response-body.test.ts
@@ -24,6 +24,8 @@ describe("typespec-azure-resource-manager: no response body rule", () => {
await tester
.expect(
`
namespace Azure.MyService;
Copy link
Member

Choose a reason for hiding this comment

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

shouldn't this cause the rule not to execute?

packages/typespec-azure-resource-manager/test/rules/no-response-body.test.ts
await tester
.expect(
`
namespace Azure.MyService;
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't this cause the rule not to execute?

Copy link
Member Author

Choose a reason for hiding this comment

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

no, this is what makes the rule to execute, this rule is only executed on Azure namespaces, this is also the core rule for reference: https://github.com/Azure/typespec-azure/blob/main/packages/typespec-azure-core/src/rules/no-response-body.ts

Copy link
Member

@markcowl markcowl Oct 31, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Most ARM namespace start with Microsoft. Our namespaces in typespec-azure, like Azure.Core and Azure.ResourceManager start with Azure.

packages/typespec-azure-resource-manager/test/rules/no-response-body.test.ts
await tester
.expect(
`
namespace Azure.MyService;
Copy link
Member

Choose a reason for hiding this comment

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

same

@AlitzelMendez AlitzelMendez linked an issue Oct 31, 2024 that may be closed by this pull request
no-response-body rule is triggering for some standard templates #1552
Open
AlitzelMendez and others added 7 commits October 31, 2024 14:51
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.

no-response-body rule is triggering for some standard templates
3 participants
@AlitzelMendez @azure-sdk @markcowl