Skip to content

Commit d00fd91

Browse files
authored
fix(interface): remove internal tags from OpenAPI types. (#1812)
* fix(interface): remove internal tags from OpenAPI types. * fix export * fix typos
1 parent 1e5168c commit d00fd91

File tree

5 files changed

+17
-12
lines changed

5 files changed

+17
-12
lines changed

packages/interface/src/openapi/OpenApiV3.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ export namespace OpenApiV3 {
158158
/**
159159
* Non-standard HTTP method operations (extension).
160160
*
161-
* Used when downgrading from OpenAPI v3.2 to preserve
162-
* non-standard methods like `query` or custom methods.
161+
* Used when downgrading from OpenAPI v3.2 to preserve non-standard methods
162+
* like `query` or custom methods.
163163
*/
164164
"x-additionalOperations"?: Record<string, IOperation>;
165165
}
@@ -545,7 +545,7 @@ export namespace OpenApiV3 {
545545
default?: any;
546546
}
547547

548-
/** @internal Base attribute interface. */
548+
/** @ignore Base Attribute interface. */
549549
export interface __IAttribute extends Omit<
550550
IJsonSchemaAttribute,
551551
"examples"

packages/interface/src/openapi/OpenApiV3_1.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,8 @@ export namespace OpenApiV3_1 {
174174
/**
175175
* Non-standard HTTP method operations (extension).
176176
*
177-
* Used when downgrading from OpenAPI v3.2 to preserve
178-
* non-standard methods like `query` or custom methods.
177+
* Used when downgrading from OpenAPI v3.2 to preserve non-standard methods
178+
* like `query` or custom methods.
179179
*/
180180
"x-additionalOperations"?: Record<string, IOperation>;
181181
}
@@ -625,7 +625,7 @@ export namespace OpenApiV3_1 {
625625
default?: any;
626626
}
627627

628-
/** @internal Base attribute interface. */
628+
/** @ignore Base Attribute interface. */
629629
export interface __IAttribute extends Omit<
630630
IJsonSchemaAttribute,
631631
"examples"

packages/interface/src/openapi/OpenApiV3_2.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,10 @@ export namespace OpenApiV3_2 {
182182
/** Path description. */
183183
description?: string;
184184

185-
/** Additional non-standard HTTP method operations (e.g., LINK, UNLINK, PURGE). */
185+
/**
186+
* Additional non-standard HTTP method operations (e.g., LINK, UNLINK,
187+
* PURGE).
188+
*/
186189
additionalOperations?: Record<string, IOperation>;
187190
}
188191

@@ -634,7 +637,7 @@ export namespace OpenApiV3_2 {
634637
default?: any;
635638
}
636639

637-
/** @internal Base attribute interface. */
640+
/** @ignore Base Attribute interface. */
638641
export interface __IAttribute extends Omit<
639642
IJsonSchemaAttribute,
640643
"examples"

packages/interface/src/openapi/SwaggerV2.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ export namespace SwaggerV2 {
141141
/**
142142
* Non-standard HTTP method operations (extension).
143143
*
144-
* Used when downgrading from OpenAPI v3.2 to preserve
145-
* non-standard methods like `query` or custom methods.
144+
* Used when downgrading from OpenAPI v3.2 to preserve non-standard methods
145+
* like `query` or custom methods.
146146
*/
147147
"x-additionalOperations"?: Record<string, IOperation>;
148148
}
@@ -434,7 +434,7 @@ export namespace SwaggerV2 {
434434
type?: undefined;
435435
}
436436

437-
/** @internal Base interface with type discriminator. */
437+
/** @ignore Base Interface with type discriminator. */
438438
export interface __ISignificant<Type extends string> extends __IAttribute {
439439
/** Type discriminator. */
440440
type: Type;
@@ -443,7 +443,7 @@ export namespace SwaggerV2 {
443443
"x-nullable"?: boolean;
444444
}
445445

446-
/** @internal Base attribute interface. */
446+
/** @ignore Base Attribute interface. */
447447
export interface __IAttribute extends Omit<
448448
IJsonSchemaAttribute,
449449
"examples" | "writeOnly"

typos.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Nam = "Nam"
1111
typia = "typia"
1212
tru = "tru"
1313
fals = "fals"
14+
INPU = "INPU"
15+
INOT = "INOT"
1416

1517
[files]
1618
extend-exclude = [

0 commit comments

Comments
 (0)