From a408f090abdb1fa308fa640bef5f74b548e21ea1 Mon Sep 17 00:00:00 2001 From: ckho Date: Tue, 1 Jun 2021 18:20:19 +0800 Subject: [PATCH 1/2] fix: resolve Deprecation code: CLI_OPTIONS_SCHEMA' --- src/ServerlessOpenApiDocumentation.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/ServerlessOpenApiDocumentation.ts b/src/ServerlessOpenApiDocumentation.ts index b67527b..ea541fe 100644 --- a/src/ServerlessOpenApiDocumentation.ts +++ b/src/ServerlessOpenApiDocumentation.ts @@ -65,14 +65,20 @@ export class ServerlessOpenApiDocumentation { options: { output: { usage: "Output file location [default: openapi.yml|json]", + type: "string", + required: false, shortcut: "o" }, format: { usage: "OpenAPI file format (yml|json) [default: yml]", + type: "string", + required: false, shortcut: "f" }, indent: { usage: "File indentation in spaces [default: 2]", + type: "string", + required: false, shortcut: "i" } } From 4f7fe747c3021dcb47b45d4b7e835feef062b1b4 Mon Sep 17 00:00:00 2001 From: ckho Date: Wed, 2 Jun 2021 15:19:30 +0800 Subject: [PATCH 2/2] fix: examples should be map instead of array --- src/DefinitionGenerator.ts | 9 ++++----- src/types.ts | 4 ++-- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/src/DefinitionGenerator.ts b/src/DefinitionGenerator.ts index 5751f91..aa150c4 100644 --- a/src/DefinitionGenerator.ts +++ b/src/DefinitionGenerator.ts @@ -224,7 +224,7 @@ export class DefinitionGenerator { if (parameter.example) { parameterConfig.example = parameter.example; - } else if (parameter.examples && Array.isArray(parameter.examples)) { + } else if (parameter.examples) { parameterConfig.examples = parameter.examples; } @@ -273,9 +273,8 @@ export class DefinitionGenerator { if (requestModel) { const reqModelConfig = { schema: { - $ref: `#/components/schemas/${ - documentationConfig.requestModels[requestModelType] - }` + $ref: `#/components/schemas/${documentationConfig.requestModels[requestModelType] + }` } }; @@ -304,7 +303,7 @@ export class DefinitionGenerator { } private attachExamples(target, config) { - if (target.examples && Array.isArray(target.examples)) { + if (target.examples) { _.merge(config, { examples: _.cloneDeep(target.examples) }); } else if (target.example) { _.merge(config, { example: _.cloneDeep(target.example) }); diff --git a/src/types.ts b/src/types.ts index f9c2d04..3618aff 100644 --- a/src/types.ts +++ b/src/types.ts @@ -6,7 +6,7 @@ export interface Model { description: string; contentType: string; schema: string | JSONSchema7; - examples: Array; + examples: Map; example: object; } @@ -72,7 +72,7 @@ export interface ParameterConfig { explode?: boolean; allowReserved?: boolean; example?: any; - examples?: Array; + examples?: Map; content?: Map; }