@hey-api/openapi-ts 0.54.0 → 0.54.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -427,7 +427,7 @@ interface OpenApiV3_1_0 {
427
427
  /**
428
428
  * An element to hold various schemas for the document.
429
429
  */
430
- components?: ComponentsObject;
430
+ components?: ComponentsObject$1;
431
431
  /**
432
432
  * Additional external documentation.
433
433
  */
@@ -443,7 +443,7 @@ interface OpenApiV3_1_0 {
443
443
  /**
444
444
  * **REQUIRED**. This string MUST be the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#versions version number} of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#infoVersion `info.version`} string.
445
445
  */
446
- openapi: '3.1.0';
446
+ openapi: '3.1.0' | '3.1.1';
447
447
  /**
448
448
  * The available paths and operations for the API.
449
449
  */
@@ -643,7 +643,7 @@ interface CallbackObject {
643
643
  * read:pets: read your pets
644
644
  * ```
645
645
  */
646
- interface ComponentsObject {
646
+ interface ComponentsObject$1 {
647
647
  /**
648
648
  * An object to hold reusable {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object Callback Objects}.
649
649
  */
@@ -3200,14 +3200,6 @@ interface Client$1 {
3200
3200
  version: string;
3201
3201
  }
3202
3202
 
3203
- interface OpenApiV3_0_3 {
3204
- /**
3205
- * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
3206
- */
3207
- openapi: '3.0.3';
3208
- // TODO
3209
- }
3210
-
3211
3203
  /**
3212
3204
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object
3213
3205
  */
@@ -3283,6 +3275,26 @@ interface Client extends Omit<Client$1, 'operations'> {
3283
3275
  services: Service[];
3284
3276
  }
3285
3277
 
3278
+ /**
3279
+ * This is the root object of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#openapi-description OpenAPI Description}.
3280
+ *
3281
+ * This object MAY be extended with {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#specification-extensions Specification Extensions}.
3282
+ */
3283
+ interface OpenApiV3_0_0 {
3284
+ /**
3285
+ * An element to hold various Objects for the OpenAPI Description.
3286
+ */
3287
+ components?: ComponentsObject;
3288
+ /**
3289
+ * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
3290
+ */
3291
+ openapi: '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.0.4';
3292
+ // TODO
3293
+ }
3294
+
3295
+ // TODO
3296
+ interface ComponentsObject {}
3297
+
3286
3298
  /**
3287
3299
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
3288
3300
  * given language it will generate the client, including the typed models, validation schemas,
@@ -3299,4 +3311,4 @@ declare const _default: {
3299
3311
  defineConfig: (config: UserConfig) => UserConfig;
3300
3312
  };
3301
3313
 
3302
- export { type OpenApiV3_0_3, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };
3314
+ export { type OpenApiV3_0_0, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };
package/dist/index.d.ts CHANGED
@@ -427,7 +427,7 @@ interface OpenApiV3_1_0 {
427
427
  /**
428
428
  * An element to hold various schemas for the document.
429
429
  */
430
- components?: ComponentsObject;
430
+ components?: ComponentsObject$1;
431
431
  /**
432
432
  * Additional external documentation.
433
433
  */
@@ -443,7 +443,7 @@ interface OpenApiV3_1_0 {
443
443
  /**
444
444
  * **REQUIRED**. This string MUST be the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#versions version number} of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#infoVersion `info.version`} string.
445
445
  */
446
- openapi: '3.1.0';
446
+ openapi: '3.1.0' | '3.1.1';
447
447
  /**
448
448
  * The available paths and operations for the API.
449
449
  */
@@ -643,7 +643,7 @@ interface CallbackObject {
643
643
  * read:pets: read your pets
644
644
  * ```
645
645
  */
646
- interface ComponentsObject {
646
+ interface ComponentsObject$1 {
647
647
  /**
648
648
  * An object to hold reusable {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-object Callback Objects}.
649
649
  */
@@ -3200,14 +3200,6 @@ interface Client$1 {
3200
3200
  version: string;
3201
3201
  }
3202
3202
 
3203
- interface OpenApiV3_0_3 {
3204
- /**
3205
- * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
3206
- */
3207
- openapi: '3.0.3';
3208
- // TODO
3209
- }
3210
-
3211
3203
  /**
3212
3204
  * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#external-documentation-object
3213
3205
  */
@@ -3283,6 +3275,26 @@ interface Client extends Omit<Client$1, 'operations'> {
3283
3275
  services: Service[];
3284
3276
  }
3285
3277
 
3278
+ /**
3279
+ * This is the root object of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#openapi-description OpenAPI Description}.
3280
+ *
3281
+ * This object MAY be extended with {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md#specification-extensions Specification Extensions}.
3282
+ */
3283
+ interface OpenApiV3_0_0 {
3284
+ /**
3285
+ * An element to hold various Objects for the OpenAPI Description.
3286
+ */
3287
+ components?: ComponentsObject;
3288
+ /**
3289
+ * **REQUIRED**. This string MUST be the {@link https://semver.org/spec/v2.0.0.html semantic version number} of the {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#versions OpenAPI Specification version} that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#infoVersion `info.version`} string.
3290
+ */
3291
+ openapi: '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.0.4';
3292
+ // TODO
3293
+ }
3294
+
3295
+ // TODO
3296
+ interface ComponentsObject {}
3297
+
3286
3298
  /**
3287
3299
  * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
3288
3300
  * given language it will generate the client, including the typed models, validation schemas,
@@ -3299,4 +3311,4 @@ declare const _default: {
3299
3311
  defineConfig: (config: UserConfig) => UserConfig;
3300
3312
  };
3301
3313
 
3302
- export { type OpenApiV3_0_3, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };
3314
+ export { type OpenApiV3_0_0, type OpenApiV3_1_0, type UserConfig, createClient, _default as default, defineConfig };