Merge autorest 0.39.1 hotfix back into main (#240)

Azure · Feb 8, 2024 · 89c568d · 89c568d
1 parent daf550a
commit 89c568d
Show file tree

Hide file tree

Showing 26 changed files with 162 additions and 85 deletions.
diff --git a/.changeset/chatty-bobcats-love.md b/.changeset/chatty-bobcats-love.md
diff --git a/core b/core
diff --git a/...azure-portal-core/reference/data-types.md → ...azure-portal-core/reference/data-types.md b/...azure-portal-core/reference/data-types.md → ...azure-portal-core/reference/data-types.md
diff --git a/...azure-portal-core/reference/decorators.md → ...azure-portal-core/reference/decorators.md b/...azure-portal-core/reference/decorators.md → ...azure-portal-core/reference/decorators.md
diff --git a/...pec-azure-portal-core/reference/index.mdx → ...ies/azure-portal-core/reference/index.mdx b/...pec-azure-portal-core/reference/index.mdx → ...ies/azure-portal-core/reference/index.mdx
diff --git a/eng/pipelines/pr-tryit.yml b/eng/pipelines/pr-tryit.yml
@@ -2,6 +2,7 @@ name: PR Tools
 trigger: none
 pr:
   - main
+  - release/*
 
 variables:
   - template: templates/variables/globals.yml

diff --git a/packages/e2e-tests/package.json b/packages/e2e-tests/package.json
@@ -25,7 +25,7 @@
     "build": ""
   },
   "devDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "typescript": "~5.3.3",
     "dotenv": "~16.3.1"
   }

diff --git a/packages/samples/package.json b/packages/samples/package.json
@@ -39,13 +39,13 @@
   ],
   "dependencies": {
     "@typespec/versioning": "workspace:~0.53.0",
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/openapi": "workspace:~0.53.0",
-    "@typespec/openapi3": "workspace:~0.53.0",
+    "@typespec/openapi3": "workspace:~0.53.1",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0",
     "@azure-tools/typespec-azure-core": "workspace:~0.39.0",
-    "@azure-tools/typespec-autorest": "workspace:~0.39.0",
+    "@azure-tools/typespec-autorest": "workspace:~0.39.1",
     "@azure-tools/typespec-azure-resource-manager": "workspace:~0.39.0",
     "@azure-tools/typespec-client-generator-core": "workspace:~0.39.0"
   },

diff --git a/...utput/azure/core/data-plane/api-path-parameter/@typespec/openapi3/openapi.2022-08-31.yaml b/...utput/azure/core/data-plane/api-path-parameter/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -857,6 +857,7 @@ components:
       enum:
         - accepted
         - rejected
+      description: Repeatability Result header options
     Versions:
       type: string
       enum:

diff --git a/...output/azure/core/data-plane/custom-error-type/@typespec/openapi3/openapi.2022-08-31.yaml b/...output/azure/core/data-plane/custom-error-type/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -454,6 +454,7 @@ components:
       enum:
         - accepted
         - rejected
+      description: Repeatability Result header options
     Versions:
       type: string
       enum:

diff --git a/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2022-08-31.yaml b/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -774,6 +774,7 @@ components:
       enum:
         - accepted
         - rejected
+      description: Repeatability Result header options
     Versions:
       type: string
       enum:

diff --git a/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2023-02-07.yaml b/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2023-02-07.yaml
@@ -858,6 +858,7 @@ components:
       enum:
         - accepted
         - rejected
+      description: Repeatability Result header options
     Versions:
       type: string
       enum:

diff --git a/...st/output/azure/core/data-plane/widget-manager/@typespec/openapi3/openapi.2022-08-31.yaml b/...st/output/azure/core/data-plane/widget-manager/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -1517,6 +1517,7 @@ components:
       enum:
         - accepted
         - rejected
+      description: Repeatability Result header options
     Versions:
       type: string
       enum:

diff --git a/packages/typespec-autorest/CHANGELOG.md b/packages/typespec-autorest/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change Log - @azure-tools/typespec-autorest
 
+## 0.39.1
+
+### Patch Changes
+
+- b5fa501: Support default value for union properties
+- b5fa501: Fix: Description being ignored on unions
+
 ## 0.39.0
 
 ### Minor Changes

diff --git a/packages/typespec-autorest/package.json b/packages/typespec-autorest/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-autorest",
-  "version": "0.39.0",
+  "version": "0.39.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for emitting openapi from the TypeSpec REST protocol binding",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -54,7 +54,7 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@azure-tools/typespec-azure-core": "workspace:~0.39.0",
     "@azure-tools/typespec-client-generator-core": "workspace:~0.39.0",
     "@typespec/http": "workspace:~0.53.0",
@@ -63,8 +63,8 @@
     "@typespec/versioning": "workspace:~0.53.0"
   },
   "devDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
-    "@typespec/json-schema": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
+    "@typespec/json-schema": "workspace:~0.53.1",
     "@azure-tools/typespec-azure-core": "workspace:~0.39.0",
     "@azure-tools/typespec-client-generator-core": "workspace:~0.39.0",
     "@typespec/http": "workspace:~0.53.0",

diff --git a/packages/typespec-autorest/src/openapi.ts b/packages/typespec-autorest/src/openapi.ts
@@ -1532,7 +1532,7 @@ function createOAPIEmitter(
     if (e.nullable) {
       schema["x-nullable"] = true;
     }
-    return schema;
+    return applyIntrinsicDecorators(union, schema);
   }
 
   function getSchemaForUnion(union: Union, visibility: Visibility): OpenAPI2Schema {
@@ -1607,6 +1607,8 @@ function createOAPIEmitter(
               format: { type: type.kind },
               target: type,
             });
+      case "UnionVariant":
+        return getDefaultValue(type.type);
       default:
         reportDiagnostic(program, {
           code: "invalid-default",
@@ -1793,10 +1795,20 @@ function createOAPIEmitter(
   }
 
   function resolveProperty(prop: ModelProperty, visibility: Visibility): OpenAPI2SchemaProperty {
-    const propSchema =
-      prop.type.kind === "Enum" && prop.default
-        ? getSchemaForEnum(prop.type)
-        : getSchemaOrRef(prop.type, visibility);
+    let propSchema;
+    if (prop.type.kind === "Enum" && prop.default) {
+      propSchema = getSchemaForEnum(prop.type);
+    } else if (prop.type.kind === "Union" && prop.default) {
+      const [asEnum, _] = getUnionAsEnum(prop.type);
+      if (asEnum) {
+        propSchema = getSchemaForUnionEnum(prop.type, asEnum);
+      } else {
+        propSchema = getSchemaOrRef(prop.type, visibility);
+      }
+    } else {
+      propSchema = getSchemaOrRef(prop.type, visibility);
+    }
+
     return applyIntrinsicDecorators(prop, propSchema);
   }
 
@@ -1830,15 +1842,17 @@ function createOAPIEmitter(
   }
 
   function applyIntrinsicDecorators(
-    typespecType: Model | Scalar | ModelProperty,
+    typespecType: Model | Scalar | ModelProperty | Union,
     target: OpenAPI2Schema
   ): OpenAPI2Schema {
     const newTarget = { ...target };
     const docStr = getDoc(program, typespecType);
     const isString =
-      typespecType.kind !== "Model" && isStringType(program, getPropertyType(typespecType));
+      (typespecType.kind === "Scalar" || typespecType.kind === "ModelProperty") &&
+      isStringType(program, getPropertyType(typespecType));
     const isNumeric =
-      typespecType.kind !== "Model" && isNumericType(program, getPropertyType(typespecType));
+      (typespecType.kind === "Scalar" || typespecType.kind === "ModelProperty") &&
+      isNumericType(program, getPropertyType(typespecType));
 
     if (docStr) {
       newTarget.description = docStr;
@@ -1927,7 +1941,9 @@ function createOAPIEmitter(
 
     attachExtensions(typespecType, newTarget);
 
-    return typespecType.kind === "Model" ? newTarget : applyEncoding(typespecType, newTarget);
+    return typespecType.kind === "Scalar" || typespecType.kind === "ModelProperty"
+      ? applyEncoding(typespecType, newTarget)
+      : newTarget;
   }
 
   function applyEncoding(

diff --git a/packages/typespec-autorest/test/models.test.ts b/packages/typespec-autorest/test/models.test.ts
@@ -307,6 +307,41 @@ describe("typespec-autorest: model definitions", () => {
     });
   });
 
+  it("specify default value on union with variant", async () => {
+    const res = await oapiForModel(
+      "Foo",
+      `
+      model Foo {
+        optionalUnion?: MyUnion = MyUnion.a;
+      };
+      
+      union MyUnion {
+        a: "a-value",
+        b: "b-value",
+      }
+      `
+    );
+
+    deepStrictEqual(res.defs.Foo, {
+      type: "object",
+      properties: {
+        optionalUnion: {
+          type: "string",
+          enum: ["a-value", "b-value"],
+          "x-ms-enum": {
+            values: [
+              { name: "a", value: "a-value" },
+              { name: "b", value: "b-value" },
+            ],
+            modelAsString: false,
+            name: "MyUnion",
+          },
+          default: "a-value",
+        },
+      },
+    });
+  });
+
   it("errors on empty enum", async () => {
     const diagnostics = await diagnoseOpenApiFor(
       `

diff --git a/packages/typespec-autorest/test/union-schema.test.ts b/packages/typespec-autorest/test/union-schema.test.ts
@@ -1,5 +1,5 @@
 import { expectDiagnostics } from "@typespec/compiler/testing";
-import { deepStrictEqual } from "assert";
+import { deepStrictEqual, strictEqual } from "assert";
 import { describe, it } from "vitest";
 import { diagnoseOpenApiFor, openApiFor } from "./test-host.js";
 
@@ -138,5 +138,19 @@ describe("typespec-autorest: union schema", () => {
         },
       });
     });
+
+    it("supports description on unions that reduce to enums", async () => {
+      const res = await openApiFor(
+        `
+      @doc("FooUnion")
+      union Foo {
+        "a";
+        "b";
+      }
+
+      `
+      );
+      strictEqual(res.definitions.Foo.description, "FooUnion");
+    });
   });
 });
diff --git a/packages/typespec-azure-core/package.json b/packages/typespec-azure-core/package.json
@@ -52,12 +52,12 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0"
   },
   "devDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/eslint-config-typespec": "workspace:~0.53.0",

diff --git a/packages/typespec-azure-playground-website/package.json b/packages/typespec-azure-playground-website/package.json
@@ -49,12 +49,12 @@
   ],
   "dependencies": {
     "@typespec/versioning": "workspace:~0.53.0",
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/openapi": "workspace:~0.53.0",
-    "@typespec/openapi3": "workspace:~0.53.0",
-    "@azure-tools/typespec-autorest": "workspace:~0.39.0",
+    "@typespec/openapi3": "workspace:~0.53.1",
+    "@azure-tools/typespec-autorest": "workspace:~0.39.1",
     "@azure-tools/typespec-azure-core": "workspace:~0.39.0",
     "@azure-tools/typespec-azure-resource-manager": "workspace:~0.39.0",
     "@azure-tools/typespec-client-generator-core": "workspace:~0.39.0",

diff --git a/packages/typespec-azure-portal-core/package.json b/packages/typespec-azure-portal-core/package.json
@@ -17,7 +17,7 @@
     "test-official": "vitest run --coverage --reporter=junit --reporter=default --no-file-parallelism",
     "lint": "eslint . --ext .ts --max-warnings=0",
     "lint:fix": "eslint . --fix --ext .ts",
-    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/libraries/typespec-azure-portal-core/reference"
+    "regen-docs": "tspd doc .  --enable-experimental  --output-dir ../../docs/libraries/azure-portal-core/reference"
   },
   "keywords": [
     "Azure",
@@ -29,15 +29,15 @@
   "tspMain": "lib/main.tsp",
   "peerDependencies": {
     "@azure-tools/typespec-azure-resource-manager": "workspace:~0.39.0",
-    "@typespec/compiler": "workspace:~0.53.0"
+    "@typespec/compiler": "workspace:~0.53.1"
   },
   "devDependencies": {
-    "@azure-tools/typespec-autorest": "workspace:~0.39.0",
+    "@azure-tools/typespec-autorest": "workspace:~0.39.1",
     "@azure-tools/typespec-azure-core": "workspace:~0.39.0",
     "@azure-tools/typespec-azure-resource-manager": "workspace:~0.39.0",
     "@azure-tools/typespec-client-generator-core": "workspace:~0.39.0",
     "@types/node": "~18.11.9",
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/eslint-config-typespec": "workspace:~0.53.0",
     "@typespec/eslint-plugin": "workspace:~0.53.0",
     "@typespec/http": "workspace:~0.53.0",

diff --git a/packages/typespec-azure-resource-manager/package.json b/packages/typespec-azure-resource-manager/package.json
@@ -52,19 +52,19 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@azure-tools/typespec-azure-core": "~0.39.0",
-    "@azure-tools/typespec-autorest": "~0.39.0",
+    "@azure-tools/typespec-autorest": "~0.39.1",
     "@typespec/openapi": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/versioning": "workspace:~0.53.0"
   },
   "devDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/openapi": "workspace:~0.53.0",
     "@azure-tools/typespec-azure-core": "workspace:~0.39.0",
-    "@azure-tools/typespec-autorest": "workspace:~0.39.0",
+    "@azure-tools/typespec-autorest": "workspace:~0.39.1",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/versioning": "workspace:~0.53.0",

diff --git a/packages/typespec-client-generator-core/package.json b/packages/typespec-client-generator-core/package.json
@@ -57,13 +57,13 @@
     "change-case": "~5.3.0"
   },
   "peerDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/versioning": "workspace:~0.53.0"
   },
   "devDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/eslint-config-typespec": "workspace:~0.53.0",

diff --git a/packages/typespec-service-csharp/package.json b/packages/typespec-service-csharp/package.json
@@ -46,19 +46,19 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
+    "@typespec/compiler": "workspace:~0.53.1",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/http": "workspace:~0.53.0",
     "@typespec/versioning": "workspace:~0.53.0",
-    "@azure-tools/typespec-autorest": "~0.39.0",
+    "@azure-tools/typespec-autorest": "~0.39.1",
     "@azure-tools/typespec-azure-core": "~0.39.0"
   },
   "dependencies": {
     "change-case": "~5.3.0"
   },
   "devDependencies": {
-    "@typespec/compiler": "workspace:~0.53.0",
-    "@azure-tools/typespec-autorest": "workspace:~0.39.0",
+    "@typespec/compiler": "workspace:~0.53.1",
+    "@azure-tools/typespec-autorest": "workspace:~0.39.1",
     "@typespec/openapi": "workspace:~0.53.0",
     "@typespec/rest": "workspace:~0.53.0",
     "@typespec/http": "workspace:~0.53.0",

diff --git a/packages/website/package.json b/packages/website/package.json
@@ -38,6 +38,7 @@
     "@azure-tools/typespec-azure-resource-manager": "workspace:~0.39.0",
     "@azure-tools/typespec-client-generator-core": "workspace:~0.39.0",
     "@azure-tools/typespec-service-csharp": "workspace:~0.32.0",
+    "@azure-tools/typespec-azure-portal-core": "workspace:~0.39.0",
     "@docusaurus/module-type-aliases": "^3.0.0",
     "@docusaurus/tsconfig": "^3.0.0",
     "@docusaurus/types": "^3.0.0",
+2 −2		packages/best-practices/package.json
+1 −1		packages/bundler/package.json
+6 −0		packages/compiler/CHANGELOG.md
+1 −1		packages/compiler/package.json
+3 −0		packages/compiler/src/core/checker.ts
+4 −4		packages/compiler/templates/scaffolding.json
+2 −2		packages/html-program-viewer/package.json
+2 −2		packages/http/package.json
+8 −1		packages/json-schema/CHANGELOG.md
+3 −3		packages/json-schema/package.json
+2 −0		packages/json-schema/src/json-schema-emitter.ts
+20 −0		packages/json-schema/test/models.test.ts
+12 −0		packages/json-schema/test/unions.test.ts
+2 −2		packages/library-linter/package.json
+2 −2		packages/openapi/package.json
+7 −0		packages/openapi3/CHANGELOG.md
+3 −3		packages/openapi3/package.json
+3 −48		packages/openapi3/src/openapi.ts
+73 −65		packages/openapi3/src/schema-emitter.ts
+27 −0		packages/openapi3/test/models.test.ts
+15 −0		packages/openapi3/test/union-schema.test.ts
+3 −3		packages/playground-website/package.json
+2 −2		packages/playground/package.json
+1 −1		packages/prettier-plugin-typespec/package.json
+2 −2		packages/protobuf/package.json
+2 −2		packages/rest/package.json
+3 −3		packages/samples/package.json
+2 −2		packages/tspd/package.json
+1 −1		packages/typespec-vscode/package.json
+2 −2		packages/versioning/package.json
+3 −3		packages/website/package.json
+25 −25		pnpm-lock.yaml