Types

All types are exported from the main package entry point.

import type {
  OpenAPIDocument,
  OpenAPIOperation,
  PostmanCollection,
  JSONSchema,
  NormalizeOptions,
  ConvertOptions,
  // ... etc
} from 'openapi-normalizer';

OpenAPI Types

OpenAPIDocument

interface OpenAPIDocument {
  openapi: string;
  info: OpenAPIInfo;
  servers?: OpenAPIServer[];
  paths?: Record<string, OpenAPIPathItem>;
  components?: OpenAPIComponents;
  tags?: OpenAPITag[];
  security?: OpenAPISecurityRequirement[];
}

OpenAPIInfo

interface OpenAPIInfo {
  title: string;
  version: string;
  description?: string;
  contact?: Record<string, unknown>;
  license?: { name: string; url?: string };
}

OpenAPIOperation

interface OpenAPIOperation {
  tags?: string[];
  summary?: string;
  description?: string;
  operationId?: string;
  parameters?: OpenAPIParameter[];
  requestBody?: OpenAPIRequestBody;
  responses?: Record<string, OpenAPIResponse>;
  security?: OpenAPISecurityRequirement[];
}

OpenAPIParameter

interface OpenAPIParameter {
  name: string;
  in: 'query' | 'header' | 'path' | 'cookie';
  description?: string;
  required?: boolean;
  schema?: JSONSchema;
  example?: unknown;
}

OpenAPIMediaType

interface OpenAPIMediaType {
  schema?: JSONSchema;
  example?: unknown;
  examples?: Record<string, OpenAPIExample>;
}

JSONSchema

interface JSONSchema {
  type?: string;
  properties?: Record<string, JSONSchema>;
  items?: JSONSchema;
  additionalProperties?: JSONSchema | boolean;
  oneOf?: JSONSchema[];
  anyOf?: JSONSchema[];
  allOf?: JSONSchema[];
  nullable?: boolean;
  example?: unknown;
  format?: string;
  enum?: unknown[];
}

Postman Types

PostmanCollection

interface PostmanCollection {
  info: PostmanInfo;
  item: PostmanItem[];
  variable?: PostmanVariable[];
  auth?: PostmanAuth;
}

PostmanAuth

interface PostmanAuth {
  type: string;
  [key: string]: unknown;
}

PostmanItem

// A PostmanItem is either a folder or a request
type PostmanItem = PostmanFolder | PostmanRequest;

interface PostmanFolder {
  name: string;
  item: PostmanItem[];
  description?: string;
}

interface PostmanRequest {
  name: string;
  id?: string;
  request: PostmanRequestDef;
  response: PostmanResponse[];
}

PostmanResponse

interface PostmanResponse {
  id?: string;
  name: string;
  originalRequest?: PostmanRequestDef;
  status?: string;
  code?: number;
  header?: PostmanHeader[];
  body?: string;
}

Utility Types

HttpMethod

type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';

Options Types

NormalizeOptions

interface NormalizeOptions {
  /** Header names to preserve even if they are in the noisy-header list. */
  preserveHeaders?: string[];
  /** Additional header names to treat as noisy (removed from responses). */
  additionalNoisyHeaders?: string[];
  /** Remove all `x-*` vendor extension keys from the document. */
  stripXExtensions?: boolean;
  /** Keep named `examples` instead of collapsing to a single `example`. */
  keepExamples?: boolean;
  /** Control whether schemas are inferred from example values (default: true). */
  inferSchemas?: boolean;
}

ConvertOptions

interface ConvertOptions {
  /** Track which properties appear in ALL examples and mark them `required`. */
  inferRequired?: boolean;
  /** Detect string formats (uuid, date-time, email, uri, ipv4, ipv6) from example values. */
  inferFormats?: boolean;
  /** Use Postman folder names as tags (default: true). */
  tagFromFolder?: boolean;
  /** Style for generated operationIds. */
  operationIdStyle?: 'camelCase' | 'snake_case' | 'kebab-case';
  /** Override the default fallback Content-Type (default: 'application/json'). */
  defaultContentType?: string;
}