Apply remaining changes

Co-authored-by: baywet <7905502+baywet@users.noreply.github.com>

Author: Copilot

packages/openapi/src/index.ts

@@ -35,6 +35,7 @@ export {
   ExtensionKey,
   ExternalDocs,
   License,
+  TagMetadata,
   TagMetadataWithName,
 } from "./types.js";
 

packages/openapi/src/types.ts

@@ -66,19 +66,16 @@ export interface ExternalDocs {
 }
 
 /**
- * Metadata for a tag including the tag name. Used with the array form of `@tagMetadata`.
+ * Metadata for a tag.
  */
-export interface TagMetadataWithName {
-  /** The name of the tag. */
-  name: string;
-
+export interface TagMetadata {
   /** A description of the tag. */
   description?: string;
 
   /** External documentation for the tag. */
   externalDocs?: ExternalDocs;
 
-  /** The name of a parent tag (only supported in OpenAPI 3.2). */
+  /** The name of a parent tag (only supported natively in OpenAPI 3.2; emitted as `x-oai-parent` for 3.0 and 3.1). */
   parent?: string;
 
   /** A short summary of the tag, used for display purposes. Only supported natively in OpenAPI 3.2. For 3.0 and 3.1, this will be emitted as `x-oai-summary`. */
@@ -90,3 +87,11 @@ export interface TagMetadataWithName {
   /** Additional extension data. Keys must start with `x-`. */
   [extensionKey: string]: unknown;
 }
+
+/**
+ * Metadata for a tag including the tag name. Used with the array form of `@tagMetadata`.
+ */
+export interface TagMetadataWithName extends TagMetadata {
+  /** The name of the tag. */
+  name: string;
+}

packages/openapi3/src/cli/actions/convert/transforms/transform-tags.ts

@@ -8,8 +8,7 @@ export function transformTags(tags: OpenAPI3Tag[]): TypeSpecTagMetadata[] {
     const summary: string | undefined =
       tag32.summary ?? (tag["x-oai-summary"] as string | undefined);
     const kind: string | undefined = tag32.kind ?? (tag["x-oai-kind"] as string | undefined);
-    // parent is only supported natively in OpenAPI 3.2
-    const parent: string | undefined = tag32.parent;
+    const parent: string | undefined = tag32.parent ?? (tag["x-oai-parent"] as string | undefined);
 
     return {
       name: tag.name,

packages/openapi3/src/openapi.ts

@@ -1829,12 +1829,12 @@ function createOAPIEmitter(
     for (const tag of metadataList ?? []) {
       const { name, ...rest } = tag;
       const tagData: OpenAPI3Tag = { name, ...rest };
-      // For OpenAPI 3.0 and 3.1, drop the 'parent' field (only supported in 3.2)
-      if (specVersion !== "3.2.0" && rest.parent) {
-        delete (tagData as { parent?: string }).parent;
-      }
-      // For OpenAPI 3.0 and 3.1, convert 'summary' and 'kind' to x-oai- prefixed extensions
+      // For OpenAPI 3.0 and 3.1, convert 'parent', 'summary', and 'kind' to x-oai- prefixed extensions
       if (specVersion !== "3.2.0") {
+        if (tag.parent) {
+          (tagData as unknown as Record<string, unknown>)["x-oai-parent"] = tag.parent;
+          delete (tagData as { parent?: string }).parent;
+        }
         if (tag.summary) {
           (tagData as unknown as Record<string, unknown>)["x-oai-summary"] = tag.summary;
           delete (tagData as { summary?: string }).summary;

packages/openapi3/test/tagmetadata.test.ts

@@ -240,7 +240,7 @@ describe("tag metadata with parent field", () => {
     ]);
   });
 
-  it("OpenAPI 3.1 should drop parent field", async () => {
+  it("OpenAPI 3.1 should emit parent field as x-oai-parent", async () => {
     const res = await OpenAPISpecHelpers["3.1.0"].openApiFor(
       `
       @service
@@ -256,6 +256,7 @@ describe("tag metadata with parent field", () => {
       {
         name: "ChildTag",
         description: "Child tag",
+        "x-oai-parent": "ParentTag",
       },
       {
         name: "ParentTag",
@@ -264,7 +265,7 @@ describe("tag metadata with parent field", () => {
     ]);
   });
 
-  it("OpenAPI 3.0 should drop parent field", async () => {
+  it("OpenAPI 3.0 should emit parent field as x-oai-parent", async () => {
     const res = await OpenAPISpecHelpers["3.0.0"].openApiFor(
       `
       @service
@@ -280,6 +281,7 @@ describe("tag metadata with parent field", () => {
       {
         name: "ChildTag",
         description: "Child tag",
+        "x-oai-parent": "ParentTag",
       },
       {
         name: "ParentTag",

packages/openapi3/test/tsp-openapi3/convert-openapi3-doc.test.ts

@@ -988,7 +988,7 @@ describe("convertOpenAPI3Document tag metadata", () => {
     );
   });
 
-  it("converts OpenAPI 3.0/3.1 tags with x-oai- extensions for summary and kind", async () => {
+  it("converts OpenAPI 3.0/3.1 tags with x-oai- extensions for summary, kind, and parent", async () => {
     for (const version of ["3.0.0", "3.1.0"] as const) {
       const tsp = await convertOpenAPI3Document({
         info: {
@@ -1004,6 +1004,11 @@ describe("convertOpenAPI3Document tag metadata", () => {
             "x-oai-summary": "Tag summary",
             "x-oai-kind": "OperationGroup",
           },
+          {
+            name: "child-tag",
+            description: "A child tag",
+            "x-oai-parent": "simple-tag",
+          },
         ],
       });
 
@@ -1020,7 +1025,10 @@ describe("convertOpenAPI3Document tag metadata", () => {
 
           @service(#{ title: "(title)" })
           @info(#{ version: "0.0.0" })
-          @tagMetadata(#[#{ name: "simple-tag", description: "A simple tag", summary: "Tag summary", kind: "OperationGroup" }])
+          @tagMetadata(#[
+            #{ name: "simple-tag", description: "A simple tag", summary: "Tag summary", kind: "OperationGroup" },
+            #{ name: "child-tag", description: "A child tag", parent: "simple-tag" },
+          ])
           namespace title;
           `,
           { printWidth: 100, tabWidth: 2 },

vitest.config.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Default Config For all TypeSpec projects using vitest.
+ */
+export declare const defaultTypeSpecVitestConfig: import("vite").UserConfig;
+declare const _default: Record<string, any>;
+export default _default;
+//# sourceMappingURL=vitest.config.d.ts.map