mirror of
https://github.com/LukeHagar/openapi-types.git
synced 2025-12-06 04:20:29 +00:00
Saving progress on types packages
This commit is contained in:
44
index.ts
Normal file
44
index.ts
Normal file
@@ -0,0 +1,44 @@
|
||||
/**
|
||||
* OpenAPI Types - Comprehensive TypeScript definitions for all OpenAPI versions
|
||||
* @fileoverview Main entry point for OpenAPI type definitions
|
||||
* @version 1.0.0
|
||||
* @since 2024-12-19
|
||||
*
|
||||
* This library provides comprehensive TypeScript definitions for all OpenAPI specification versions:
|
||||
* - Swagger 2.0 (OpenAPI Specification v2.0)
|
||||
* - OpenAPI 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4
|
||||
* - OpenAPI 3.1.0, 3.1.1
|
||||
*
|
||||
* The library is organized with atomic building blocks (atoms/) that are shared across versions,
|
||||
* and version-specific implementations that extend or override these atoms as needed.
|
||||
*
|
||||
* ## Import Paths
|
||||
*
|
||||
* For the best developer experience, use these import paths:
|
||||
* - `oas-types/atoms` - Atomic building blocks
|
||||
* - `oas-types/utils` - Utility types
|
||||
* - `oas-types/common` - Common types and enums
|
||||
* - `oas-types/3.1.0` - OpenAPI 3.1.0 types
|
||||
* - `oas-types/3.0.0` - OpenAPI 3.0.0 types
|
||||
* - `oas-types/2.0` - Swagger 2.0 types
|
||||
*
|
||||
* @see {@link https://swagger.io/specification/v2/ Swagger 2.0 Specification}
|
||||
* @see {@link https://spec.openapis.org/oas/v3.0.0 OpenAPI 3.0.0 Specification}
|
||||
* @see {@link https://spec.openapis.org/oas/v3.1.0 OpenAPI 3.1.0 Specification}
|
||||
* @see {@link https://spec.openapis.org/oas/v3.1.1 OpenAPI 3.1.1 Specification}
|
||||
*/
|
||||
|
||||
// Atomic building blocks - core types shared across all versions
|
||||
export * from './versions/atoms';
|
||||
|
||||
// Common utilities and shared types
|
||||
export * from './versions/common';
|
||||
|
||||
// Version-specific exports
|
||||
export * as OpenAPI3_0_0 from './versions/3.0.x';
|
||||
export * as OpenAPI3_0_1 from './versions/3.0.1';
|
||||
export * as OpenAPI3_0_2 from './versions/3.0.2';
|
||||
export * as OpenAPI3_0_3 from './versions/3.0.3';
|
||||
export * as OpenAPI3_0_4 from './versions/3.0.4';
|
||||
export * as OpenAPI3_1_0 from './versions/3.1.0';
|
||||
export * as OpenAPI3_1_1 from './versions/3.1.1';
|
||||
Reference in New Issue
Block a user