Skip to content

Commit 3b78946

Browse files
committed
Add defaults and descriptions to schema
1 parent 6600ad6 commit 3b78946

File tree

4 files changed

+14
-0
lines changed

4 files changed

+14
-0
lines changed

src/client/interfaces/Model.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ export interface Model extends Schema {
1010
link: Model | null;
1111
description: string | null;
1212
default?: string;
13+
hasDefault?: boolean;
1314
imports: string[];
1415
enum: Enum[];
1516
enums: Model[];

src/client/interfaces/Schema.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,7 @@ export interface Schema {
1717
uniqueItems?: boolean;
1818
maxProperties?: number;
1919
minProperties?: number;
20+
title?: string;
21+
description?: string;
22+
default?: any;
2023
}

src/openApi/v3/parser/getModelProperties.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema,
2626
template: model.template,
2727
link: null,
2828
description: getComment(property.description),
29+
default: property.default,
30+
hasDefault: property.default !== undefined,
2931
isDefinition: false,
3032
isReadOnly: property.readOnly === true,
3133
isRequired: propertyRequired,
@@ -59,6 +61,8 @@ export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema,
5961
template: model.template,
6062
link: model.link,
6163
description: getComment(property.description),
64+
default: property.default,
65+
hasDefault: property.default !== undefined,
6266
isDefinition: false,
6367
isReadOnly: property.readOnly === true,
6468
isRequired: propertyRequired,

src/templates/partials/schemaGeneric.hbs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,10 @@
5353
{{#if minProperties}}
5454
minProperties: {{{minProperties}}},
5555
{{/if}}
56+
{{#if description}}
57+
description: '{{{description}}}',
58+
{{/if}}
59+
{{#if hasDefault}}
60+
default: {{json default}},
61+
{{/if}}
5662
}

0 commit comments

Comments
 (0)