Add warning when @defaultResponse is used on model with status code or @error

[Copilot]

Using @defaultResponse on a model that already has @statusCode or @error produces duplicate $ref entries in OpenAPI output (e.g., anyOf with two identical refs). Rather than silently generating invalid output, emit a diagnostic warning at the source.

Changes

• packages/openapi/src/lib.ts — New default-response-with-status-code diagnostic with statusCode and error message variants
• packages/openapi/src/decorators.ts — $defaultResponse now checks the target model for existing @statusCode properties and @error decoration before setting the wildcard status code
• packages/openapi/test/decorators.test.ts — Tests for both warning cases and the clean no-warning path

Example

// This now emits a warning:
@error
@defaultResponse
model DefaultError is Error<500>;

// Recommended alternatives:
@error
model MyError { message: string; }
op read(): Data | MyError;

// Or split concerns:
@error model Error500 is Error<500>;
@error @defaultResponse model DefaultError { message: string; }
alias Result<T> = T | Error500 | DefaultError;

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/openapi@10555

commit: ae69b8f

[timotheeguerin]

@copilot fix lint

[Copilot]

@copilot fix lint

Fixed in c10f3ab — removed the unnecessary escape character \@ → @ in the regex, and added the missing changeset for @typespec/openapi.

[github-actions]

All changed packages have been documented.

• ✅ @typespec/openapi

Show changes

@typespec/openapi - feature ✏️

Added a warning diagnostic when @defaultResponse is used on a model that already has a @statusCode property or is marked with @error.

[timotheeguerin]

@copilot test fail

 FAIL   @typespec/openapi  test/decorators.test.ts > openapi: decorators > @defaultResponse > emits warning when used on a model marked with @error
AssertionError: Expected 1 diagnostics but found 0:
 

simple

 ❯ expectDiagnostics ../compiler/src/testing/expect.ts:70:9
 ❯ test/decorators.test.ts:594:7
    592|         }
    593|       `);
    594|       expectDiagnostics(diagnostics, [
       |       ^
    595|         { code: "@typespec/openapi/default-response-with-status-code",…
    596|       ]);

[Copilot]

@copilot test fail

 FAIL   @typespec/openapi  test/decorators.test.ts > openapi: decorators > @defaultResponse > emits warning when used on a model marked with @error

...

The @error check was running during decorator application, before @error had been applied to the model. Moved the validation into an onTargetFinish callback so it runs after all decorators on the target are applied. All 60 tests pass now.