Skip to content

Commit cf800f2

Browse files
kamilmysliwieckamilmysliwiec
authoredFeb 7, 2024
Merge pull request #2816 from Algram/master
feat(spec): allow additional fields on enum refs
·
11.1.07.3.0
2 parents 979f256 + 5404905 commit cf800f2

7 files changed

+77
-43
lines changed
 

‎e2e/api-spec.json

+35-24
Original file line numberDiff line numberDiff line change
@@ -205,8 +205,8 @@
205205
"description": "Test",
206206
"required": false,
207207
"schema": {
208-
"default": "test",
209-
"type": "string"
208+
"type": "string",
209+
"default": "test"
210210
}
211211
},
212212
{
@@ -277,8 +277,8 @@
277277
"description": "Test",
278278
"required": false,
279279
"schema": {
280-
"default": "test",
281-
"type": "string"
280+
"type": "string",
281+
"default": "test"
282282
}
283283
},
284284
{
@@ -415,8 +415,8 @@
415415
"description": "Test",
416416
"required": false,
417417
"schema": {
418-
"default": "test",
419-
"type": "string"
418+
"type": "string",
419+
"default": "test"
420420
}
421421
},
422422
{
@@ -474,8 +474,8 @@
474474
"description": "Test",
475475
"required": false,
476476
"schema": {
477-
"default": "test",
478-
"type": "string"
477+
"type": "string",
478+
"default": "test"
479479
}
480480
},
481481
{
@@ -610,8 +610,8 @@
610610
"description": "Test",
611611
"required": false,
612612
"schema": {
613-
"default": "test",
614-
"type": "string"
613+
"type": "string",
614+
"default": "test"
615615
}
616616
},
617617
{
@@ -662,8 +662,8 @@
662662
"description": "Test",
663663
"required": false,
664664
"schema": {
665-
"default": "test",
666-
"type": "string"
665+
"type": "string",
666+
"default": "test"
667667
}
668668
},
669669
{
@@ -720,8 +720,8 @@
720720
"description": "Test",
721721
"required": false,
722722
"schema": {
723-
"default": "test",
724-
"type": "string"
723+
"type": "string",
724+
"default": "test"
725725
}
726726
},
727727
{
@@ -784,8 +784,8 @@
784784
"description": "Test",
785785
"required": false,
786786
"schema": {
787-
"default": "test",
788-
"type": "string"
787+
"type": "string",
788+
"default": "test"
789789
}
790790
},
791791
{
@@ -828,8 +828,8 @@
828828
"description": "Test",
829829
"required": false,
830830
"schema": {
831-
"default": "test",
832-
"type": "string"
831+
"type": "string",
832+
"default": "test"
833833
}
834834
},
835835
{
@@ -885,8 +885,8 @@
885885
"description": "Test",
886886
"required": false,
887887
"schema": {
888-
"default": "test",
889-
"type": "string"
888+
"type": "string",
889+
"default": "test"
890890
}
891891
},
892892
{
@@ -937,8 +937,8 @@
937937
"description": "Test",
938938
"required": false,
939939
"schema": {
940-
"default": "test",
941-
"type": "string"
940+
"type": "string",
941+
"default": "test"
942942
}
943943
},
944944
{
@@ -1049,6 +1049,9 @@
10491049
},
10501050
"LettersEnum": {
10511051
"type": "string",
1052+
"description": "A small assortment of letters?",
1053+
"deprecated": true,
1054+
"default": "A",
10521055
"enum": [
10531056
"A",
10541057
"B",
@@ -1128,6 +1131,9 @@
11281131
"$ref": "#/components/schemas/LettersEnum"
11291132
}
11301133
},
1134+
"enumWithRef": {
1135+
"$ref": "#/components/schemas/LettersEnum"
1136+
},
11311137
"tag": {
11321138
"description": "tag",
11331139
"allOf": [
@@ -1151,7 +1157,8 @@
11511157
"options",
11521158
"enumWithDescription",
11531159
"enum",
1154-
"enumArr"
1160+
"enumArr",
1161+
"enumWithRef"
11551162
]
11561163
},
11571164
"Cat": {
@@ -1223,6 +1230,9 @@
12231230
"C"
12241231
]
12251232
}
1233+
},
1234+
"enumWithRef": {
1235+
"$ref": "#/components/schemas/LettersEnum"
12261236
}
12271237
},
12281238
"required": [
@@ -1234,7 +1244,8 @@
12341244
"urls",
12351245
"_options",
12361246
"enum",
1237-
"enumArr"
1247+
"enumArr",
1248+
"enumWithRef"
12381249
]
12391250
},
12401251
"Letter": {

‎e2e/express.e2e-spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ describe('Express Swagger', () => {
4646
const doc = JSON.stringify(document, null, 2);
4747

4848
try {
49-
let api = await SwaggerParser.validate(document as any);
49+
const api = await SwaggerParser.validate(document as any);
5050
console.log(
5151
'API name: %s, Version: %s',
5252
api.info.title,

‎e2e/fastify.e2e-spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ describe('Fastify Swagger', () => {
4646
const doc = JSON.stringify(document, null, 2);
4747

4848
try {
49-
let api = await SwaggerParser.validate(document as any);
49+
const api = await SwaggerParser.validate(document as any);
5050
console.log(
5151
'API name: %s, Version: %s',
5252
api.info.title,

‎e2e/src/cats/classes/cat.class.ts

+9
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,13 @@ export class Cat {
5353
isArray: true
5454
})
5555
enumArr: LettersEnum;
56+
57+
@ApiProperty({
58+
enum: LettersEnum,
59+
enumName: 'LettersEnum',
60+
description: 'A small assortment of letters?',
61+
default: 'A',
62+
deprecated: true,
63+
})
64+
enumWithRef: LettersEnum
5665
}

‎e2e/src/cats/dto/create-cat.dto.ts

+9
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,15 @@ export class CreateCatDto {
6161
})
6262
readonly enumArr: LettersEnum;
6363

64+
@ApiProperty({
65+
enum: LettersEnum,
66+
enumName: 'LettersEnum',
67+
description: 'A small assortment of letters?',
68+
default: 'A',
69+
deprecated: true,
70+
})
71+
readonly enumWithRef: LettersEnum
72+
6473
@ApiProperty({ description: 'tag', required: false })
6574
readonly tag: TagDto;
6675

‎e2e/validate-schema.e2e-spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ describe('Validate OpenAPI schema', () => {
104104
writeFileSync(join(__dirname, 'api-spec.json'), doc);
105105

106106
try {
107-
let api = await SwaggerParser.validate(document as any);
107+
const api = await SwaggerParser.validate(document as any);
108108
console.log(
109109
'API name: %s, Version: %s',
110110
api.info.title,

‎lib/services/schema-object-factory.ts

+21-16
Original file line numberDiff line numberDiff line change
@@ -300,21 +300,25 @@ export class SchemaObjectFactory {
300300
const enumName = metadata.enumName;
301301
const $ref = getSchemaPath(enumName);
302302

303-
if (!(enumName in schemas)) {
304-
const enumType: string = (
305-
metadata.isArray
306-
? metadata.items['type']
307-
: metadata.type
308-
) ?? 'string';
309-
310-
schemas[enumName] = {
311-
type: enumType,
312-
enum:
313-
metadata.isArray && metadata.items
314-
? metadata.items['enum']
315-
: metadata.enum
316-
};
317-
}
303+
// Allow given fields to be part of the referenced enum schema
304+
const additionalParams = ['description', 'deprecated', 'default']
305+
const additionalFields = additionalParams.reduce((acc, param) =>
306+
({...acc, ...(metadata[param] && { [param]: metadata[param] })}), {});
307+
308+
const enumType: string = (
309+
metadata.isArray
310+
? metadata.items['type']
311+
: metadata.type
312+
) ?? 'string';
313+
314+
schemas[enumName] = {
315+
type: enumType,
316+
...additionalFields,
317+
enum:
318+
metadata.isArray && metadata.items
319+
? metadata.items['enum']
320+
: metadata.enum
321+
};
318322

319323
const _schemaObject = {
320324
...metadata,
@@ -324,7 +328,7 @@ export class SchemaObjectFactory {
324328

325329
const refHost = metadata.isArray ? { items: { $ref } } : { $ref };
326330
const paramObject = { ..._schemaObject, ...refHost };
327-
const pathsToOmit = ['enum', 'enumName'];
331+
const pathsToOmit = ['enum', 'enumName', ...additionalParams];
328332

329333
if (!metadata.isArray) {
330334
pathsToOmit.push('type');
@@ -498,6 +502,7 @@ export class SchemaObjectFactory {
498502
schemas
499503
);
500504
}
505+
501506
if (isString(typeRef)) {
502507
if (isEnumMetadata(metadata)) {
503508
return this.createEnumSchemaType(key, metadata, schemas);

0 commit comments

Comments
 (0)
Please sign in to comment.