@ahoo-wang/fetcher-openapi
Version:
OpenAPI Specification TypeScript types for Fetcher - A modern, ultra-lightweight HTTP client for browsers and Node.js. Provides complete TypeScript support with type inference for OpenAPI 3.x schemas.
46 lines • 1.86 kB
TypeScript
import { Reference } from './reference';
import { Schema } from './schema';
import { Response, Link, Callback } from './responses';
import { Parameter, RequestBody } from './parameters';
import { SecurityScheme } from './security';
import { Example, Header } from './base-types';
import { Extensible } from './extensions';
/**
* Holds a set of reusable objects for different aspects of the OAS
*
* @property schemas - An object to hold reusable Schema Objects
* @property responses - An object to hold reusable Response Objects
* @property parameters - An object to hold reusable Parameter Objects
* @property examples - An object to hold reusable Example Objects
* @property requestBodies - An object to hold reusable Request Body Objects
* @property headers - An object to hold reusable Header Objects
* @property securitySchemes - An object to hold reusable Security Scheme Objects
* @property links - An object to hold reusable Link Objects
* @property callbacks - An object to hold reusable Callback Objects
*/
export interface Components extends Extensible {
schemas?: Record<string, Schema>;
responses?: Record<string, Response>;
parameters?: Record<string, Parameter>;
examples?: Record<string, Example | Reference>;
requestBodies?: Record<string, RequestBody>;
headers?: Record<string, Header | Reference>;
securitySchemes?: Record<string, SecurityScheme>;
links?: Record<string, Link>;
callbacks?: Record<string, Callback>;
}
/**
* Mapping of component types to their respective interfaces
*/
export type ComponentTypeMap = {
schemas: Schema;
responses: Response;
parameters: Parameter;
examples: Example;
requestBodies: RequestBody;
headers: Header;
securitySchemes: SecurityScheme;
links: Link;
callbacks: Callback;
};
//# sourceMappingURL=components.d.ts.map