@visulima/jsdoc-open-api 3.0.0-alpha.3 → 3.0.0-alpha.5
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/CHANGELOG.md +39 -0
- package/LICENSE.md +1 -1
- package/dist/cli/command/generate-command.d.cts +7 -0
- package/dist/cli/command/generate-command.d.mts +7 -0
- package/dist/cli/command/generate-command.d.ts +7 -0
- package/dist/cli/command/init-command.d.cts +2 -0
- package/dist/cli/command/init-command.d.mts +2 -0
- package/dist/cli/command/init-command.d.ts +2 -0
- package/dist/cli/commander/command/generate-command.d.cts +3 -0
- package/dist/cli/commander/command/generate-command.d.mts +3 -0
- package/dist/cli/commander/command/generate-command.d.ts +3 -0
- package/dist/cli/commander/command/init-command.d.cts +3 -0
- package/dist/cli/commander/command/init-command.d.mts +3 -0
- package/dist/cli/commander/command/init-command.d.ts +3 -0
- package/dist/cli/commander/index.cjs +11 -0
- package/dist/cli/commander/index.d.cts +2 -0
- package/dist/cli/commander/index.d.mts +2 -7
- package/dist/cli/commander/index.d.ts +2 -7
- package/dist/cli/commander/index.mjs +2 -30
- package/dist/cli/index.cjs +11 -0
- package/dist/cli/index.d.cts +2 -0
- package/dist/cli/index.d.mts +2 -10
- package/dist/cli/index.d.ts +2 -10
- package/dist/cli/index.mjs +2 -4
- package/dist/constants.d.cts +1 -0
- package/dist/constants.d.mts +1 -0
- package/dist/constants.d.ts +1 -0
- package/dist/exported.d.cts +198 -0
- package/dist/exported.d.mts +198 -0
- package/dist/exported.d.ts +198 -0
- package/dist/index.cjs +19 -0
- package/dist/index.d.cts +7 -0
- package/dist/index.d.mts +7 -248
- package/dist/index.d.ts +7 -248
- package/dist/index.mjs +6 -85
- package/dist/jsdoc/comments-to-open-api.d.cts +6 -0
- package/dist/jsdoc/comments-to-open-api.d.mts +6 -0
- package/dist/jsdoc/comments-to-open-api.d.ts +6 -0
- package/dist/packem_shared/SpecBuilder-B7YiF7zR.mjs +61 -0
- package/dist/packem_shared/SpecBuilder-CCESkmm5.cjs +63 -0
- package/dist/packem_shared/SwaggerCompilerPlugin-BEbFO9Dt.mjs +86 -0
- package/dist/packem_shared/SwaggerCompilerPlugin-BHbHAPK-.cjs +88 -0
- package/dist/packem_shared/customizer-CoMXMU7a.mjs +8 -0
- package/dist/packem_shared/customizer-DDFwFqJl.cjs +10 -0
- package/dist/packem_shared/generateCommand-B1t3VSDX.mjs +15 -0
- package/dist/packem_shared/generateCommand-CZEFuXr9.mjs +83 -0
- package/dist/packem_shared/generateCommand-CmyavGTZ.cjs +17 -0
- package/dist/packem_shared/generateCommand-Cu0UQUh8.cjs +85 -0
- package/dist/packem_shared/initCommand-B6Z9EXHP.mjs +15 -0
- package/dist/packem_shared/initCommand-Ch-72dKZ.cjs +65 -0
- package/dist/packem_shared/initCommand-D3yVEMwO.cjs +17 -0
- package/dist/packem_shared/initCommand-zE4VRDGW.mjs +63 -0
- package/dist/packem_shared/jsDocumentCommentsToOpenApi-C8kxIQH2.cjs +334 -0
- package/dist/packem_shared/jsDocumentCommentsToOpenApi-eOlxMuMO.mjs +328 -0
- package/dist/packem_shared/parseFile-BJwu_na4.cjs +42 -0
- package/dist/packem_shared/parseFile-Bxis7tbW.mjs +35 -0
- package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-Cb5s1J29.mjs +130 -0
- package/dist/packem_shared/swaggerJsDocumentCommentsToOpenApi-JFymRz50.cjs +137 -0
- package/dist/packem_shared/validate-DZHaKH07.mjs +30 -0
- package/dist/packem_shared/validate-FKieC3ln.cjs +37 -0
- package/dist/packem_shared/yamlLoc-BLoIYoXs.cjs +14 -0
- package/dist/packem_shared/yamlLoc-Cmx4vbRt.mjs +12 -0
- package/dist/parse-file.d.cts +9 -0
- package/dist/parse-file.d.mts +9 -0
- package/dist/parse-file.d.ts +9 -0
- package/dist/spec-builder.d.cts +14 -0
- package/dist/spec-builder.d.mts +14 -0
- package/dist/spec-builder.d.ts +14 -0
- package/dist/swagger-jsdoc/comments-to-open-api.d.cts +6 -0
- package/dist/swagger-jsdoc/comments-to-open-api.d.mts +6 -0
- package/dist/swagger-jsdoc/comments-to-open-api.d.ts +6 -0
- package/dist/swagger-jsdoc/organize-swagger-object.d.cts +7 -0
- package/dist/swagger-jsdoc/organize-swagger-object.d.mts +7 -0
- package/dist/swagger-jsdoc/organize-swagger-object.d.ts +7 -0
- package/dist/swagger-jsdoc/utils.d.cts +21 -0
- package/dist/swagger-jsdoc/utils.d.mts +21 -0
- package/dist/swagger-jsdoc/utils.d.ts +21 -0
- package/dist/util/customizer.d.cts +2 -0
- package/dist/util/customizer.d.mts +2 -0
- package/dist/util/customizer.d.ts +2 -0
- package/dist/util/object-merge.d.cts +2 -0
- package/dist/util/object-merge.d.mts +2 -0
- package/dist/util/object-merge.d.ts +2 -0
- package/dist/util/yaml-loc.d.cts +2 -0
- package/dist/util/yaml-loc.d.mts +2 -0
- package/dist/util/yaml-loc.d.ts +2 -0
- package/dist/validate.d.cts +2 -0
- package/dist/validate.d.mts +2 -0
- package/dist/validate.d.ts +2 -0
- package/dist/webpack/swagger-compiler-plugin.d.cts +15 -0
- package/dist/webpack/swagger-compiler-plugin.d.mts +15 -0
- package/dist/webpack/swagger-compiler-plugin.d.ts +15 -0
- package/package.json +32 -19
- package/dist/chunk-46IWFMQ2.mjs +0 -1205
- package/dist/chunk-46IWFMQ2.mjs.map +0 -1
- package/dist/chunk-KI63G47G.mjs +0 -142
- package/dist/chunk-KI63G47G.mjs.map +0 -1
- package/dist/chunk-QK4CXNUY.js +0 -149
- package/dist/chunk-QK4CXNUY.js.map +0 -1
- package/dist/chunk-WEX5DMNT.js +0 -1223
- package/dist/chunk-WEX5DMNT.js.map +0 -1
- package/dist/cli/commander/index.js +0 -33
- package/dist/cli/commander/index.js.map +0 -1
- package/dist/cli/commander/index.mjs.map +0 -1
- package/dist/cli/index.js +0 -17
- package/dist/cli/index.js.map +0 -1
- package/dist/cli/index.mjs.map +0 -1
- package/dist/index.js +0 -106
- package/dist/index.js.map +0 -1
- package/dist/index.mjs.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,42 @@
|
|
|
1
|
+
## @visulima/jsdoc-open-api [3.0.0-alpha.5](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.4...@visulima/jsdoc-open-api@3.0.0-alpha.5) (2026-03-26)
|
|
2
|
+
|
|
3
|
+
### Bug Fixes
|
|
4
|
+
|
|
5
|
+
* **jsdoc-open-api:** use workspace:* for internal [@visulima](https://github.com/visulima) deps ([4f97e12](https://github.com/visulima/visulima/commit/4f97e125a8f84a5e8b9691b72e2f9c56c5d3a69b))
|
|
6
|
+
* **web:** improve build setup with incremental stats caching and prod install ([fe33e75](https://github.com/visulima/visulima/commit/fe33e75827586779b4b3a0c6d57b39f889ee6207))
|
|
7
|
+
|
|
8
|
+
### Documentation
|
|
9
|
+
|
|
10
|
+
* **cerebro,prisma-dmmf-transformer,jsdoc-open-api:** add comprehensive Fumadocs documentation ([891b308](https://github.com/visulima/visulima/commit/891b308a34bca2765a4a97ea450648d20d90e0cf))
|
|
11
|
+
|
|
12
|
+
### Miscellaneous Chores
|
|
13
|
+
|
|
14
|
+
* **api:** remove empty peerDependencies and optionalDependencies ([85142fa](https://github.com/visulima/visulima/commit/85142fa76729c238a59ac48265b5e33e31183abb))
|
|
15
|
+
* **api:** update dependencies ([f3b6f7c](https://github.com/visulima/visulima/commit/f3b6f7c956e8ae2c0da67773b3790f159c07de29))
|
|
16
|
+
* **jsdoc-open-api:** migrate deps to pnpm catalogs ([9a673ca](https://github.com/visulima/visulima/commit/9a673ca0d8235d0ff28a6fe9b150cf2ee37e78a4))
|
|
17
|
+
* **jsdoc-open-api:** update dependencies ([5a1248f](https://github.com/visulima/visulima/commit/5a1248f8fa408fc81bb07a5bf9ce8430b89c1f57))
|
|
18
|
+
* **jsdoc-open-api:** update dependencies ([f5d2a31](https://github.com/visulima/visulima/commit/f5d2a31a8fd163c321915a779c661b758b3e6f73))
|
|
19
|
+
* **jsdoc-open-api:** update tests, docs, and source formatting ([9526ec8](https://github.com/visulima/visulima/commit/9526ec8ebb3e0e506d50b2f6035faf0cbcaca205))
|
|
20
|
+
* sorting package.json ([430ed68](https://github.com/visulima/visulima/commit/430ed683d3e38e4c5c5530f787ca832f083b17e4))
|
|
21
|
+
* update lock file maintenance ([d83e716](https://github.com/visulima/visulima/commit/d83e71697b75d24704185b66bb521a934d2db02d))
|
|
22
|
+
* visulima website ([#591](https://github.com/visulima/visulima/issues/591)) ([59ab2e2](https://github.com/visulima/visulima/commit/59ab2e2befb03e51cd2088956f83d9b87de6d033))
|
|
23
|
+
* year update ([47f4105](https://github.com/visulima/visulima/commit/47f410596ce7190cfea36a073db32e0cec50bbcd))
|
|
24
|
+
|
|
25
|
+
### Code Refactoring
|
|
26
|
+
|
|
27
|
+
* **jsdoc-open-api:** replace read-pkg-up with @visulima/fs and migrate to packem ([be668e4](https://github.com/visulima/visulima/commit/be668e4dc21a3394bcdb22aecf416f9c27e08e0d))
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### Dependencies
|
|
31
|
+
|
|
32
|
+
* **@visulima/fs:** upgraded to 5.0.0-alpha.5
|
|
33
|
+
|
|
34
|
+
## @visulima/jsdoc-open-api [3.0.0-alpha.4](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.3...@visulima/jsdoc-open-api@3.0.0-alpha.4) (2026-01-17)
|
|
35
|
+
|
|
36
|
+
### Bug Fixes
|
|
37
|
+
|
|
38
|
+
* **jsdoc-open-api:** combine name and description for path-based YAML parsing ([68e7d23](https://github.com/visulima/visulima/commit/68e7d2395ab97de3221892afe03da27688df7569))
|
|
39
|
+
|
|
1
40
|
## @visulima/jsdoc-open-api [3.0.0-alpha.3](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@3.0.0-alpha.2...@visulima/jsdoc-open-api@3.0.0-alpha.3) (2025-12-27)
|
|
2
41
|
|
|
3
42
|
### Bug Fixes
|
package/LICENSE.md
CHANGED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
|
|
4
|
+
|
|
5
|
+
const generateCommand = require('../../packem_shared/generateCommand-CmyavGTZ.cjs');
|
|
6
|
+
const initCommand = require('../../packem_shared/initCommand-D3yVEMwO.cjs');
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
exports.generateCommand = generateCommand;
|
|
11
|
+
exports.initCommand = initCommand;
|
|
@@ -1,7 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
|
|
4
|
-
|
|
5
|
-
declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
|
|
6
|
-
|
|
7
|
-
export { generateCommand, initCommand };
|
|
1
|
+
export { default as generateCommand } from "./command/generate-command.d.mts";
|
|
2
|
+
export { default as initCommand } from "./command/init-command.d.mts";
|
|
@@ -1,7 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
declare const generateCommand: (program: Command, commandName?: string, configName?: string) => void;
|
|
4
|
-
|
|
5
|
-
declare const initCommand: (program: Command, commandName?: string, description?: string, configName?: string) => void;
|
|
6
|
-
|
|
7
|
-
export { generateCommand, initCommand };
|
|
1
|
+
export { default as generateCommand } from "./command/generate-command.d.ts";
|
|
2
|
+
export { default as initCommand } from "./command/init-command.d.ts";
|
|
@@ -1,30 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import { exit } from 'process';
|
|
4
|
-
|
|
5
|
-
var generateCommand = (program, commandName = "generate", configName = ".openapirc.js") => {
|
|
6
|
-
program.command(commandName).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]", "Paths to files or directories to parse").option("-c, --config [.openapirc.js]", "@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]", "Output swagger specification.").option("-v, --verbose", "Verbose output.").option("-d, --very-verbose", "Very verbose output.").action(async (paths, options) => {
|
|
7
|
-
try {
|
|
8
|
-
await generate_command_default(configName, paths, options);
|
|
9
|
-
} catch (error) {
|
|
10
|
-
console.error(error);
|
|
11
|
-
exit(1);
|
|
12
|
-
}
|
|
13
|
-
});
|
|
14
|
-
};
|
|
15
|
-
var generate_command_default2 = generateCommand;
|
|
16
|
-
var initCommand = (program, commandName = "init", description = "Inits a pre-configured @visulima/jsdoc-open-api config file.", configName = ".openapirc.js") => {
|
|
17
|
-
program.command(commandName).description(description).action(() => {
|
|
18
|
-
try {
|
|
19
|
-
init_command_default(configName);
|
|
20
|
-
} catch (error) {
|
|
21
|
-
console.error(error);
|
|
22
|
-
exit(1);
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
};
|
|
26
|
-
var init_command_default2 = initCommand;
|
|
27
|
-
|
|
28
|
-
export { generate_command_default2 as generateCommand, init_command_default2 as initCommand };
|
|
29
|
-
//# sourceMappingURL=index.mjs.map
|
|
30
|
-
//# sourceMappingURL=index.mjs.map
|
|
1
|
+
export { default as generateCommand } from '../../packem_shared/generateCommand-B1t3VSDX.mjs';
|
|
2
|
+
export { default as initCommand } from '../../packem_shared/initCommand-B6Z9EXHP.mjs';
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
|
|
4
|
+
|
|
5
|
+
const generateCommand = require('../packem_shared/generateCommand-Cu0UQUh8.cjs');
|
|
6
|
+
const initCommand = require('../packem_shared/initCommand-Ch-72dKZ.cjs');
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
exports.generateCommand = generateCommand;
|
|
11
|
+
exports.initCommand = initCommand;
|
package/dist/cli/index.d.mts
CHANGED
|
@@ -1,10 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
output?: string;
|
|
4
|
-
verbose?: boolean;
|
|
5
|
-
veryVerbose?: boolean;
|
|
6
|
-
}) => Promise<void>;
|
|
7
|
-
|
|
8
|
-
declare const initCommand: (configName: string, packageJsonPath?: string) => void;
|
|
9
|
-
|
|
10
|
-
export { generateCommand, initCommand };
|
|
1
|
+
export { default as generateCommand } from "./command/generate-command.d.mts";
|
|
2
|
+
export { default as initCommand } from "./command/init-command.d.mts";
|
package/dist/cli/index.d.ts
CHANGED
|
@@ -1,10 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
output?: string;
|
|
4
|
-
verbose?: boolean;
|
|
5
|
-
veryVerbose?: boolean;
|
|
6
|
-
}) => Promise<void>;
|
|
7
|
-
|
|
8
|
-
declare const initCommand: (configName: string, packageJsonPath?: string) => void;
|
|
9
|
-
|
|
10
|
-
export { generateCommand, initCommand };
|
|
1
|
+
export { default as generateCommand } from "./command/generate-command.d.ts";
|
|
2
|
+
export { default as initCommand } from "./command/init-command.d.ts";
|
package/dist/cli/index.mjs
CHANGED
|
@@ -1,4 +1,2 @@
|
|
|
1
|
-
export {
|
|
2
|
-
|
|
3
|
-
//# sourceMappingURL=index.mjs.map
|
|
4
|
-
//# sourceMappingURL=index.mjs.map
|
|
1
|
+
export { default as generateCommand } from '../packem_shared/generateCommand-CZEFuXr9.mjs';
|
|
2
|
+
export { default as initCommand } from '../packem_shared/initCommand-zE4VRDGW.mjs';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const DEFAULT_EXCLUDE: string[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const DEFAULT_EXCLUDE: string[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const DEFAULT_EXCLUDE: string[];
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
export interface BaseDefinition {
|
|
2
|
+
components?: ComponentsObject;
|
|
3
|
+
externalDocs?: ExternalDocumentationObject;
|
|
4
|
+
info: InfoObject;
|
|
5
|
+
openapi: string;
|
|
6
|
+
paths?: PathsObject;
|
|
7
|
+
security?: SecurityRequirementObject[];
|
|
8
|
+
servers?: ServerObject[];
|
|
9
|
+
tags?: TagObject[];
|
|
10
|
+
}
|
|
11
|
+
export interface OpenApiObject extends BaseDefinition {
|
|
12
|
+
paths?: PathsObject;
|
|
13
|
+
}
|
|
14
|
+
export interface InfoObject {
|
|
15
|
+
contact?: ContactObject;
|
|
16
|
+
description?: string;
|
|
17
|
+
license?: LicenseObject;
|
|
18
|
+
termsOfService?: string;
|
|
19
|
+
title: string;
|
|
20
|
+
version: string;
|
|
21
|
+
}
|
|
22
|
+
export interface ContactObject {
|
|
23
|
+
email?: string;
|
|
24
|
+
name?: string;
|
|
25
|
+
url?: string;
|
|
26
|
+
}
|
|
27
|
+
export interface LicenseObject {
|
|
28
|
+
name: string;
|
|
29
|
+
url?: string;
|
|
30
|
+
}
|
|
31
|
+
export interface ServerObject {
|
|
32
|
+
description?: string;
|
|
33
|
+
url: string;
|
|
34
|
+
variables?: Map<ServerVariable>;
|
|
35
|
+
}
|
|
36
|
+
export interface ServerVariable {
|
|
37
|
+
default: string;
|
|
38
|
+
description?: string;
|
|
39
|
+
enum?: string[];
|
|
40
|
+
}
|
|
41
|
+
export interface ComponentsObject {
|
|
42
|
+
callbacks?: Map<CallbackObject | ReferenceObject>;
|
|
43
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
44
|
+
headers?: Map<HeaderObject | ReferenceObject>;
|
|
45
|
+
links?: Map<LinkObject | ReferenceObject>;
|
|
46
|
+
parameters?: Map<ParameterObject | ReferenceObject>;
|
|
47
|
+
requestBodies?: Map<ReferenceObject | RequestBodyObject>;
|
|
48
|
+
responses?: Map<ReferenceObject | ResponseObject>;
|
|
49
|
+
schemas?: Map<ReferenceObject | SchemaObject>;
|
|
50
|
+
securitySchemes?: Map<ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject | ReferenceObject>;
|
|
51
|
+
}
|
|
52
|
+
export type PathsObject = Record<string, PathItemObject>;
|
|
53
|
+
export interface PathItemObject {
|
|
54
|
+
$ref?: string;
|
|
55
|
+
delete?: OperationObject;
|
|
56
|
+
description?: string;
|
|
57
|
+
get?: OperationObject;
|
|
58
|
+
head?: OperationObject;
|
|
59
|
+
options?: OperationObject;
|
|
60
|
+
parameters?: (ParameterObject | ReferenceObject)[];
|
|
61
|
+
patch?: OperationObject;
|
|
62
|
+
post?: OperationObject;
|
|
63
|
+
put?: OperationObject;
|
|
64
|
+
servers?: ServerObject[];
|
|
65
|
+
summary?: string;
|
|
66
|
+
trace?: OperationObject;
|
|
67
|
+
}
|
|
68
|
+
export interface OperationObject {
|
|
69
|
+
callbacks?: Map<CallbackObject | ReferenceObject>;
|
|
70
|
+
deprecated?: boolean;
|
|
71
|
+
description?: string;
|
|
72
|
+
externalDocs?: ExternalDocumentationObject;
|
|
73
|
+
operationId?: string;
|
|
74
|
+
parameters?: (ParameterObject | ReferenceObject)[];
|
|
75
|
+
requestBody?: ReferenceObject | RequestBodyObject;
|
|
76
|
+
responses: ResponsesObject;
|
|
77
|
+
security?: SecurityRequirementObject[];
|
|
78
|
+
servers?: ServerObject[];
|
|
79
|
+
summary?: string;
|
|
80
|
+
tags?: string[];
|
|
81
|
+
}
|
|
82
|
+
export interface ExternalDocumentationObject {
|
|
83
|
+
description?: string;
|
|
84
|
+
url: string;
|
|
85
|
+
}
|
|
86
|
+
export interface ParameterObject {
|
|
87
|
+
allowEmptyValue?: boolean;
|
|
88
|
+
allowReserved?: boolean;
|
|
89
|
+
content?: Map<MediaTypeObject>;
|
|
90
|
+
deprecated?: boolean;
|
|
91
|
+
description?: string;
|
|
92
|
+
example?: any;
|
|
93
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
94
|
+
explode?: string;
|
|
95
|
+
in: string;
|
|
96
|
+
name: string;
|
|
97
|
+
required?: boolean;
|
|
98
|
+
schema?: ReferenceObject | SchemaObject;
|
|
99
|
+
style?: string;
|
|
100
|
+
}
|
|
101
|
+
export interface RequestBodyObject {
|
|
102
|
+
content: Map<MediaTypeObject>;
|
|
103
|
+
description?: string;
|
|
104
|
+
required?: boolean;
|
|
105
|
+
}
|
|
106
|
+
export interface MediaTypeObject {
|
|
107
|
+
encoding?: Map<EncodingObject>;
|
|
108
|
+
example?: any;
|
|
109
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
110
|
+
schema?: ReferenceObject | SchemaObject;
|
|
111
|
+
}
|
|
112
|
+
export interface EncodingObject {
|
|
113
|
+
allowReserved?: boolean;
|
|
114
|
+
contentType?: string;
|
|
115
|
+
explode?: boolean;
|
|
116
|
+
headers?: Map<HeaderObject | ReferenceObject>;
|
|
117
|
+
style?: string;
|
|
118
|
+
}
|
|
119
|
+
export type ResponsesObject = Record<string, ReferenceObject | ResponseObject>;
|
|
120
|
+
export interface ResponseObject {
|
|
121
|
+
content?: Map<MediaTypeObject>;
|
|
122
|
+
description: string;
|
|
123
|
+
headers?: Map<HeaderObject | ReferenceObject>;
|
|
124
|
+
links?: Map<LinkObject | ReferenceObject>;
|
|
125
|
+
}
|
|
126
|
+
export type CallbackObject = Record<string, PathItemObject>;
|
|
127
|
+
export interface ExampleObject {
|
|
128
|
+
description?: string;
|
|
129
|
+
externalValue?: string;
|
|
130
|
+
summary?: string;
|
|
131
|
+
value?: any;
|
|
132
|
+
}
|
|
133
|
+
export interface LinkObject {
|
|
134
|
+
description?: string;
|
|
135
|
+
operationId?: string;
|
|
136
|
+
operationRef?: string;
|
|
137
|
+
parameters?: Map<any>;
|
|
138
|
+
requestBody?: any;
|
|
139
|
+
server?: ServerObject;
|
|
140
|
+
}
|
|
141
|
+
export interface HeaderObject {
|
|
142
|
+
allowEmptyValue?: boolean;
|
|
143
|
+
allowReserved?: boolean;
|
|
144
|
+
content?: Map<MediaTypeObject>;
|
|
145
|
+
deprecated?: boolean;
|
|
146
|
+
description?: string;
|
|
147
|
+
example?: any;
|
|
148
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
149
|
+
explode?: string;
|
|
150
|
+
required?: boolean;
|
|
151
|
+
schema?: ReferenceObject | SchemaObject;
|
|
152
|
+
style?: string;
|
|
153
|
+
}
|
|
154
|
+
export interface TagObject {
|
|
155
|
+
description?: string;
|
|
156
|
+
externalDocs?: ExternalDocumentationObject;
|
|
157
|
+
name: string;
|
|
158
|
+
}
|
|
159
|
+
export interface ReferenceObject {
|
|
160
|
+
$ref: string;
|
|
161
|
+
}
|
|
162
|
+
export type SchemaObject = Record<string, any>;
|
|
163
|
+
export interface ApiKeySecuritySchemeObject {
|
|
164
|
+
description?: string;
|
|
165
|
+
in: string;
|
|
166
|
+
name: string;
|
|
167
|
+
type: string;
|
|
168
|
+
}
|
|
169
|
+
export interface HttpSecuritySchemeObject {
|
|
170
|
+
bearerFormat?: string;
|
|
171
|
+
description?: string;
|
|
172
|
+
scheme: string;
|
|
173
|
+
type: string;
|
|
174
|
+
}
|
|
175
|
+
export interface Oauth2SecuritySchemeObject {
|
|
176
|
+
description?: string;
|
|
177
|
+
flows: OAuthFlowsObject;
|
|
178
|
+
type: string;
|
|
179
|
+
}
|
|
180
|
+
export interface OpenIdConnectSecuritySchemeObject {
|
|
181
|
+
description?: string;
|
|
182
|
+
openIdConnectUrl: string;
|
|
183
|
+
type: string;
|
|
184
|
+
}
|
|
185
|
+
export interface OAuthFlowsObject {
|
|
186
|
+
authorizationCode?: OAuthFlowObject;
|
|
187
|
+
clientCredentials?: OAuthFlowObject;
|
|
188
|
+
implicit?: OAuthFlowObject;
|
|
189
|
+
password?: OAuthFlowObject;
|
|
190
|
+
}
|
|
191
|
+
export interface OAuthFlowObject {
|
|
192
|
+
authorizationUrl?: string;
|
|
193
|
+
refreshUrl: string;
|
|
194
|
+
scopes: Map<string>;
|
|
195
|
+
tokenUrl?: string;
|
|
196
|
+
}
|
|
197
|
+
export type SecurityRequirementObject = Record<string, string[]>;
|
|
198
|
+
export type Map<T> = Record<string, T>;
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
export interface BaseDefinition {
|
|
2
|
+
components?: ComponentsObject;
|
|
3
|
+
externalDocs?: ExternalDocumentationObject;
|
|
4
|
+
info: InfoObject;
|
|
5
|
+
openapi: string;
|
|
6
|
+
paths?: PathsObject;
|
|
7
|
+
security?: SecurityRequirementObject[];
|
|
8
|
+
servers?: ServerObject[];
|
|
9
|
+
tags?: TagObject[];
|
|
10
|
+
}
|
|
11
|
+
export interface OpenApiObject extends BaseDefinition {
|
|
12
|
+
paths?: PathsObject;
|
|
13
|
+
}
|
|
14
|
+
export interface InfoObject {
|
|
15
|
+
contact?: ContactObject;
|
|
16
|
+
description?: string;
|
|
17
|
+
license?: LicenseObject;
|
|
18
|
+
termsOfService?: string;
|
|
19
|
+
title: string;
|
|
20
|
+
version: string;
|
|
21
|
+
}
|
|
22
|
+
export interface ContactObject {
|
|
23
|
+
email?: string;
|
|
24
|
+
name?: string;
|
|
25
|
+
url?: string;
|
|
26
|
+
}
|
|
27
|
+
export interface LicenseObject {
|
|
28
|
+
name: string;
|
|
29
|
+
url?: string;
|
|
30
|
+
}
|
|
31
|
+
export interface ServerObject {
|
|
32
|
+
description?: string;
|
|
33
|
+
url: string;
|
|
34
|
+
variables?: Map<ServerVariable>;
|
|
35
|
+
}
|
|
36
|
+
export interface ServerVariable {
|
|
37
|
+
default: string;
|
|
38
|
+
description?: string;
|
|
39
|
+
enum?: string[];
|
|
40
|
+
}
|
|
41
|
+
export interface ComponentsObject {
|
|
42
|
+
callbacks?: Map<CallbackObject | ReferenceObject>;
|
|
43
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
44
|
+
headers?: Map<HeaderObject | ReferenceObject>;
|
|
45
|
+
links?: Map<LinkObject | ReferenceObject>;
|
|
46
|
+
parameters?: Map<ParameterObject | ReferenceObject>;
|
|
47
|
+
requestBodies?: Map<ReferenceObject | RequestBodyObject>;
|
|
48
|
+
responses?: Map<ReferenceObject | ResponseObject>;
|
|
49
|
+
schemas?: Map<ReferenceObject | SchemaObject>;
|
|
50
|
+
securitySchemes?: Map<ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject | ReferenceObject>;
|
|
51
|
+
}
|
|
52
|
+
export type PathsObject = Record<string, PathItemObject>;
|
|
53
|
+
export interface PathItemObject {
|
|
54
|
+
$ref?: string;
|
|
55
|
+
delete?: OperationObject;
|
|
56
|
+
description?: string;
|
|
57
|
+
get?: OperationObject;
|
|
58
|
+
head?: OperationObject;
|
|
59
|
+
options?: OperationObject;
|
|
60
|
+
parameters?: (ParameterObject | ReferenceObject)[];
|
|
61
|
+
patch?: OperationObject;
|
|
62
|
+
post?: OperationObject;
|
|
63
|
+
put?: OperationObject;
|
|
64
|
+
servers?: ServerObject[];
|
|
65
|
+
summary?: string;
|
|
66
|
+
trace?: OperationObject;
|
|
67
|
+
}
|
|
68
|
+
export interface OperationObject {
|
|
69
|
+
callbacks?: Map<CallbackObject | ReferenceObject>;
|
|
70
|
+
deprecated?: boolean;
|
|
71
|
+
description?: string;
|
|
72
|
+
externalDocs?: ExternalDocumentationObject;
|
|
73
|
+
operationId?: string;
|
|
74
|
+
parameters?: (ParameterObject | ReferenceObject)[];
|
|
75
|
+
requestBody?: ReferenceObject | RequestBodyObject;
|
|
76
|
+
responses: ResponsesObject;
|
|
77
|
+
security?: SecurityRequirementObject[];
|
|
78
|
+
servers?: ServerObject[];
|
|
79
|
+
summary?: string;
|
|
80
|
+
tags?: string[];
|
|
81
|
+
}
|
|
82
|
+
export interface ExternalDocumentationObject {
|
|
83
|
+
description?: string;
|
|
84
|
+
url: string;
|
|
85
|
+
}
|
|
86
|
+
export interface ParameterObject {
|
|
87
|
+
allowEmptyValue?: boolean;
|
|
88
|
+
allowReserved?: boolean;
|
|
89
|
+
content?: Map<MediaTypeObject>;
|
|
90
|
+
deprecated?: boolean;
|
|
91
|
+
description?: string;
|
|
92
|
+
example?: any;
|
|
93
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
94
|
+
explode?: string;
|
|
95
|
+
in: string;
|
|
96
|
+
name: string;
|
|
97
|
+
required?: boolean;
|
|
98
|
+
schema?: ReferenceObject | SchemaObject;
|
|
99
|
+
style?: string;
|
|
100
|
+
}
|
|
101
|
+
export interface RequestBodyObject {
|
|
102
|
+
content: Map<MediaTypeObject>;
|
|
103
|
+
description?: string;
|
|
104
|
+
required?: boolean;
|
|
105
|
+
}
|
|
106
|
+
export interface MediaTypeObject {
|
|
107
|
+
encoding?: Map<EncodingObject>;
|
|
108
|
+
example?: any;
|
|
109
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
110
|
+
schema?: ReferenceObject | SchemaObject;
|
|
111
|
+
}
|
|
112
|
+
export interface EncodingObject {
|
|
113
|
+
allowReserved?: boolean;
|
|
114
|
+
contentType?: string;
|
|
115
|
+
explode?: boolean;
|
|
116
|
+
headers?: Map<HeaderObject | ReferenceObject>;
|
|
117
|
+
style?: string;
|
|
118
|
+
}
|
|
119
|
+
export type ResponsesObject = Record<string, ReferenceObject | ResponseObject>;
|
|
120
|
+
export interface ResponseObject {
|
|
121
|
+
content?: Map<MediaTypeObject>;
|
|
122
|
+
description: string;
|
|
123
|
+
headers?: Map<HeaderObject | ReferenceObject>;
|
|
124
|
+
links?: Map<LinkObject | ReferenceObject>;
|
|
125
|
+
}
|
|
126
|
+
export type CallbackObject = Record<string, PathItemObject>;
|
|
127
|
+
export interface ExampleObject {
|
|
128
|
+
description?: string;
|
|
129
|
+
externalValue?: string;
|
|
130
|
+
summary?: string;
|
|
131
|
+
value?: any;
|
|
132
|
+
}
|
|
133
|
+
export interface LinkObject {
|
|
134
|
+
description?: string;
|
|
135
|
+
operationId?: string;
|
|
136
|
+
operationRef?: string;
|
|
137
|
+
parameters?: Map<any>;
|
|
138
|
+
requestBody?: any;
|
|
139
|
+
server?: ServerObject;
|
|
140
|
+
}
|
|
141
|
+
export interface HeaderObject {
|
|
142
|
+
allowEmptyValue?: boolean;
|
|
143
|
+
allowReserved?: boolean;
|
|
144
|
+
content?: Map<MediaTypeObject>;
|
|
145
|
+
deprecated?: boolean;
|
|
146
|
+
description?: string;
|
|
147
|
+
example?: any;
|
|
148
|
+
examples?: Map<ExampleObject | ReferenceObject>;
|
|
149
|
+
explode?: string;
|
|
150
|
+
required?: boolean;
|
|
151
|
+
schema?: ReferenceObject | SchemaObject;
|
|
152
|
+
style?: string;
|
|
153
|
+
}
|
|
154
|
+
export interface TagObject {
|
|
155
|
+
description?: string;
|
|
156
|
+
externalDocs?: ExternalDocumentationObject;
|
|
157
|
+
name: string;
|
|
158
|
+
}
|
|
159
|
+
export interface ReferenceObject {
|
|
160
|
+
$ref: string;
|
|
161
|
+
}
|
|
162
|
+
export type SchemaObject = Record<string, any>;
|
|
163
|
+
export interface ApiKeySecuritySchemeObject {
|
|
164
|
+
description?: string;
|
|
165
|
+
in: string;
|
|
166
|
+
name: string;
|
|
167
|
+
type: string;
|
|
168
|
+
}
|
|
169
|
+
export interface HttpSecuritySchemeObject {
|
|
170
|
+
bearerFormat?: string;
|
|
171
|
+
description?: string;
|
|
172
|
+
scheme: string;
|
|
173
|
+
type: string;
|
|
174
|
+
}
|
|
175
|
+
export interface Oauth2SecuritySchemeObject {
|
|
176
|
+
description?: string;
|
|
177
|
+
flows: OAuthFlowsObject;
|
|
178
|
+
type: string;
|
|
179
|
+
}
|
|
180
|
+
export interface OpenIdConnectSecuritySchemeObject {
|
|
181
|
+
description?: string;
|
|
182
|
+
openIdConnectUrl: string;
|
|
183
|
+
type: string;
|
|
184
|
+
}
|
|
185
|
+
export interface OAuthFlowsObject {
|
|
186
|
+
authorizationCode?: OAuthFlowObject;
|
|
187
|
+
clientCredentials?: OAuthFlowObject;
|
|
188
|
+
implicit?: OAuthFlowObject;
|
|
189
|
+
password?: OAuthFlowObject;
|
|
190
|
+
}
|
|
191
|
+
export interface OAuthFlowObject {
|
|
192
|
+
authorizationUrl?: string;
|
|
193
|
+
refreshUrl: string;
|
|
194
|
+
scopes: Map<string>;
|
|
195
|
+
tokenUrl?: string;
|
|
196
|
+
}
|
|
197
|
+
export type SecurityRequirementObject = Record<string, string[]>;
|
|
198
|
+
export type Map<T> = Record<string, T>;
|