@azure-tools/typespec-azure-resource-manager 0.49.0-dev.3 → 0.49.0-dev.5

package/README.md

@@ -51,7 +51,7 @@ Available ruleSets:
 | `@azure-tools/typespec-azure-resource-manager/improper-subscription-list-operation`                                                                                                                      | Tenant and Extension resources should not define a list by subscription operation.                                                                                                                                                                   |
 | [`@azure-tools/typespec-azure-resource-manager/lro-location-header`](https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/lro-location-header)                             | A 202 response should include a Location response header.                                                                                                                                                                                            |
 | [`@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers`](https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/missing-x-ms-identifiers)                   | Array properties should describe their identifying properties with x-ms-identifiers. Decorate the property with @OpenAPI.extension("x-ms-identifiers", [id-prop]) where "id-prop" is a list of the names of identifying properties in the item type. |
-| `@azure-tools/typespec-azure-resource-manager/no-response-body`                                                                                                                                          | The body of 202 response should be empty.                                                                                                                                                                                                            |
+| [`@azure-tools/typespec-azure-resource-manager/no-response-body`](https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/no-response-body)                                   | Check that the body is empty for 202 and 204 responses, and not empty for other success (2xx) responses.                                                                                                                                             |
 | `@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint`                                                                                                                               | Check for missing Operations interface.                                                                                                                                                                                                              |
 | `@azure-tools/typespec-azure-resource-manager/patch-envelope`                                                                                                                                            | Patch envelope properties should match the resource properties.                                                                                                                                                                                      |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-patch`                                                                                                                                        | Validate ARM PATCH operations.                                                                                                                                                                                                                       |

package/dist/src/rules/no-response-body.d.ts

@@ -1,7 +1,10 @@
 /**
- * verify an operation returns 202 should not contains response body.
+ * verify that 202 or 204 responses do not contain a response body.
+ * verify that success (2XX) responses other than 202 and 204 contain a response body.
  */
 export declare const noResponseBodyRule: import("@typespec/compiler").LinterRuleDefinition<"no-response-body", {
-    readonly default: "The body of 202 response should be empty.";
+    readonly default: "The body of responses with success (2xx) status codes other than 202 and 204 should not be empty.";
+    readonly shouldBeEmpty202: "The body of 202 response should be empty.";
+    readonly shouldBeEmpty204: "The body of 204 response should be empty.";
 }>;
 //# sourceMappingURL=no-response-body.d.ts.map

package/dist/src/rules/no-response-body.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-response-body.d.ts","sourceRoot":"","sources":["../../../src/rules/no-response-body.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,eAAO,MAAM,kBAAkB;;EAwB7B,CAAC"}
+{"version":3,"file":"no-response-body.d.ts","sourceRoot":"","sources":["../../../src/rules/no-response-body.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;EA+C7B,CAAC"}

package/dist/src/rules/no-response-body.js

@@ -1,30 +1,53 @@
 import { createRule } from "@typespec/compiler";
-import { getResponsesForOperation } from "@typespec/http";
+import { getHttpOperation, getResponsesForOperation } from "@typespec/http";
 import { isTemplatedInterfaceOperation } from "./utils.js";
 /**
- * verify an operation returns 202 should not contains response body.
+ * verify that 202 or 204 responses do not contain a response body.
+ * verify that success (2XX) responses other than 202 and 204 contain a response body.
  */
 export const noResponseBodyRule = createRule({
     name: "no-response-body",
+    description: "Check that the body is empty for 202 and 204 responses, and not empty for other success (2xx) responses.",
+    url: "https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/no-response-body",
     severity: "warning",
-    description: `The body of 202 response should be empty.`,
     messages: {
-        default: `The body of 202 response should be empty.`,
+        default: `The body of responses with success (2xx) status codes other than 202 and 204 should not be empty.`,
+        shouldBeEmpty202: `The body of 202 response should be empty.`,
+        shouldBeEmpty204: `The body of 204 response should be empty.`,
     },
     create(context) {
         return {
             operation: (op) => {
-                if (isTemplatedInterfaceOperation(op)) {
+                const [httpOperation] = getHttpOperation(context.program, op);
+                if (isTemplatedInterfaceOperation(op) || httpOperation.verb === "head")
                     return;
+                const responses = getResponsesForOperation(context.program, op)[0].find((v) => v.statusCodes !== 204 && v.statusCodes !== 202);
+                if (responses && !responses.responses.every((v) => v.body)) {
+                    if (["delete", "post"].includes(httpOperation.verb) && responses.statusCodes === 200) {
+                        return;
+                    }
+                    context.reportDiagnostic({
+                        target: op,
+                    });
+                }
+                if (hasResponseBodyForCode(202, getResponsesForOperation(context.program, op)[0])) {
+                    context.reportDiagnostic({
+                        target: op,
+                        messageId: "shouldBeEmpty202",
+                    });
                 }
-                const responses = getResponsesForOperation(context.program, op)[0].find((v) => v.statusCodes === 202);
-                if (responses && responses.responses.some((v) => v.body)) {
+                if (hasResponseBodyForCode(204, getResponsesForOperation(context.program, op)[0])) {
                     context.reportDiagnostic({
                         target: op,
+                        messageId: "shouldBeEmpty204",
                     });
                 }
             },
         };
     },
 });
+function hasResponseBodyForCode(statusCode, operations) {
+    const response = operations.find((v) => v.statusCodes === statusCode);
+    return !!(response && response.responses.some((v) => v.body));
+}
 //# sourceMappingURL=no-response-body.js.map

package/dist/src/rules/no-response-body.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-response-body.js","sourceRoot":"","sources":["../../../src/rules/no-response-body.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,6BAA6B,EAAE,MAAM,YAAY,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IAC3C,IAAI,EAAE,kBAAkB;IACxB,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,2CAA2C;IACxD,QAAQ,EAAE;QACR,OAAO,EAAE,2CAA2C;KACrD;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,SAAS,EAAE,CAAC,EAAa,EAAE,EAAE;gBAC3B,IAAI,6BAA6B,CAAC,EAAE,CAAC,EAAE,CAAC;oBACtC,OAAO;gBACT,CAAC;gBACD,MAAM,SAAS,GAAG,wBAAwB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CACrE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,GAAG,CAC7B,CAAC;gBACF,IAAI,SAAS,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzD,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,EAAE;qBACX,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
+{"version":3,"file":"no-response-body.js","sourceRoot":"","sources":["../../../src/rules/no-response-body.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAa,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAyB,MAAM,gBAAgB,CAAC;AACnG,OAAO,EAAE,6BAA6B,EAAE,MAAM,YAAY,CAAC;AAC3D;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IAC3C,IAAI,EAAE,kBAAkB;IACxB,WAAW,EACT,0GAA0G;IAC5G,GAAG,EAAE,qGAAqG;IAC1G,QAAQ,EAAE,SAAS;IACnB,QAAQ,EAAE;QACR,OAAO,EAAE,mGAAmG;QAC5G,gBAAgB,EAAE,2CAA2C;QAC7D,gBAAgB,EAAE,2CAA2C;KAC9D;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,SAAS,EAAE,CAAC,EAAa,EAAE,EAAE;gBAC3B,MAAM,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;gBAC9D,IAAI,6BAA6B,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,MAAM;oBAAE,OAAO;gBAE/E,MAAM,SAAS,GAAG,wBAAwB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CACrE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,GAAG,IAAI,CAAC,CAAC,WAAW,KAAK,GAAG,CACtD,CAAC;gBAEF,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC3D,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,WAAW,KAAK,GAAG,EAAE,CAAC;wBACrF,OAAO;oBACT,CAAC;oBAED,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,EAAE;qBACX,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,sBAAsB,CAAC,GAAG,EAAE,wBAAwB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClF,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,EAAE;wBACV,SAAS,EAAE,kBAAkB;qBAC9B,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,sBAAsB,CAAC,GAAG,EAAE,wBAAwB,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAClF,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,EAAE;wBACV,SAAS,EAAE,kBAAkB;qBAC9B,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,sBAAsB,CAAC,UAAkB,EAAE,UAAmC;IACrF,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,UAAU,CAAC,CAAC;IACtE,OAAO,CAAC,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAChE,CAAC"}

package/lib/common-types/customer-managed-keys.tsp

@@ -37,11 +37,7 @@ model KeyEncryptionKeyIdentity {
   identityType?: KeyEncryptionKeyIdentityType;
 
   /** User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. */
-  userAssignedIdentityResourceId?: Azure.Core.armResourceIdentifier<[
-    {
-      type: "Microsoft.ManagedIdentity/userAssignedIdentities";
-    }
-  ]>;
+  userAssignedIdentityResourceId?: Azure.Core.armResourceIdentifier;
 
   /** application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 */
   @added(Versions.v5)
@@ -70,6 +66,5 @@ model Encryption {
 
   /** All Customer-managed key encryption properties for the resource. */
   @added(Versions.v4)
-  @removed(Versions.v5)
   customerManagedKeyEncryption?: CustomerManagedKeyEncryption;
 }

package/lib/common-types/network-security-perimeter.tsp

@@ -245,12 +245,12 @@ model NetworkSecurityPerimeterConfigurationListResult {
  * @template Segment The resource type name for network security perimeter configuration (default is networkSecurityPerimeterConfigurations)
  */
 @added(Versions.v5)
-model NetworkSecurityPerimeterConfigurationNameParameter<Segment extends valueof string = "networkSecurityPerimeterConfigurations"> {
+model NetworkSecurityPerimeterConfigurationNameParameter {
   /** The name for a network security perimeter configuration */
   @path
   @minLength(1)
   @maxLength(512)
-  @TypeSpec.Rest.segment(Segment)
+  @TypeSpec.Rest.segment("networkSecurityPerimeterConfigurations")
   @key("networkSecurityPerimeterConfigurationName")
-  name: string;
+  networkSecurityPerimeterConfigurationName: string;
 }

package/lib/common-types/private-links.tsp

@@ -11,11 +11,7 @@ model PrivateEndpoint {
   /** The resource identifier for private endpoint */
   @visibility("read")
   @typeChangedFrom(CommonTypes.Versions.v4, string)
-  id?: Azure.Core.armResourceIdentifier<[
-    {
-      type: "Microsoft.Network/privateEndpoints";
-    }
-  ]>;
+  id?: Azure.Core.armResourceIdentifier;
 }
 
 /** A private link resource. */
@@ -131,13 +127,12 @@ union PrivateEndpointServiceConnectionStatus {
 
 /**
  * The name of the private endpoint connection associated with the Azure resource.
- * @template Segment The resource type name for private endpoint connections (default is privateEndpointConnections)
  */
-model PrivateEndpointConnectionParameter<Segment extends valueof string = "privateEndpointConnections"> {
+model PrivateEndpointConnectionParameter {
   /** The name of the private endpoint connection associated with the Azure resource. */
   @path
-  @TypeSpec.Rest.segment(Segment)
   @key("privateEndpointConnectionName")
+  @TypeSpec.Rest.segment("privateEndpointConnections")
   name: string;
 }
 

package/lib/common-types/types.tsp

@@ -73,6 +73,7 @@ model ResourceModelWithAllowedPropertySet extends TrackedResource {
   /** The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention.
    * Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19),
    * If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. */
+  @visibility("read")
   eTag?: string;
 
   @typeChangedFrom(Versions.v6, Identity)
@@ -142,7 +143,6 @@ model Operation {
   isDataAction?: boolean;
 
   /** Localized display information for this particular operation. */
-  @visibility("read")
   display?: OperationDisplay;
 
   /** 
@@ -154,6 +154,7 @@ model Operation {
   /** 
     Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
      */
+  @visibility("read")
   actionType?: ActionType;
 }
 
@@ -189,7 +190,8 @@ model OperationDisplay {
  */
 model OperationStatusResult {
   /** Fully qualified ID for the async operation. */
-  id?: string;
+  @typeChangedFrom(Versions.v5, string)
+  id?: armResourceIdentifier;
 
   /** Name of the async operation. */
   name?: string;
@@ -213,6 +215,12 @@ model OperationStatusResult {
 
   /** If present, details of the operation error. */
   error?: ErrorDetail;
+
+  /** Fully qualified ID of the resource against which the original async operation was started. */
+  @visibility("read")
+  @format("arm-id")
+  @added(Versions.v5)
+  resourceId?: string;
 }
 
 /**
@@ -549,7 +557,7 @@ model ScopeParameter {
 }
 
 /**
- * The default ManagementGroupName parameter type.
+ * The default TenantIdParameter type.
  */
 @added(Versions.v4)
 model TenantIdParameter {
@@ -563,6 +571,7 @@ model TenantIdParameter {
  * The default ARM If-Match header type.
  */
 @added(Versions.v4)
+@friendlyName("If-Match")
 model IfMatchHeader {
   /** The If-Match header that makes a request conditional. */
   @header("If-Match")
@@ -570,9 +579,10 @@ model IfMatchHeader {
 }
 
 /**
- * The default ARM If-Match header type.
+ * The default ARM If-None-Match header type.
  */
 @added(Versions.v4)
+@friendlyName("If-None-Match")
 model IfNoneMatchHeader {
   /** The If-None-Match header that makes a request conditional. */
   @header("If-None-Match")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.49.0-dev.3",
+  "version": "0.49.0-dev.5",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",