openapi-typesafe 1.0.0-rc.1 → 1.0.0-rc.3

package/src/cli/help-text.ts

@@ -4,7 +4,7 @@ export const HELP_TEXT = [
   "  $ openapi-typesafe [input] [options]",
   "",
   "Options",
-  "  --help                     Display this",
+  "  --help                     Show this help",
   "  --version                  Display the version",
   "  --redocly [path], -c       Specify path to Redocly config (default: redocly.yaml)",
   "  --output, -o               Specify output file (if not specified in redocly.yaml)",
@@ -20,8 +20,8 @@ export const HELP_TEXT = [
   "  --additional-properties    Treat schema objects as if `additionalProperties: true` is set",
   "  --empty-objects-unknown    Generate `unknown` instead of" +
     " `Record<string, never>` for empty objects",
-  "  --default-non-nullable     Set to `false` to ignore default values" +
-    " when generating non-nullable types",
+  "  --default-non-nullable     A property with a `default` is required" +
+    " (default: true; =false makes it optional)",
   "  --properties-required-by-default",
   "                             Treat schema objects as if `required` is" +
     " set to all properties by default",
@@ -35,7 +35,7 @@ export const HELP_TEXT = [
     " undefined by schema",
   "  --alphabetize              Sort object keys alphabetically",
   "  --exclude-deprecated       Exclude deprecated types",
-  "  --root-types               Export schemas types at root level",
+  "  --root-types               Export `components` types as root-level aliases",
   "  --root-types-no-schema-prefix",
   '                             Do not add "Schema" prefix to types at' +
     " the root level (should only be used with --root-types)",

package/src/cli/redocly-apis.ts

@@ -2,6 +2,13 @@ import { kebabCase } from "scule";
 import type { RedoclyConfig } from "../application/ports/redocly-config-source.js";
 import type { OutputFixName } from "../domain/output-fixes.js";
 import type { GeneratorOptions } from "../types.js";
+import {
+  type ApiSettings,
+  apiRefLimitOptions,
+  FIX_SETTING,
+  OUTPUT_SETTING,
+  unknownSettingWarnings,
+} from "./api-settings.js";
 import { GENERATOR_FLAGS, type GeneratorFlags } from "./cli-arguments.js";
 import { cliError } from "./cli-errors.js";
 import { type CliRun, emitOutput, resolveLocationUrl } from "./cli-output.js";
@@ -14,11 +21,6 @@ import { refLimitOptions } from "./ref-limits.js";
 /** The key of an API's openapi-typesafe settings in `redocly.yaml`. */
 const REDOCLY_CONFIG_KEY = "x-openapi-ts";
 
-/** The setting of an API that lists its output fixes. */
-const FIX_SETTING = "fix";
-
-type ApiSettings = Readonly<Record<string, unknown>>;
-
 interface RedoclyApi {
   readonly name: string;
   readonly root: string;
@@ -59,19 +61,23 @@ function configRootOf(redocly: RedoclyConfig, cwd: URL): URL {
 }
 
 async function generateApi(run: CliRun, redocly: RedoclyConfig, api: RedoclyApi): Promise<void> {
-  if (!api.settings?.output) {
+  if (!api.settings?.[OUTPUT_SETTING]) {
     throw cliError(
       "CLI_CONFIG_OUTPUT_MISSING",
       `API ${api.name} is missing an \`${REDOCLY_CONFIG_KEY}.output\` key. ` +
         `See ${MULTIPLE_SCHEMAS_DOCS_URL}`,
     );
   }
-  const output = String(api.settings.output);
+  for (const warning of unknownSettingWarnings(api.name, api.settings)) {
+    run.deps.logger.warn(warning);
+  }
+  const output = String(api.settings[OUTPUT_SETTING]);
   const configRoot = configRootOf(redocly, run.deps.cwd);
   const options: GeneratorOptions = {
     ...run.args.generatorFlags,
     ...apiFlags(api.settings),
     ...refLimitOptions(run.args, run.deps.cwd),
+    ...apiRefLimitOptions(api.name, api.settings, configRoot),
     ...fixOption(apiFixNames(api.settings) ?? run.args.fix),
     redocly,
   };

package/src/cli/run-cli.ts

@@ -1,5 +1,6 @@
 import type { Logger } from "../application/ports/logger.js";
 import type { RedoclyConfig } from "../application/ports/redocly-config-source.js";
+import { WARNING_CODES, warningText } from "../domain/warnings.js";
 import type { SchemaSource } from "../types.js";
 import { ineffectiveFlagNotices, parseCliArguments } from "./cli-arguments.js";
 import type { CliDependencies } from "./cli-dependencies.js";
@@ -84,7 +85,10 @@ async function generate(run: CliRun): Promise<unknown[]> {
   }
   if (run.args.input) {
     run.deps.logger.warn(
-      "APIs are specified both in Redocly Config and CLI argument. Only using Redocly config.",
+      warningText(
+        "APIs are specified both in Redocly Config and CLI argument. Only using Redocly config.",
+        WARNING_CODES.CLI_INPUT_IGNORED,
+      ),
     );
   }
   return generateRedoclyApis(run, redocly);

package/src/domain/deprecations.ts

@@ -0,0 +1,15 @@
+/**
+ * Deprecations of what 2.0 removes. Each one is a Node.js `DeprecationWarning` with one of these
+ * codes, so `--no-deprecation`, `--throw-deprecation`, `--trace-deprecation` and
+ * `process.on("warning")` work on it as on Node's own (ADR-004, amendment of 2026-11-08).
+ */
+
+/** Every deprecation code. */
+export const DEPRECATION_CODES = {
+  OPENAPI_TYPESAFE_DEP_STRING_TO_AST: "OPENAPI_TYPESAFE_DEP_STRING_TO_AST",
+  OPENAPI_TYPESAFE_DEP_TS_TRANSFORM: "OPENAPI_TYPESAFE_DEP_TS_TRANSFORM",
+  OPENAPI_TYPESAFE_DEP_TS_POST_TRANSFORM: "OPENAPI_TYPESAFE_DEP_TS_POST_TRANSFORM",
+  OPENAPI_TYPESAFE_DEP_TS_TRANSFORM_PROPERTY: "OPENAPI_TYPESAFE_DEP_TS_TRANSFORM_PROPERTY",
+} as const;
+
+export type DeprecationCode = (typeof DEPRECATION_CODES)[keyof typeof DEPRECATION_CODES];

package/src/domain/errors.ts

@@ -1,3 +1,5 @@
+import { redactUrlCredentials } from "./url-credentials.js";
+
 /**
  * Typed errors (ENGINEERING_PLAN 4.6, ADR-011). Every expected failure of the generator and the CLI
  * is an `OpenAPITypesafeError` with a stable machine-readable `code` and structured `details`. The
@@ -5,7 +7,10 @@
  * invariant) is a plain `Error`, not one of these.
  */
 
-/** Every error code. The set is closed: a new code must be handled by the CLI exit-code table. */
+/**
+ * Every error code. A minor release may add codes (ADR-034); each one needs a row in the CLI's
+ * exit-code table, which the compiler checks.
+ */
 export const ERROR_CODES = {
   SCHEMA_SOURCE_EMPTY: "SCHEMA_SOURCE_EMPTY",
   SCHEMA_SOURCE_INVALID: "SCHEMA_SOURCE_INVALID",
@@ -37,7 +42,10 @@ export const ERROR_CODES = {
 
 export type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
 
-/** Structured, JSON-serializable facts about a failure, for programs and logs. */
+/**
+ * Structured, JSON-serializable facts about a failure, for programs and logs. Only the keys that
+ * docs/node.md (Errors) lists are stable (ADR-034, amendment of 2026-11-08).
+ */
 export type ErrorDetails = Readonly<Record<string, unknown>>;
 
 export interface OpenAPITypesafeErrorInit {
@@ -48,13 +56,17 @@ export interface OpenAPITypesafeErrorInit {
   readonly cause?: unknown;
 }
 
-/** The base of every expected failure; check `code`, not the class or the message. */
+/**
+ * The base of every expected failure; check `code`, not the class or the message. The message
+ * never shows the user info of a URL (`url-credentials.ts`).
+ */
 export class OpenAPITypesafeError extends Error {
   readonly code: ErrorCode;
   readonly details: ErrorDetails;
 
   constructor(init: OpenAPITypesafeErrorInit) {
-    super(init.message, init.cause === undefined ? undefined : { cause: init.cause });
+    const message = redactUrlCredentials(init.message);
+    super(message, init.cause === undefined ? undefined : { cause: init.cause });
     this.name = "OpenAPITypesafeError";
     this.code = init.code;
     this.details = init.details ?? {};

package/src/domain/ir/constructors.ts

@@ -33,6 +33,9 @@ export function irKeyword(keyword: IrKeyword): IrKeywordType {
   return { kind: "keyword", keyword };
 }
 
+/** The encoding of a string literal that does not name one. */
+export const DEFAULT_STRING_ENCODING: IrStringEncoding = "json";
+
 export function irString(value: string, encoding: IrStringEncoding): IrStringLiteralType {
   return { kind: "stringLiteral", value, encoding };
 }

package/src/domain/ir/nodes.ts

@@ -1,8 +1,10 @@
 /**
  * Type IR: the closed set of immutable nodes that describes the TypeScript types and declarations
  * the generator emits (ENGINEERING_PLAN §4.2, ADR-002). Nodes are plain readonly data with a `kind`
- * discriminator; every consumer dispatches with an exhaustive `switch`, so a new kind breaks the
- * build wherever it must be handled.
+ * discriminator; every consumer in this package dispatches with an exhaustive `switch`, so a new
+ * kind breaks the build wherever it must be handled. For users the set is open: a minor release
+ * may add a kind (ADR-034), so code outside the package must keep a node of an unknown kind as it
+ * is, and a `switch` over `kind` needs a `default` branch.
  *
  * Utility types (`Omit`, `Record`, `WithRequired`, `Extract`) are `reference` nodes with type
  * arguments, built by named constructors: the printer has nothing special to do for them.
@@ -35,7 +37,8 @@ export interface IrKeywordType {
 export interface IrStringLiteralType {
   readonly kind: "stringLiteral";
   readonly value: string;
-  readonly encoding: IrStringEncoding;
+  /** How the printer writes the value; unset is `json`. A detail of the printer. */
+  readonly encoding?: IrStringEncoding;
 }
 
 /** Finite number; a negative value prints with a leading minus sign. */
@@ -112,9 +115,9 @@ export interface IrRawType {
   readonly kind: "raw";
   readonly text: string;
   /**
-   * The outside node the text was printed from, opaque to the IR. While the Node API still
-   * returns `ts.Node`s (until Phase 6), the bridge hands this node back unchanged, exactly as the
-   * original did. Removed with the reverse bridge in Phase 6.
+   * @internal The TypeScript node the bridge printed the text from. The reverse bridge (the
+   * deprecated `ts.Node` callbacks, ADR-004) hands it back unchanged. Set by the generator only:
+   * read it as opaque, never set it, and expect it to go away in 2.0.
    */
   readonly origin?: unknown;
 }

package/src/domain/openapi/path-templates.ts

@@ -4,7 +4,8 @@
  * `/a/{name}`, match the same URLs, so a client cannot tell which one a request is for.
  */
 
-const PATH_PARAMETER_RE = /\{[^}]+\}/g;
+/** `[^{}]` keeps the scan linear: `[^}]` retried from every `{` of a long run of them. */
+const PATH_PARAMETER_RE = /\{[^{}]+\}/g;
 const PATH_PREFIX = "/";
 const UNNAMED_PARAMETER = "{}";
 

package/src/domain/output-fixes.ts

@@ -3,9 +3,10 @@ import { ERROR_CODES, OpenAPITypesafeError } from "./errors.js";
 /**
  * Opt-in fixes of the output of valid schemas (ADR-021). Each one changes only the cases it names;
  * without any, the output is the same as openapi-typescript 7.13 gives. In 2.0 they become the
- * default.
+ * default. The object names the fixes for this package's code; the public API is the `OutputFix`
+ * union and the `OUTPUT_FIXES` list (ADR-021, amendment 1).
  */
-export const OutputFix = {
+export const FIX = {
   /** An `allOf` `$ref` to a discriminated union is the union, without `Omit` or a schema name. */
   ALLOF_DISCRIMINATED_UNION: "allof-discriminated-union",
   /** An `allOf` member with only `required` makes those properties of the others required. */
@@ -48,18 +49,19 @@ export const OutputFix = {
   /** `unevaluatedProperties` types the keys no other keyword declares (an index signature). */
   UNEVALUATED_PROPERTIES: "unevaluated-properties",
 } as const;
-export type OutputFix = (typeof OutputFix)[keyof typeof OutputFix];
+/** The name of one opt-in output fix. */
+export type OutputFix = (typeof FIX)[keyof typeof FIX];
 
 /** Every fix of this version, in the order the docs list them. */
-export const OUTPUT_FIXES: readonly OutputFix[] = Object.values(OutputFix);
+export const OUTPUT_FIXES: readonly OutputFix[] = Object.values(FIX);
 
 /** The name that turns on every fix of the installed version. */
-export const ALL_OUTPUT_FIXES = "all";
+const ALL_FIXES = "all";
 
-/** A name the `fix` option accepts: one fix, or `all`. */
-export type OutputFixName = OutputFix | typeof ALL_OUTPUT_FIXES;
+/** A name the `fix` option accepts: one fix, or `"all"`. */
+export type OutputFixName = OutputFix | typeof ALL_FIXES;
 
-const KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_OUTPUT_FIXES]);
+const KNOWN_NAMES: ReadonlySet<string> = new Set<string>([...OUTPUT_FIXES, ALL_FIXES]);
 
 function isOutputFixName(value: unknown): value is OutputFixName {
   return typeof value === "string" && KNOWN_NAMES.has(value);
@@ -82,7 +84,7 @@ export function outputFixNamesOf(values: readonly unknown[]): readonly OutputFix
 
 /** The fixes the names turn on; `all` stands for every fix of this version. */
 export function resolveOutputFixes(names: readonly OutputFixName[]): ReadonlySet<OutputFix> {
-  return new Set(names.flatMap((name) => (name === ALL_OUTPUT_FIXES ? OUTPUT_FIXES : [name])));
+  return new Set(names.flatMap((name) => (name === ALL_FIXES ? OUTPUT_FIXES : [name])));
 }
 
 /** A generator option that a fix works with; without it, the fix changes nothing (ADR-021). */
@@ -106,13 +108,11 @@ const NO_SCHEMA_PREFIX = {
 
 /** The options each fix needs, by fix name; `all` has none. */
 const REQUIREMENTS: Readonly<Partial<Record<OutputFixName, readonly OutputFixRequirement[]>>> = {
-  [OutputFix.ARRAY_LENGTH_TUPLES]: [{ option: "arrayLength", flag: "--array-length" }],
-  [OutputFix.DEDUPE_ENUM_NAMES]: [ENUM, { option: "dedupeEnums", flag: "--dedupe-enums" }],
-  [OutputFix.NULLABLE_ENUMS]: [ENUM],
-  [OutputFix.PATH_PARAM_TYPE_NAMES]: [
-    { option: "pathParamsAsTypes", flag: "--path-params-as-types" },
-  ],
-  [OutputFix.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX],
+  [FIX.ARRAY_LENGTH_TUPLES]: [{ option: "arrayLength", flag: "--array-length" }],
+  [FIX.DEDUPE_ENUM_NAMES]: [ENUM, { option: "dedupeEnums", flag: "--dedupe-enums" }],
+  [FIX.NULLABLE_ENUMS]: [ENUM],
+  [FIX.PATH_PARAM_TYPE_NAMES]: [{ option: "pathParamsAsTypes", flag: "--path-params-as-types" }],
+  [FIX.ROOT_TYPE_NUMBERING]: [ROOT_TYPES, NO_SCHEMA_PREFIX],
 };
 
 function describeRequirement(requirement: OutputFixRequirement): string {

package/src/domain/url-credentials.ts

@@ -0,0 +1,18 @@
+/**
+ * URLs with user info (`https://user:token@host/…`) can reach a message: the CLI input, a `$ref`,
+ * a redirect. Messages end up in CI job logs, so the user info is hidden in every one (audit B2,
+ * F12). Fetch refuses such URLs anyway, so a message never needs the credentials.
+ */
+
+/**
+ * The user info after a scheme: everything up to an `@` that comes before the end of the
+ * authority. The class stops at `/`, so a scan never runs past the next `://`; it stays linear.
+ */
+const URL_USER_INFO = /:\/\/[^\s/?#@]*@/g;
+
+const REDACTED_USER_INFO = "://***@";
+
+/** The text with the user info of every URL in it replaced by `***`. */
+export function redactUrlCredentials(text: string): string {
+  return text.replace(URL_USER_INFO, () => REDACTED_USER_INFO);
+}

package/src/domain/warnings.ts

@@ -6,10 +6,17 @@
 
 /** Every warning code. */
 export const WARNING_CODES = {
+  CLI_INPUT_IGNORED: "CLI_INPUT_IGNORED",
+  CONFIG_SETTING_UNKNOWN: "CONFIG_SETTING_UNKNOWN",
+  DISCRIMINATOR_MAPPING_INVALID: "DISCRIMINATOR_MAPPING_INVALID",
   DISCRIMINATOR_VALUE_NOT_ALLOWED: "DISCRIMINATOR_VALUE_NOT_ALLOWED",
   ENUM_VALUES_EXCLUDED: "ENUM_VALUES_EXCLUDED",
+  FIX_NEEDS_OPTION: "FIX_NEEDS_OPTION",
+  LINT_PROBLEM: "LINT_PROBLEM",
   PATH_TEMPLATES_IDENTICAL: "PATH_TEMPLATES_IDENTICAL",
   QUERYSTRING_NEXT_TO_QUERY: "QUERYSTRING_NEXT_TO_QUERY",
+  REF_CIRCULAR: "REF_CIRCULAR",
+  REF_NOT_FOUND: "REF_NOT_FOUND",
 } as const;
 
 export type WarningCode = (typeof WARNING_CODES)[keyof typeof WARNING_CODES];

package/src/index.ts

@@ -34,6 +34,7 @@ export {
   UNDEFINED,
   UNKNOWN,
 } from "./api/type-helpers.js";
+export { DEPRECATION_CODES, type DeprecationCode } from "./domain/deprecations.js";
 export {
   ERROR_CODES,
   type ErrorCode,
@@ -42,12 +43,8 @@ export {
   OpenAPITypesafeError,
 } from "./domain/errors.js";
 export type * from "./domain/ir/nodes.js";
-export {
-  ALL_OUTPUT_FIXES,
-  OUTPUT_FIXES,
-  OutputFix,
-  type OutputFixName,
-} from "./domain/output-fixes.js";
+export { OUTPUT_FIXES, type OutputFix, type OutputFixName } from "./domain/output-fixes.js";
+export { WARNING_CODES, type WarningCode } from "./domain/warnings.js";
 export { default as transformComponentsObject } from "./transform/components-object.js";
 export { default as transformHeaderObject } from "./transform/header-object.js";
 export { default as transformMediaTypeObject } from "./transform/media-type-object.js";

package/src/transform/path-item-object.ts

@@ -1,10 +1,14 @@
 import { createTransformContext, schemaLocation } from "../api/transform-context.js";
 import { pathItemType } from "../application/transform/document/path-item.js";
 import type { IrType } from "../domain/ir/nodes.js";
-import type { HttpMethod } from "../domain/openapi/path-item-object.js";
+import type { PathItemMethod } from "../domain/openapi/path-item-object.js";
 import type { PathItemObject, TransformNodeOptions } from "../types.js";
 
-export type Method = HttpMethod;
+/**
+ * The operation methods of a path item: openapi-typescript's eight, plus the OpenAPI 3.2 `query`
+ * (ADR-020), as `HttpMethod` of openapi-typesafe-helpers lists them.
+ */
+export type Method = PathItemMethod;
 
 /**
  * Transform PathItem nodes (4.8.9)

package/src/types/generator-options.ts

@@ -3,8 +3,6 @@ import type { Readable } from "node:stream";
 import type { Config as RedoclyConfig } from "@redocly/openapi-core";
 import type { ts } from "../adapters/type-ast-bridge/typescript-types.js";
 import type { FooterEntry } from "../api/footer-entry.js";
-import type { Logger } from "../application/ports/logger.js";
-import type { DocumentFooter } from "../application/transform/transform-context.js";
 import type { IrPropertySignature, IrType } from "../domain/ir/nodes.js";
 import type { OutputFix, OutputFixName } from "../domain/output-fixes.js";
 import type { ReferenceObject } from "./openapi-common.js";
@@ -74,7 +72,7 @@ export interface OpenAPITSBaseOptions {
   lint?: boolean;
   /** (optional) Should logging be suppressed? (necessary for STDOUT) */
   silent?: boolean;
-  /** (optional) OpenAPI version. Must be present if parsing raw schema */
+  /** Accepted for compatibility with openapi-typescript; not read. */
   version?: number;
   /** (optional) Export type instead of interface */
   exportType?: boolean;
@@ -197,28 +195,22 @@ export interface OpenAPITSIrOptions extends OpenAPITSBaseOptions, IrCallbackOpti
 /** Either form of the generator options. */
 export type GeneratorOptions = OpenAPITSOptions | OpenAPITSIrOptions;
 
-/** Context passed to all submodules */
+/**
+ * Context passed to all submodules, and to the callbacks as `options.ctx`. To call an exported
+ * transformer outside a run, build one with the fields of openapi-typescript's context; the
+ * fields openapi-typesafe added are optional.
+ */
 export interface GlobalContext {
   // user options
   additionalProperties: boolean;
   alphabetize: boolean;
   arrayLength: boolean;
-  binaryAsBlob: boolean;
+  /** `format: binary` and `contentMediaType` strings become `Blob` (default: false). */
+  binaryAsBlob?: boolean;
   defaultNonNullable: boolean;
   discriminators: {
     objects: Record<string, DiscriminatorObject>;
     refsHandled: string[];
-    /**
-     * @internal With the `discriminator-values` fix: for each enum the scan added to a
-     * member and each inherited discriminator object, the enum of the owner's property and the
-     * location it is typed at.
-     */
-    enumParents?: ReadonlyMap<object, { readonly schema: SchemaObject; readonly path: string }>;
-    /**
-     * @internal With the `discriminator-values` fix: for each schema, the properties of the
-     * discriminators it inherits besides `objects[ref]`, which it redefines too.
-     */
-    otherProperties?: Readonly<Record<string, readonly string[]>>;
   };
   emptyObjectsUnknown: boolean;
   enum: boolean;
@@ -235,24 +227,12 @@ export interface GlobalContext {
    * callbacks may add IR declarations or TypeScript nodes.
    */
   injectFooter: FooterEntry[];
+  pathParamsAsTypes: boolean;
   /**
-   * @internal Footer state of this run (enum registry and enum naming), created on first use by
-   * the transform context adapter. Not an option; do not set it.
-   */
-  runFooter?: DocumentFooter;
-  /**
-   * @internal The deprecated callback forms this run has warned about (once each). Not an
-   * option; do not set it.
-   */
-  legacyCallbackWarnings?: Set<LegacyCallbackName>;
-  /**
-   * @internal Where this run reports warnings and debug output. Not an option; a context without
-   * it logs to the terminal.
+   * Whether the callbacks below take IR (`OpenAPITSIrOptions`) or TypeScript nodes
+   * (default: false, TypeScript nodes).
    */
-  logger?: Logger;
-  pathParamsAsTypes: boolean;
-  /** Whether the callbacks below take IR (`OpenAPITSIrOptions`) or TypeScript nodes. */
-  irCallbacks: boolean;
+  irCallbacks?: boolean;
   postTransform: GeneratorOptions["postTransform"];
   propertiesRequiredByDefault: boolean;
   rootTypes: boolean;

package/src/types/openapi-common.ts

@@ -7,6 +7,7 @@
 // for ways schemas _can_ be written, not necessarily how they _should_ be.
 
 export interface Extensable {
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   [key: `x-${string}`]: any;
 }
 

package/src/types/openapi-request.ts

@@ -67,6 +67,7 @@ export interface ParameterObject extends Extensable {
   /** The schema defining the type used for the parameter. */
   schema?: SchemaObject;
   /** Example of the parameter’s potential value. */
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   example?: any;
   /** Examples of the parameter’s potential value. */
   examples?: { [name: string]: ExampleObject | ReferenceObject };
@@ -111,6 +112,7 @@ export interface MediaTypeObject extends Extensable {
    * referencing a schema which contains an example, the example value SHALL override the example
    * provided by the schema.
    */
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   example?: any;
   /**
    * Examples of the media type. Each example object SHOULD match the media type and specified
@@ -188,6 +190,7 @@ export interface ExampleObject extends Extensable {
    * represent examples of media types that cannot naturally represented in JSON or YAML, use a
    * string value to contain the example, escaping where necessary.
    */
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   value?: any;
   /**
    * A URI that points to the literal example. This provides the capability to reference examples

package/src/types/openapi-schema.ts

@@ -21,6 +21,7 @@ export type SchemaObject = {
   /** Additional external documentation for this schema. */
   externalDocs?: ExternalDocumentationObject;
   /** @deprecated */
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   example?: any;
   title?: string;
   description?: string;
@@ -47,6 +48,7 @@ export type SchemaObject = {
   allOf?: (SchemaObject | ReferenceObject)[];
   anyOf?: (SchemaObject | ReferenceObject)[];
   required?: string[];
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   [key: `x-${string}`]: any;
 } & (
   | StringSubtype

package/src/types/openapi-security.ts

@@ -10,6 +10,7 @@ export type SecuritySchemeObject = {
    * A description for security scheme. CommonMark syntax MAY be used for rich text representation.
    */
   description?: string;
+  // biome-ignore lint/suspicious/noExplicitAny: public type under semver (ADR-034)
   [key: `x-${string}`]: any;
 } & (
   | {