Check type name that MUST use keys that match the regular expression: ^[a-zA-Z0-9.-_]+$.

.chronus/changes/checkAvailableTypeName-2024-10-7-15-22-31.md

@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@typespec/openapi"
+---
+
+Illegal characters in component keys

packages/openapi/src/helpers.ts

@@ -65,10 +65,24 @@
 ): string {
   const name = getFriendlyName(program, type) ?? getTypeName(type, options);
 
+  checkAvailableTypeName(program, type, name);
   checkDuplicateTypeName(program, type, name, existing);
   return name;
 }
 
+function checkAvailableTypeName(program: Program, type: Type, name: string) {
+  const pattern = /^[a-zA-Z0-9.-_]+$/;
+  if (!pattern.test(name)) {
+    reportDiagnostic(program, {
+      code: "invalid-type-name",
+      format: {
+        value: name,
+      },
+      target: type,
+    });
+  }
+}
+
 /**
  * Check the given name is not already specific in the existing map. Report a diagnostic if it is.
  * @param program  Program
@@ -110,6 +124,8 @@
     key += `.${property.name}`;
   }
 
+  checkAvailableTypeName(program, property, key);
+
   if (existingParams[key]) {
     reportDiagnostic(program, {
       code: "duplicate-type-name",

packages/openapi/src/lib.ts

@@ -34,6 +34,13 @@ export const $lib = createTypeSpecLibrary({
         default: paramMessage`@tagMetadata must be used on the service namespace. Did you mean to annotate '${"namespace"}'  with '@service'?`,
       },
     },
+    "invalid-type-name": {
+      severity: "error",
+      messages: {
+        default: paramMessage`Invalid type name: '${"value"}'. Check @friendlyName decorators and overlap with types in TypeSpec or service namespace.`,
+        parameter: paramMessage`Invalid parameter key: '${"value"}'. Check @friendlyName decorators and overlap with types in TypeSpec or service namespace.`,
+      },
+    },
   },
   state: {
     tagsMetadata: { description: "State for the @tagMetadata decorator." },

packages/openapi3/test/parameters.test.ts

@@ -301,27 +301,32 @@ describe("query parameters", () => {
     ]);
   });
 
-  it("encodes parameter keys in references", async () => {
-    const oapi = await openApiFor(`
-      model Pet extends Pet$Id {
-        name: string;
+  it("errors on invalid parameter keys", async () => {
+    const diagnostics = await diagnoseOpenApiFor(
+      `
+      model Pet {
+        @query()
+        $take?: int32;
+
+        @query()
+        $top?: int32;
       }
-      model Pet$Id {
-        @path
-        petId: string;
+      @service
+      namespace Endpoints {
+        op list(...Pet): void;
       }
-
-      @route("/Pets")
-      @get()
-      op get(... Pet$Id): Pet;
-      `);
-
-    ok(oapi.paths["/Pets/{petId}"].get);
-    strictEqual(
-      oapi.paths["/Pets/{petId}"].get.parameters[0]["$ref"],
-      "#/components/parameters/Pet%24Id",
+      `,
+      { "omit-unreachable-types": true },
     );
-    strictEqual(oapi.components.parameters["Pet$Id"].name, "petId");
+
+    expectDiagnostics(diagnostics, [
+      {
+        code: "@typespec/openapi/invalid-type-name",
+      },
+      {
+        code: "@typespec/openapi/invalid-type-name",
+      },
+    ]);
   });
 
   it("inline spread of parameters from anonymous model", async () => {