LukeParke/openapi-definition-generator
1
0
Fork 0
mirror of https://github.com/LukeHagar/openapi-definition-generator.git synced 2025-12-06 12:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

adjusted example syntax

Browse Source
This commit is contained in:
Luke Hagar
2024-06-17 12:41:50 -05:00
parent 46da9ae63f
commit c683010298
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/lib/converter.ts
View File

@@ -66,7 +66,7 @@ export function convertNumber(number: number, config: Config): OpenAPIV3_1.Schem
output = { type: 'number' }; output = { type: 'number' };
} }
if (config.includeExamples) { if (config.includeExamples) {
output.examples = [number]; output.examples = [{value: number}];
} }
return output; return output;
@@ -130,7 +130,7 @@ export function convertString(string: string, config: Config): OpenAPIV3_1.Schem
} else if (regxDate.test(string)) { } else if (regxDate.test(string)) {
output.format = 'date'; output.format = 'date';
} }
if (config.includeExamples) output.examples = [string]; if (config.includeExamples) output.examples = [{value:string}];
return output; return output;
} }
@@ -155,7 +155,7 @@ export function convertObject(input: unknown, config: Config): OpenAPIV3_1.Schem
return convertString(input, config); return convertString(input, config);
} else if (typeof input === 'boolean') { } else if (typeof input === 'boolean') {
const output: OpenAPIV3_1.SchemaObject = { type: 'boolean' }; const output: OpenAPIV3_1.SchemaObject = { type: 'boolean' };
if (config.includeExamples) output.examples = [input]; if (config.includeExamples) output.examples = [{value: input}];
return output; return output;
} else if (input === undefined) { } else if (input === undefined) {
throw new Error(`undefined cannot be converted to OAS`); throw new Error(`undefined cannot be converted to OAS`);