Skip to content

Make request bodies optional #2674

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

Merged
merged 10 commits into from
May 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .chronus/changes/opt-body-2025-4-12-19-18-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: feature
packages:
- "@azure-tools/typespec-azure-resource-manager"
---

Allow optional request bodies in Resource actions templates
2 changes: 1 addition & 1 deletion core
Submodule core updated 322 files
2 changes: 1 addition & 1 deletion packages/azure-http-specs/spec-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ Expected response body:

### Azure_Core_Basic_createOrUpdate

- Endpoint: `get /azure/core/basic`
- Endpoint: `patch /azure/core/basic`

Should only generate models named User and UserOrder.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import "@typespec/rest";
import "@typespec/http";
import "@azure-tools/typespec-azure-resource-manager";
import "@typespec/versioning";

using Azure.ResourceManager;
using Versioning;
using Http;

@armProviderNamespace
@versioned(Versions)
namespace Microsoft.OptionalBody;
interface Operations extends Azure.ResourceManager.Operations {}

enum Versions {
@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1)
@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5)
`2025-01-01-preview`,
}
/** The resource-specific properties of a Widget */
model WidgetProperties {
/** Required property */
property1: string;

/** optional Property */
property2: int32;

...DefaultProvisioningStateProperty;
}

model Widget is TrackedResource<WidgetProperties> {
...ResourceNameParameter<Widget>;
}

@armResourceOperations
interface Widgets {
get is ArmResourceRead<Widget>;
createOrReplace is ArmResourceCreateOrReplaceAsync<Widget>;
update is Azure.ResourceManager.Legacy.CustomPatchAsync<
Widget,
Foundations.ResourceUpdateModel<Widget, WidgetProperties>,
RequestBody = {
/** The PATCH request body */
@body body?: Foundations.ResourceUpdateModel<Widget, WidgetProperties>;
}
>;
delete is ArmResourceDeleteWithoutOkAsync<Widget>;
list is ArmResourceListByParent<Widget>;
}
Loading
Loading