@azure-tools/typespec-azure-core 0.71.0-dev.4 → 0.71.0-dev.7

package/README.md

@@ -70,6 +70,7 @@ Available ruleSets:
 | [`@azure-tools/typespec-azure-core/no-legacy-usage`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-legacy-usage)                                                 | Linter warning against using elements from the Legacy namespace                                                                                      |
 | [`@azure-tools/typespec-azure-core/no-query-explode`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-query-explode)                                               | It is recommended to serialize query parameter without explode: true                                                                                 |
 | [`@azure-tools/typespec-azure-core/no-route-parameter-name-mismatch`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-route-parameter-name-mismatch)               | Ensure that operations with the same path use consistent path parameter names.                                                                       |
+| [`@azure-tools/typespec-azure-core/no-openapi-client-extensions`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-openapi-client-extensions)                       | Azure specs should not use @typespec/openapi @extension to emit client-altering x-ms-* extensions                                                    |
 
 ## Decorators
 

package/dist/src/linter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAuFA,eAAO,MAAM,OAAO,+CASlB,CAAC"}
+{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAyFA,eAAO,MAAM,OAAO,+CASlB,CAAC"}

package/dist/src/linter.js

@@ -18,6 +18,7 @@ import { noLegacyUsage } from "./rules/no-legacy-usage.js";
 import { noMultipleDiscriminatorRule } from "./rules/no-multiple-discriminator.js";
 import { noNullableRule } from "./rules/no-nullable.js";
 import { noOffsetDateTimeRule } from "./rules/no-offsetdatetime.js";
+import { noOpenapiClientExtensionsRule } from "./rules/no-openapi-client-extensions.js";
 import { noOpenAPIRule } from "./rules/no-openapi.js";
 import { noPrivateUsage } from "./rules/no-private-usage.js";
 import { noQueryExplodeRule } from "./rules/no-query-explode.js";
@@ -82,6 +83,7 @@ const rules = [
     noLegacyUsage,
     noQueryExplodeRule,
     noRouteParameterNameMismatchRule,
+    noOpenapiClientExtensionsRule,
 ];
 export const $linter = defineLinter({
     rules,

package/dist/src/linter.js.map

@@ -1 +1 @@
-{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4CAA4C,EAAE,MAAM,kCAAkC,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,gCAAgC,EAAE,MAAM,6CAA6C,CAAC;AAC/F,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iCAAiC,EAAE,MAAM,8CAA8C,CAAC;AACjG,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,MAAM,KAAK,GAAG;IACZ,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,QAAQ;IACR,UAAU;IACV,8BAA8B;IAC9B,iBAAiB;IACjB,4CAA4C;IAC5C,kBAAkB;IAClB,wBAAwB;IACxB,UAAU;IACV,sBAAsB;IACtB,2BAA2B;IAC3B,yBAAyB;IACzB,oBAAoB;IACpB,cAAc;IACd,oBAAoB;IACpB,kBAAkB;IAClB,mBAAmB;IACnB,aAAa;IACb,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;IACjB,2BAA2B;IAC3B,4BAA4B;IAC5B,kBAAkB;IAClB,iBAAiB;IACjB,oBAAoB;IACpB,oBAAoB;IACpB,iCAAiC;IACjC,2BAA2B;IAC3B,4BAA4B;IAC5B,gBAAgB;IAChB,qBAAqB;IACrB,yBAAyB;IACzB,oBAAoB;IACpB,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,kBAAkB;IAClB,gCAAgC;CACjC,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IAClC,KAAK;IACL,QAAQ,EAAE;QACR,sBAAsB,EAAE;YACtB,MAAM,EAAE;gBACN,CAAC,oCAAoC,yBAAyB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;aAC7E;SACF;KACF;CACF,CAAC,CAAC"}
+{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4CAA4C,EAAE,MAAM,kCAAkC,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAC;AACxF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,gCAAgC,EAAE,MAAM,6CAA6C,CAAC;AAC/F,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iCAAiC,EAAE,MAAM,8CAA8C,CAAC;AACjG,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,MAAM,KAAK,GAAG;IACZ,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,QAAQ;IACR,UAAU;IACV,8BAA8B;IAC9B,iBAAiB;IACjB,4CAA4C;IAC5C,kBAAkB;IAClB,wBAAwB;IACxB,UAAU;IACV,sBAAsB;IACtB,2BAA2B;IAC3B,yBAAyB;IACzB,oBAAoB;IACpB,cAAc;IACd,oBAAoB;IACpB,kBAAkB;IAClB,mBAAmB;IACnB,aAAa;IACb,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;IACjB,2BAA2B;IAC3B,4BAA4B;IAC5B,kBAAkB;IAClB,iBAAiB;IACjB,oBAAoB;IACpB,oBAAoB;IACpB,iCAAiC;IACjC,2BAA2B;IAC3B,4BAA4B;IAC5B,gBAAgB;IAChB,qBAAqB;IACrB,yBAAyB;IACzB,oBAAoB;IACpB,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,kBAAkB;IAClB,gCAAgC;IAChC,6BAA6B;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IAClC,KAAK;IACL,QAAQ,EAAE;QACR,sBAAsB,EAAE;YACtB,MAAM,EAAE;gBACN,CAAC,oCAAoC,yBAAyB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;aAC7E;SACF;KACF;CACF,CAAC,CAAC"}

package/dist/src/rules/no-openapi-client-extensions.d.ts

@@ -0,0 +1,4 @@
+export declare const noOpenapiClientExtensionsRule: import("@typespec/compiler").LinterRuleDefinition<"no-openapi-client-extensions", {
+    readonly default: import("@typespec/compiler").CallableMessage<["name"]>;
+}, Record<string, never>>;
+//# sourceMappingURL=no-openapi-client-extensions.d.ts.map

package/dist/src/rules/no-openapi-client-extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-openapi-client-extensions.d.ts","sourceRoot":"","sources":["../../../src/rules/no-openapi-client-extensions.ts"],"names":[],"mappings":"AAoCA,eAAO,MAAM,6BAA6B;;yBAyCxC,CAAC"}

package/dist/src/rules/no-openapi-client-extensions.js

@@ -0,0 +1,69 @@
+import { createRule, fileRef, getTypeName, paramMessage, } from "@typespec/compiler";
+/**
+ * OpenAPI (`x-ms-*` / `x-*`) extensions that alter how clients, SDKs, or the ARM
+ * platform interpret an API. Emitting them through the raw `@typespec/openapi`
+ * `@extension` decorator only affects the OpenAPI output, so non-OpenAPI emitters
+ * (client SDKs, service code, etc.) never see them and produce an incorrect
+ * representation of the API. Each of these has a first-class TypeSpec construct
+ * that should be used instead.
+ */
+const clientAlteringExtensions = new Set([
+    "x-ms-skip-url-encoding",
+    "x-ms-enum",
+    "x-ms-parameter-grouping",
+    "x-ms-parameter-location",
+    "x-ms-client-name",
+    "x-ms-discriminator-value",
+    "x-ms-client-flatten",
+    "x-ms-parameterized-host",
+    "x-ms-pageable",
+    "x-ms-long-running-operation",
+    "x-ms-long-running-operation-options",
+    "x-nullable",
+    "x-ms-internal",
+    "x-ms-azure-resource",
+    "x-ms-arm-id-details",
+    "x-ms-secret",
+]);
+export const noOpenapiClientExtensionsRule = createRule({
+    name: "no-openapi-client-extensions",
+    description: "Azure specs should not use @typespec/openapi @extension to emit client-altering x-ms-* extensions",
+    severity: "warning",
+    url: "https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-openapi-client-extensions",
+    docs: fileRef.fromPackageRoot("src/rules/no-openapi-client-extensions.md"),
+    messages: {
+        default: paramMessage `Do not use the @typespec/openapi @extension decorator to emit the client-altering "${"name"}" extension. It only affects the OpenAPI output, so client SDKs and other emitters will produce an incorrect representation of the API. Use the corresponding TypeSpec construct instead.`,
+    },
+    create(context) {
+        function checkDecorators(type) {
+            for (const dec of type.decorators) {
+                if (dec.definition?.name !== "@extension") {
+                    continue;
+                }
+                const namespace = getTypeName(dec.definition.namespace);
+                if (namespace !== "TypeSpec.OpenAPI") {
+                    continue;
+                }
+                const key = dec.args?.[0]?.jsValue;
+                if (typeof key === "string" && clientAlteringExtensions.has(key)) {
+                    context.reportDiagnostic({
+                        target: dec.node ?? type,
+                        format: { name: key },
+                    });
+                }
+            }
+        }
+        return {
+            model: checkDecorators,
+            modelProperty: checkDecorators,
+            enum: checkDecorators,
+            enumMember: checkDecorators,
+            union: checkDecorators,
+            unionVariant: checkDecorators,
+            operation: checkDecorators,
+            interface: checkDecorators,
+            namespace: checkDecorators,
+        };
+    },
+});
+//# sourceMappingURL=no-openapi-client-extensions.js.map

package/dist/src/rules/no-openapi-client-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-openapi-client-extensions.js","sourceRoot":"","sources":["../../../src/rules/no-openapi-client-extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EACV,OAAO,EACP,WAAW,EACX,YAAY,GACb,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;GAOG;AACH,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAS;IAC/C,wBAAwB;IACxB,WAAW;IACX,yBAAyB;IACzB,yBAAyB;IACzB,kBAAkB;IAClB,0BAA0B;IAC1B,qBAAqB;IACrB,yBAAyB;IACzB,eAAe;IACf,6BAA6B;IAC7B,qCAAqC;IACrC,YAAY;IACZ,eAAe;IACf,qBAAqB;IACrB,qBAAqB;IACrB,aAAa;CACd,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,UAAU,CAAC;IACtD,IAAI,EAAE,8BAA8B;IACpC,WAAW,EACT,mGAAmG;IACrG,QAAQ,EAAE,SAAS;IACnB,GAAG,EAAE,qGAAqG;IAC1G,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,2CAA2C,CAAC;IAC1E,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,sFAAsF,MAAM,2LAA2L;KAC7S;IACD,MAAM,CAAC,OAAO;QACZ,SAAS,eAAe,CAAC,IAA0B;YACjD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClC,IAAI,GAAG,CAAC,UAAU,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;oBAC1C,SAAS;gBACX,CAAC;gBACD,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACxD,IAAI,SAAS,KAAK,kBAAkB,EAAE,CAAC;oBACrC,SAAS;gBACX,CAAC;gBACD,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC;gBACnC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;oBACjE,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI;wBACxB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;qBACtB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO;YACL,KAAK,EAAE,eAAe;YACtB,aAAa,EAAE,eAAe;YAC9B,IAAI,EAAE,eAAe;YACrB,UAAU,EAAE,eAAe;YAC3B,KAAK,EAAE,eAAe;YACtB,YAAY,EAAE,eAAe;YAC7B,SAAS,EAAE,eAAe;YAC1B,SAAS,EAAE,eAAe;YAC1B,SAAS,EAAE,eAAe;SAC3B,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/src/rules/no-openapi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-openapi.d.ts","sourceRoot":"","sources":["../../../src/rules/no-openapi.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,aAAa;;;;;yBA0CxB,CAAC"}
+{"version":3,"file":"no-openapi.d.ts","sourceRoot":"","sources":["../../../src/rules/no-openapi.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,aAAa;;;;;yBA+CxB,CAAC"}

package/dist/src/rules/no-openapi.js

@@ -15,6 +15,11 @@ export const noOpenAPIRule = createRule({
         function checkDecorators(type) {
             for (const dec of type.decorators) {
                 if (dec.definition) {
+                    // `@extension` is allowed by this rule. Client-altering extensions are
+                    // handled by the `no-openapi-client-extensions` rule instead.
+                    if (dec.definition.name === "@extension") {
+                        continue;
+                    }
                     const id = getTypeName(dec.definition.namespace);
                     if (id === "TypeSpec.OpenAPI" || id === "Autorest") {
                         context.reportDiagnostic({

package/dist/src/rules/no-openapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"no-openapi.js","sourceRoot":"","sources":["../../../src/rules/no-openapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,UAAU,EACV,OAAO,EACP,WAAW,EACX,YAAY,GACb,MAAM,oBAAoB,CAAC;AAE5B,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;IACtC,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC;IACxD,WAAW,EACT,qGAAqG;IACvG,QAAQ,EAAE,SAAS;IACnB,GAAG,EAAE,mFAAmF;IACxF,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,8CAA8C,MAAM,mGAAmG;QAC5K,WAAW,EACT,uGAAuG;QACzG,MAAM,EAAE,oDAAoD;QAC5D,OAAO,EACL,4IAA4I;KAC/I;IACD,MAAM,CAAC,OAAO;QACZ,SAAS,eAAe,CAAC,IAA0B;YACjD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;oBACnB,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;oBACjD,IAAI,EAAE,KAAK,kBAAkB,IAAI,EAAE,KAAK,UAAU,EAAE,CAAC;wBACnD,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI;4BACxB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE;4BACpC,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC;yBACxC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO;YACL,KAAK,EAAE,eAAe;YACtB,aAAa,EAAE,eAAe;YAC9B,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,eAAe;YACtB,SAAS,EAAE,eAAe;YAC1B,UAAU,EAAE,eAAe;YAC3B,YAAY,EAAE,eAAe;YAC7B,SAAS,EAAE,eAAe;YAC1B,SAAS,EAAE,eAAe;SAC3B,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,YAAY,CAAC,GAAc;IAClC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,cAAc;YACjB,OAAO,aAAa,CAAC;QACvB,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC;QAClB,KAAK,UAAU;YACb,OAAO,SAAS,CAAC;QACnB;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC"}
+{"version":3,"file":"no-openapi.js","sourceRoot":"","sources":["../../../src/rules/no-openapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,UAAU,EACV,OAAO,EACP,WAAW,EACX,YAAY,GACb,MAAM,oBAAoB,CAAC;AAE5B,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;IACtC,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,yBAAyB,CAAC;IACxD,WAAW,EACT,qGAAqG;IACvG,QAAQ,EAAE,SAAS;IACnB,GAAG,EAAE,mFAAmF;IACxF,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,8CAA8C,MAAM,mGAAmG;QAC5K,WAAW,EACT,uGAAuG;QACzG,MAAM,EAAE,oDAAoD;QAC5D,OAAO,EACL,4IAA4I;KAC/I;IACD,MAAM,CAAC,OAAO;QACZ,SAAS,eAAe,CAAC,IAA0B;YACjD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClC,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;oBACnB,uEAAuE;oBACvE,8DAA8D;oBAC9D,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;wBACzC,SAAS;oBACX,CAAC;oBACD,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;oBACjD,IAAI,EAAE,KAAK,kBAAkB,IAAI,EAAE,KAAK,UAAU,EAAE,CAAC;wBACnD,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,GAAG,CAAC,IAAI,IAAI,IAAI;4BACxB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE;4BACpC,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC;yBACxC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO;YACL,KAAK,EAAE,eAAe;YACtB,aAAa,EAAE,eAAe;YAC9B,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,eAAe;YACtB,SAAS,EAAE,eAAe;YAC1B,UAAU,EAAE,eAAe;YAC3B,YAAY,EAAE,eAAe;YAC7B,SAAS,EAAE,eAAe;YAC1B,SAAS,EAAE,eAAe;SAC3B,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,YAAY,CAAC,GAAc;IAClC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,cAAc;YACjB,OAAO,aAAa,CAAC;QACvB,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC;QAClB,KAAK,UAAU;YACb,OAAO,SAAS,CAAC;QACnB;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC"}

package/lib/auth.tsp

@@ -19,9 +19,16 @@ namespace Azure.Core;
  */
 model AadTokenAuthFlow<Scopes extends string[], AuthUrl extends string, TokenUrl extends string>
   extends TypeSpec.Http.AuthorizationCodeFlow {
+  /** The OAuth2 flow type, always the authorization code flow. */
   type: OAuth2FlowType.authorizationCode;
+
+  /** The authorization URL used to obtain an authorization code. */
   authorizationUrl: AuthUrl;
+
+  /** The token URL used to exchange the authorization code for a token. */
   tokenUrl: TokenUrl;
+
+  /** The list of scopes the token applies to. */
   scopes: Scopes;
 }
 

package/lib/foundations.tsp

@@ -80,7 +80,7 @@ alias ResourceCreatedOrOkResponse<Resource extends TypeSpec.Reflection.Model> =
 
 /**
  * Response describing the location of a created resource.
- * @template T The type of the created resource.
+ * @template Resource The type of the created resource.
  */
 model LocationOfCreatedResourceResponse<Resource extends TypeSpec.Reflection.Model>
   is TypeSpec.Http.CreatedResponse {
@@ -91,7 +91,7 @@ model LocationOfCreatedResourceResponse<Resource extends TypeSpec.Reflection.Mod
 
 /**
  * Response describing the location of a resource created with a service-provided name.
- * @template T The type of the created resource.
+ * @template Resource The type of the created resource.
  */
 model LocationOfCreatedResourceWithServiceProvidedNameResponse<Resource extends TypeSpec.Reflection.Model>
   is TypeSpec.Http.AcceptedResponse {

package/lib/legacy.tsp

@@ -18,6 +18,8 @@ namespace Azure.Core.Legacy;
  *   @nextLink nextLink: Azure.Core.Legacy.parameterizedNextLink<[ListCertificateOptions.includePending]>;
  * }
  * ```
+ *
+ * @template ParameterizedParams The model properties whose values must be reapplied to the next link.
  */
 @Azure.Core.Foundations.Private.parameterizedNextLinkConfig(ParameterizedParams)
 scalar parameterizedNextLink<ParameterizedParams extends TypeSpec.Reflection.ModelProperty[]>

package/lib/models.tsp

@@ -38,11 +38,12 @@ model RequestParameter<Name extends valueof string> {}
 model ResponseProperty<Name extends valueof string> {}
 
 /**
- * @dev Provides the status of a resource operation.
+ * Provides the status of a resource operation.
  * @template Resource The resource type.
  * @template StatusResult Model describing the status result object. If not specified, the default is the resource type.
  * @template StatusError Model describing the status error object. If not specified, the default is the Foundations.Error.
  */
+@doc("Provides status details for long running operations.")
 @resource("operations")
 @parentResource(Resource)
 model ResourceOperationStatus<
@@ -383,6 +384,7 @@ scalar armResourceIdentifier<AllowedResourceTypes extends ArmResourceIdentifierA
   extends string;
 
 // Consider replacing `*`
+/** The deployment scopes in which an Azure Resource Manager resource identifier may be used. */
 union ArmResourceDeploymentScope {
   "Tenant",
   "Subscription",
@@ -401,6 +403,7 @@ alias AllArmResourceDeploymentScopes = [
   "Extension"
 ];
 
+/** Describes a resource type, and the scopes it applies to, that an `armResourceIdentifier` is allowed to refer to. */
 model ArmResourceIdentifierAllowedResource {
   /** The type of resource that is being referred to. For example Microsoft.Network/virtualNetworks or Microsoft.Network/virtualNetworks/subnets. See Example Types for more examples. */
   type: armResourceType;

package/lib/traits.tsp

@@ -62,6 +62,7 @@ model TraitOverride<Trait extends Model> {}
 @trait
 @Private.ensureAllQueryParams(Parameters)
 model QueryParametersTrait<Parameters extends Model, Contexts = unknown> {
+  /** The query parameters contributed by this trait. */
   @traitContext(Contexts)
   queryParams: {
     @traitLocation(TraitLocation.Parameters)
@@ -87,6 +88,7 @@ model ListQueryParametersTrait<Parameters extends Model> is QueryParametersTrait
 @trait
 @Private.ensureAllHeaderParams(Headers)
 model RequestHeadersTrait<Headers extends Model, Contexts = unknown> {
+  /** The request headers contributed by this trait. */
   @traitContext(Contexts)
   requestHeaders: {
     @traitLocation(TraitLocation.Parameters)
@@ -102,6 +104,7 @@ model RequestHeadersTrait<Headers extends Model, Contexts = unknown> {
 @trait
 @Private.ensureAllHeaderParams(Headers)
 model ResponseHeadersTrait<Headers extends Model, Contexts = unknown> {
+  /** The response headers contributed by this trait. */
   @traitContext(Contexts)
   responseHeaders: {
     @traitLocation(TraitLocation.Response)
@@ -115,6 +118,7 @@ model ResponseHeadersTrait<Headers extends Model, Contexts = unknown> {
  */
 @trait("VersionParameter")
 model VersionParameterTrait<VersionParameter> {
+  /** The API version parameter contributed by this trait. */
   versionParameter: {
     @traitLocation(TraitLocation.ApiVersionParameter)
     apiVersionParam: VersionParameter;
@@ -129,6 +133,7 @@ model VersionParameterTrait<VersionParameter> {
 @trait("ClientRequestId")
 @traitAdded(VersionAdded)
 model SupportsClientRequestId<VersionAdded extends EnumMember | null = null> {
+  /** The client request id headers contributed by this trait. */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This inline model is never used directly in operations."
   clientRequestId: {
     @traitLocation(TraitLocation.Parameters)
@@ -144,6 +149,7 @@ model SupportsClientRequestId<VersionAdded extends EnumMember | null = null> {
  */
 @trait("ClientRequestId")
 model NoClientRequestId {
+  /** Empty, indicating that client request id headers are not supported. */
   clientRequestId: {};
 }
 
@@ -155,6 +161,7 @@ model NoClientRequestId {
 @trait("ConditionalRequests")
 @traitAdded(VersionAdded)
 model SupportsConditionalRequests<VersionAdded extends EnumMember | null = null> {
+  /** The conditional request headers and ETag headers contributed by this trait. */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This inline model is never used directly in operations."
   conditionalRequests: {
     @traitContext(
@@ -174,6 +181,7 @@ model SupportsConditionalRequests<VersionAdded extends EnumMember | null = null>
  */
 @trait("ConditionalRequests")
 model NoConditionalRequests {
+  /** Empty, indicating that conditional requests are not supported. */
   conditionalRequests: {};
 }
 
@@ -185,6 +193,7 @@ model NoConditionalRequests {
 @trait("RepeatableRequests")
 @traitAdded(VersionAdded)
 model SupportsRepeatableRequests<VersionAdded extends EnumMember | null = null> {
+  /** The repeatable request headers contributed by this trait. */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This inline model is never used directly in operations."
   @traitContext(
     TraitContext.Create | TraitContext.Update | TraitContext.Delete | TraitContext.Action
@@ -203,6 +212,7 @@ model SupportsRepeatableRequests<VersionAdded extends EnumMember | null = null>
  */
 @trait("RepeatableRequests")
 model NoRepeatableRequests {
+  /** Empty, indicating that repeatable requests are not supported. */
   repeatableRequests: {};
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-core",
-  "version": "0.71.0-dev.4",
+  "version": "0.71.0-dev.7",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Core library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -47,9 +47,9 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
+    "@typespec/http": "^1.14.0",
     "@typespec/compiler": "^1.14.0",
-    "@typespec/rest": "^0.84.0",
-    "@typespec/http": "^1.14.0"
+    "@typespec/rest": "^0.84.0"
   },
   "devDependencies": {
     "@types/node": "^26.0.0",
@@ -60,10 +60,10 @@
     "vitest": "^4.1.3",
     "@typespec/compiler": "^1.14.0",
     "@typespec/http": "^1.14.0",
-    "@typespec/openapi": "^1.14.0",
     "@typespec/library-linter": "^0.84.0",
-    "@typespec/tspd": "^0.76.0",
+    "@typespec/openapi": "^1.14.0",
     "@typespec/rest": "^0.84.0",
+    "@typespec/tspd": "^0.76.0",
     "@typespec/versioning": "^0.84.0"
   },
   "scripts": {