mokkenstorm.dev / openapi-ts
fork of hey-api/openapi-ts because I need some additional things
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Merge pull request #349 from hey-api/fix/indentation-of-models-without-prettier

authored by

Jordan Shatford and committed by
GitHub 05dd1d32 54244935

+465 -67
+5
.changeset/khaki-roses-smell.md
··· 1 + --- 2 + "@hey-api/openapi-ts": patch 3 + --- 4 + 5 + fix: inconsistent indentation in models file when not using `format: true`
+28 -67
packages/openapi-ts/src/utils/write/models.ts
··· 10 10 import { sortByName } from '../sort'; 11 11 import { toType } from './type'; 12 12 13 + const emptyModel: Model = { 14 + $refs: [], 15 + base: '', 16 + description: null, 17 + enum: [], 18 + enums: [], 19 + export: 'interface', 20 + imports: [], 21 + isDefinition: false, 22 + isNullable: false, 23 + isReadOnly: false, 24 + isRequired: false, 25 + link: null, 26 + name: '', 27 + properties: [], 28 + template: null, 29 + type: '', 30 + }; 31 + 13 32 const processComposition = (client: Client, model: Model) => [ 14 33 processType(client, model), 15 34 ...model.enums.flatMap(enumerator => processEnum(client, enumerator, false)), ··· 78 97 }; 79 98 80 99 const processServiceTypes = (services: Service[]) => { 81 - type ResMap = Map<number, string>; 100 + type ResMap = Map<number, Model>; 82 101 type MethodMap = Map<'req' | 'res', ResMap | OperationParameter[]>; 83 102 type MethodKey = Service['operations'][number]['method']; 84 103 type PathMap = Map<MethodKey, MethodMap>; ··· 119 138 } 120 139 121 140 operation.results.forEach(result => { 122 - resMap.set(result.code, compiler.utils.toString(toType(result))); 141 + resMap.set(result.code, result); 123 142 }); 124 143 } 125 144 } ··· 132 151 const reqResParameters = Array.isArray(baseOrResMap) 133 152 ? baseOrResMap 134 153 : Array.from(baseOrResMap).map(([code, base]) => { 154 + // TODO: move query params into separate query key 135 155 const value: Model = { 136 - $refs: [], 137 - base, 138 - description: null, 139 - enum: [], 140 - enums: [], 141 - export: 'generic', 142 - imports: [], 143 - isDefinition: false, 144 - isNullable: false, 145 - isReadOnly: false, 156 + ...emptyModel, 157 + ...base, 146 158 isRequired: true, 147 - link: null, 148 159 name: String(code), 149 - // TODO: move query params into separate query key 150 - properties: [], 151 - template: null, 152 - type: '', 153 160 }; 154 161 return value; 155 162 }); 156 163 157 164 const reqResKey: Model = { 158 - $refs: [], 159 - base: '', 160 - description: null, 161 - enum: [], 162 - enums: [], 165 + ...emptyModel, 163 166 export: 'interface', 164 - imports: [], 165 - isDefinition: false, 166 - isNullable: false, 167 - isReadOnly: false, 168 167 isRequired: true, 169 - link: null, 170 168 name, 171 169 properties: reqResParameters, 172 - template: null, 173 - type: '', 174 170 }; 175 171 return reqResKey; 176 172 }); 177 173 const methodKey: Model = { 178 - $refs: [], 179 - base: '', 180 - description: null, 181 - enum: [], 182 - enums: [], 174 + ...emptyModel, 183 175 export: 'interface', 184 - imports: [], 185 - isDefinition: false, 186 - isNullable: false, 187 - isReadOnly: false, 188 176 isRequired: true, 189 - link: null, 190 177 name: method.toLocaleLowerCase(), 191 178 properties: methodParameters, 192 - template: null, 193 - type: '', 194 179 }; 195 180 return methodKey; 196 181 }); 197 182 const pathKey: Model = { 198 - $refs: [], 199 - base: '', 200 - description: null, 201 - enum: [], 202 - enums: [], 183 + ...emptyModel, 203 184 export: 'interface', 204 - imports: [], 205 - isDefinition: false, 206 - isNullable: false, 207 - isReadOnly: false, 208 185 isRequired: true, 209 - link: null, 210 186 name: `'${path}'`, 211 187 properties: pathParameters, 212 - template: null, 213 - type: '', 214 188 }; 215 189 return pathKey; 216 190 }); 217 191 218 192 const type = toType({ 219 - $refs: [], 220 - base: '', 221 - description: null, 222 - enum: [], 223 - enums: [], 193 + ...emptyModel, 224 194 export: 'interface', 225 - imports: [], 226 - isDefinition: false, 227 - isNullable: false, 228 - isReadOnly: false, 229 - isRequired: false, 230 - link: null, 231 - name: '', 232 195 properties, 233 - template: null, 234 - type: '', 235 196 }); 236 197 const namespace = serviceExportedNamespace(); 237 198 return compiler.typedef.alias(namespace, type);
+54
packages/openapi-ts/test/__snapshots__/test/generated/v2/models.ts.snap
··· 614 614 '/api/v{api-version}/no-content': { 615 615 get: { 616 616 res: { 617 + /** 618 + * Success 619 + */ 617 620 204: void; 618 621 }; 619 622 }; ··· 621 624 '/api/v{api-version}/multiple-tags/response-and-no-content': { 622 625 get: { 623 626 res: { 627 + /** 628 + * Response is a simple number 629 + */ 624 630 200: any; 631 + /** 632 + * Success 633 + */ 625 634 204: void; 626 635 }; 627 636 }; ··· 629 638 '/api/v{api-version}/response': { 630 639 get: { 631 640 res: { 641 + /** 642 + * Message for default response 643 + */ 632 644 200: ModelWithString; 633 645 }; 634 646 }; 635 647 post: { 636 648 res: { 649 + /** 650 + * Message for default response 651 + */ 637 652 200: ModelWithString; 638 653 }; 639 654 }; 640 655 put: { 641 656 res: { 657 + /** 658 + * Message for default response 659 + */ 642 660 200: ModelWithString; 661 + /** 662 + * Message for 201 response 663 + */ 643 664 201: ModelThatExtends; 665 + /** 666 + * Message for 202 response 667 + */ 644 668 202: ModelThatExtendsExtends; 645 669 }; 646 670 }; ··· 648 672 '/api/v{api-version}/multiple-tags/a': { 649 673 get: { 650 674 res: { 675 + /** 676 + * Success 677 + */ 651 678 204: void; 652 679 }; 653 680 }; ··· 655 682 '/api/v{api-version}/multiple-tags/b': { 656 683 get: { 657 684 res: { 685 + /** 686 + * Success 687 + */ 658 688 204: void; 659 689 }; 660 690 }; ··· 722 752 parameterString: string; 723 753 }; 724 754 res: { 755 + /** 756 + * Response is a simple number 757 + */ 725 758 200: number; 759 + /** 760 + * Response is a simple string 761 + */ 726 762 201: string; 763 + /** 764 + * Response is a simple boolean 765 + */ 727 766 202: boolean; 767 + /** 768 + * Response is a simple object 769 + */ 728 770 203: unknown; 729 771 }; 730 772 }; ··· 748 790 parameterReference: ModelWithString; 749 791 }; 750 792 res: { 793 + /** 794 + * Successful response 795 + */ 751 796 200: Array<ModelWithString>; 752 797 }; 753 798 }; ··· 755 800 '/api/v{api-version}/header': { 756 801 post: { 757 802 res: { 803 + /** 804 + * Successful response 805 + */ 758 806 200: string; 759 807 }; 760 808 }; ··· 768 816 status: string; 769 817 }; 770 818 res: { 819 + /** 820 + * Custom message: Successful response 821 + */ 771 822 200: any; 772 823 }; 773 824 }; ··· 781 832 nonAsciiParamæøåÆøÅöôêÊ: number; 782 833 }; 783 834 res: { 835 + /** 836 + * Successful response 837 + */ 784 838 200: NonAsciiStringæøåÆØÅöôêÊ字符串; 785 839 }; 786 840 };
+63
packages/openapi-ts/test/__snapshots__/test/generated/v3/models.ts.snap
··· 868 868 '/api/v{api-version}/simple/$count': { 869 869 get: { 870 870 res: { 871 + /** 872 + * Success 873 + */ 871 874 200: Model_From_Zendesk; 872 875 }; 873 876 }; ··· 1147 1150 '/api/v{api-version}/no-content': { 1148 1151 get: { 1149 1152 res: { 1153 + /** 1154 + * Success 1155 + */ 1150 1156 204: void; 1151 1157 }; 1152 1158 }; ··· 1154 1160 '/api/v{api-version}/multiple-tags/response-and-no-content': { 1155 1161 get: { 1156 1162 res: { 1163 + /** 1164 + * Response is a simple number 1165 + */ 1157 1166 200: number; 1167 + /** 1168 + * Success 1169 + */ 1158 1170 204: void; 1159 1171 }; 1160 1172 }; ··· 1167 1179 }; 1168 1180 post: { 1169 1181 res: { 1182 + /** 1183 + * Message for default response 1184 + */ 1170 1185 200: ModelWithString; 1171 1186 }; 1172 1187 }; 1173 1188 put: { 1174 1189 res: { 1190 + /** 1191 + * Message for default response 1192 + */ 1175 1193 200: ModelWithString; 1194 + /** 1195 + * Message for 201 response 1196 + */ 1176 1197 201: ModelThatExtends; 1198 + /** 1199 + * Message for 202 response 1200 + */ 1177 1201 202: ModelThatExtendsExtends; 1178 1202 }; 1179 1203 }; ··· 1181 1205 '/api/v{api-version}/multiple-tags/a': { 1182 1206 get: { 1183 1207 res: { 1208 + /** 1209 + * Success 1210 + */ 1184 1211 204: void; 1185 1212 }; 1186 1213 }; ··· 1188 1215 '/api/v{api-version}/multiple-tags/b': { 1189 1216 get: { 1190 1217 res: { 1218 + /** 1219 + * Success 1220 + */ 1191 1221 204: void; 1192 1222 }; 1193 1223 }; ··· 1255 1285 parameterString: string | null; 1256 1286 }; 1257 1287 res: { 1288 + /** 1289 + * Response is a simple number 1290 + */ 1258 1291 200: number; 1292 + /** 1293 + * Response is a simple string 1294 + */ 1259 1295 201: string; 1296 + /** 1297 + * Response is a simple boolean 1298 + */ 1260 1299 202: boolean; 1300 + /** 1301 + * Response is a simple object 1302 + */ 1261 1303 203: Record<string, unknown>; 1262 1304 }; 1263 1305 }; ··· 1281 1323 id: string; 1282 1324 }; 1283 1325 res: { 1326 + /** 1327 + * Success 1328 + */ 1284 1329 200: Blob | File; 1285 1330 }; 1286 1331 }; ··· 1304 1349 parameterReference: ModelWithString; 1305 1350 }; 1306 1351 res: { 1352 + /** 1353 + * Successful response 1354 + */ 1307 1355 200: Array<ModelWithString>; 1308 1356 }; 1309 1357 }; ··· 1327 1375 }; 1328 1376 }; 1329 1377 res: { 1378 + /** 1379 + * Success 1380 + */ 1330 1381 200: ModelWithString; 1331 1382 }; 1332 1383 }; ··· 1342 1393 }; 1343 1394 get: { 1344 1395 res: { 1396 + /** 1397 + * OK 1398 + */ 1345 1399 200: { 1346 1400 file?: Blob | File; 1347 1401 metadata?: { ··· 1355 1409 '/api/v{api-version}/header': { 1356 1410 post: { 1357 1411 res: { 1412 + /** 1413 + * Successful response 1414 + */ 1358 1415 200: string; 1359 1416 }; 1360 1417 }; ··· 1368 1425 status: number; 1369 1426 }; 1370 1427 res: { 1428 + /** 1429 + * Custom message: Successful response 1430 + */ 1371 1431 200: any; 1372 1432 }; 1373 1433 }; ··· 1381 1441 nonAsciiParamæøåÆøÅöôêÊ: number; 1382 1442 }; 1383 1443 res: { 1444 + /** 1445 + * Successful response 1446 + */ 1384 1447 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1385 1448 }; 1386 1449 };
+63
packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.ts.snap
··· 759 759 '/api/v{api-version}/simple/$count': { 760 760 get: { 761 761 res: { 762 + /** 763 + * Success 764 + */ 762 765 200: Model_From_Zendesk; 763 766 }; 764 767 }; ··· 1038 1041 '/api/v{api-version}/no-content': { 1039 1042 get: { 1040 1043 res: { 1044 + /** 1045 + * Success 1046 + */ 1041 1047 204: void; 1042 1048 }; 1043 1049 }; ··· 1045 1051 '/api/v{api-version}/multiple-tags/response-and-no-content': { 1046 1052 get: { 1047 1053 res: { 1054 + /** 1055 + * Response is a simple number 1056 + */ 1048 1057 200: number; 1058 + /** 1059 + * Success 1060 + */ 1049 1061 204: void; 1050 1062 }; 1051 1063 }; ··· 1058 1070 }; 1059 1071 post: { 1060 1072 res: { 1073 + /** 1074 + * Message for default response 1075 + */ 1061 1076 200: ModelWithString; 1062 1077 }; 1063 1078 }; 1064 1079 put: { 1065 1080 res: { 1081 + /** 1082 + * Message for default response 1083 + */ 1066 1084 200: ModelWithString; 1085 + /** 1086 + * Message for 201 response 1087 + */ 1067 1088 201: ModelThatExtends; 1089 + /** 1090 + * Message for 202 response 1091 + */ 1068 1092 202: ModelThatExtendsExtends; 1069 1093 }; 1070 1094 }; ··· 1072 1096 '/api/v{api-version}/multiple-tags/a': { 1073 1097 get: { 1074 1098 res: { 1099 + /** 1100 + * Success 1101 + */ 1075 1102 204: void; 1076 1103 }; 1077 1104 }; ··· 1079 1106 '/api/v{api-version}/multiple-tags/b': { 1080 1107 get: { 1081 1108 res: { 1109 + /** 1110 + * Success 1111 + */ 1082 1112 204: void; 1083 1113 }; 1084 1114 }; ··· 1146 1176 parameterString: string | null; 1147 1177 }; 1148 1178 res: { 1179 + /** 1180 + * Response is a simple number 1181 + */ 1149 1182 200: number; 1183 + /** 1184 + * Response is a simple string 1185 + */ 1150 1186 201: string; 1187 + /** 1188 + * Response is a simple boolean 1189 + */ 1151 1190 202: boolean; 1191 + /** 1192 + * Response is a simple object 1193 + */ 1152 1194 203: Record<string, unknown>; 1153 1195 }; 1154 1196 }; ··· 1172 1214 id: string; 1173 1215 }; 1174 1216 res: { 1217 + /** 1218 + * Success 1219 + */ 1175 1220 200: Blob | File; 1176 1221 }; 1177 1222 }; ··· 1195 1240 parameterReference: ModelWithString; 1196 1241 }; 1197 1242 res: { 1243 + /** 1244 + * Successful response 1245 + */ 1198 1246 200: Array<ModelWithString>; 1199 1247 }; 1200 1248 }; ··· 1218 1266 }; 1219 1267 }; 1220 1268 res: { 1269 + /** 1270 + * Success 1271 + */ 1221 1272 200: ModelWithString; 1222 1273 }; 1223 1274 }; ··· 1233 1284 }; 1234 1285 get: { 1235 1286 res: { 1287 + /** 1288 + * OK 1289 + */ 1236 1290 200: { 1237 1291 file?: Blob | File; 1238 1292 metadata?: { ··· 1246 1300 '/api/v{api-version}/header': { 1247 1301 post: { 1248 1302 res: { 1303 + /** 1304 + * Successful response 1305 + */ 1249 1306 200: string; 1250 1307 }; 1251 1308 }; ··· 1259 1316 status: number; 1260 1317 }; 1261 1318 res: { 1319 + /** 1320 + * Custom message: Successful response 1321 + */ 1262 1322 200: any; 1263 1323 }; 1264 1324 }; ··· 1272 1332 nonAsciiParamæøåÆøÅöôêÊ: number; 1273 1333 }; 1274 1334 res: { 1335 + /** 1336 + * Successful response 1337 + */ 1275 1338 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1276 1339 }; 1277 1340 };
+63
packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.ts.snap
··· 868 868 '/api/v{api-version}/simple/$count': { 869 869 get: { 870 870 res: { 871 + /** 872 + * Success 873 + */ 871 874 200: Model_From_Zendesk; 872 875 }; 873 876 }; ··· 1147 1150 '/api/v{api-version}/no-content': { 1148 1151 get: { 1149 1152 res: { 1153 + /** 1154 + * Success 1155 + */ 1150 1156 204: void; 1151 1157 }; 1152 1158 }; ··· 1154 1160 '/api/v{api-version}/multiple-tags/response-and-no-content': { 1155 1161 get: { 1156 1162 res: { 1163 + /** 1164 + * Response is a simple number 1165 + */ 1157 1166 200: number; 1167 + /** 1168 + * Success 1169 + */ 1158 1170 204: void; 1159 1171 }; 1160 1172 }; ··· 1167 1179 }; 1168 1180 post: { 1169 1181 res: { 1182 + /** 1183 + * Message for default response 1184 + */ 1170 1185 200: ModelWithString; 1171 1186 }; 1172 1187 }; 1173 1188 put: { 1174 1189 res: { 1190 + /** 1191 + * Message for default response 1192 + */ 1175 1193 200: ModelWithString; 1194 + /** 1195 + * Message for 201 response 1196 + */ 1176 1197 201: ModelThatExtends; 1198 + /** 1199 + * Message for 202 response 1200 + */ 1177 1201 202: ModelThatExtendsExtends; 1178 1202 }; 1179 1203 }; ··· 1181 1205 '/api/v{api-version}/multiple-tags/a': { 1182 1206 get: { 1183 1207 res: { 1208 + /** 1209 + * Success 1210 + */ 1184 1211 204: void; 1185 1212 }; 1186 1213 }; ··· 1188 1215 '/api/v{api-version}/multiple-tags/b': { 1189 1216 get: { 1190 1217 res: { 1218 + /** 1219 + * Success 1220 + */ 1191 1221 204: void; 1192 1222 }; 1193 1223 }; ··· 1255 1285 parameterString: string | null; 1256 1286 }; 1257 1287 res: { 1288 + /** 1289 + * Response is a simple number 1290 + */ 1258 1291 200: number; 1292 + /** 1293 + * Response is a simple string 1294 + */ 1259 1295 201: string; 1296 + /** 1297 + * Response is a simple boolean 1298 + */ 1260 1299 202: boolean; 1300 + /** 1301 + * Response is a simple object 1302 + */ 1261 1303 203: Record<string, unknown>; 1262 1304 }; 1263 1305 }; ··· 1281 1323 id: string; 1282 1324 }; 1283 1325 res: { 1326 + /** 1327 + * Success 1328 + */ 1284 1329 200: Blob | File; 1285 1330 }; 1286 1331 }; ··· 1304 1349 parameterReference: ModelWithString; 1305 1350 }; 1306 1351 res: { 1352 + /** 1353 + * Successful response 1354 + */ 1307 1355 200: Array<ModelWithString>; 1308 1356 }; 1309 1357 }; ··· 1327 1375 }; 1328 1376 }; 1329 1377 res: { 1378 + /** 1379 + * Success 1380 + */ 1330 1381 200: ModelWithString; 1331 1382 }; 1332 1383 }; ··· 1342 1393 }; 1343 1394 get: { 1344 1395 res: { 1396 + /** 1397 + * OK 1398 + */ 1345 1399 200: { 1346 1400 file?: Blob | File; 1347 1401 metadata?: { ··· 1355 1409 '/api/v{api-version}/header': { 1356 1410 post: { 1357 1411 res: { 1412 + /** 1413 + * Successful response 1414 + */ 1358 1415 200: string; 1359 1416 }; 1360 1417 }; ··· 1368 1425 status: number; 1369 1426 }; 1370 1427 res: { 1428 + /** 1429 + * Custom message: Successful response 1430 + */ 1371 1431 200: any; 1372 1432 }; 1373 1433 }; ··· 1381 1441 nonAsciiParamæøåÆøÅöôêÊ: number; 1382 1442 }; 1383 1443 res: { 1444 + /** 1445 + * Successful response 1446 + */ 1384 1447 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1385 1448 }; 1386 1449 };
+63
packages/openapi-ts/test/__snapshots__/test/generated/v3_date/models.ts.snap
··· 29 29 '/api/v{api-version}/simple/$count': { 30 30 get: { 31 31 res: { 32 + /** 33 + * Success 34 + */ 32 35 200: Model_From_Zendesk; 33 36 }; 34 37 }; ··· 308 311 '/api/v{api-version}/no-content': { 309 312 get: { 310 313 res: { 314 + /** 315 + * Success 316 + */ 311 317 204: void; 312 318 }; 313 319 }; ··· 315 321 '/api/v{api-version}/multiple-tags/response-and-no-content': { 316 322 get: { 317 323 res: { 324 + /** 325 + * Response is a simple number 326 + */ 318 327 200: number; 328 + /** 329 + * Success 330 + */ 319 331 204: void; 320 332 }; 321 333 }; ··· 328 340 }; 329 341 post: { 330 342 res: { 343 + /** 344 + * Message for default response 345 + */ 331 346 200: ModelWithString; 332 347 }; 333 348 }; 334 349 put: { 335 350 res: { 351 + /** 352 + * Message for default response 353 + */ 336 354 200: ModelWithString; 355 + /** 356 + * Message for 201 response 357 + */ 337 358 201: ModelThatExtends; 359 + /** 360 + * Message for 202 response 361 + */ 338 362 202: ModelThatExtendsExtends; 339 363 }; 340 364 }; ··· 342 366 '/api/v{api-version}/multiple-tags/a': { 343 367 get: { 344 368 res: { 369 + /** 370 + * Success 371 + */ 345 372 204: void; 346 373 }; 347 374 }; ··· 349 376 '/api/v{api-version}/multiple-tags/b': { 350 377 get: { 351 378 res: { 379 + /** 380 + * Success 381 + */ 352 382 204: void; 353 383 }; 354 384 }; ··· 416 446 parameterString: string | null; 417 447 }; 418 448 res: { 449 + /** 450 + * Response is a simple number 451 + */ 419 452 200: number; 453 + /** 454 + * Response is a simple string 455 + */ 420 456 201: string; 457 + /** 458 + * Response is a simple boolean 459 + */ 421 460 202: boolean; 461 + /** 462 + * Response is a simple object 463 + */ 422 464 203: Record<string, unknown>; 423 465 }; 424 466 }; ··· 442 484 id: string; 443 485 }; 444 486 res: { 487 + /** 488 + * Success 489 + */ 445 490 200: Blob | File; 446 491 }; 447 492 }; ··· 465 510 parameterReference: ModelWithString; 466 511 }; 467 512 res: { 513 + /** 514 + * Successful response 515 + */ 468 516 200: Array<ModelWithString>; 469 517 }; 470 518 }; ··· 488 536 }; 489 537 }; 490 538 res: { 539 + /** 540 + * Success 541 + */ 491 542 200: ModelWithString; 492 543 }; 493 544 }; ··· 503 554 }; 504 555 get: { 505 556 res: { 557 + /** 558 + * OK 559 + */ 506 560 200: { 507 561 file?: Blob | File; 508 562 metadata?: { ··· 516 570 '/api/v{api-version}/header': { 517 571 post: { 518 572 res: { 573 + /** 574 + * Successful response 575 + */ 519 576 200: string; 520 577 }; 521 578 }; ··· 529 586 status: number; 530 587 }; 531 588 res: { 589 + /** 590 + * Custom message: Successful response 591 + */ 532 592 200: any; 533 593 }; 534 594 }; ··· 542 602 nonAsciiParamæøåÆøÅöôêÊ: number; 543 603 }; 544 604 res: { 605 + /** 606 + * Successful response 607 + */ 545 608 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 546 609 }; 547 610 };
+63
packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.ts.snap
··· 808 808 '/api/v{api-version}/simple/$count': { 809 809 get: { 810 810 res: { 811 + /** 812 + * Success 813 + */ 811 814 200: Model_From_Zendesk; 812 815 }; 813 816 }; ··· 1087 1090 '/api/v{api-version}/no-content': { 1088 1091 get: { 1089 1092 res: { 1093 + /** 1094 + * Success 1095 + */ 1090 1096 204: void; 1091 1097 }; 1092 1098 }; ··· 1094 1100 '/api/v{api-version}/multiple-tags/response-and-no-content': { 1095 1101 get: { 1096 1102 res: { 1103 + /** 1104 + * Response is a simple number 1105 + */ 1097 1106 200: number; 1107 + /** 1108 + * Success 1109 + */ 1098 1110 204: void; 1099 1111 }; 1100 1112 }; ··· 1107 1119 }; 1108 1120 post: { 1109 1121 res: { 1122 + /** 1123 + * Message for default response 1124 + */ 1110 1125 200: ModelWithString; 1111 1126 }; 1112 1127 }; 1113 1128 put: { 1114 1129 res: { 1130 + /** 1131 + * Message for default response 1132 + */ 1115 1133 200: ModelWithString; 1134 + /** 1135 + * Message for 201 response 1136 + */ 1116 1137 201: ModelThatExtends; 1138 + /** 1139 + * Message for 202 response 1140 + */ 1117 1141 202: ModelThatExtendsExtends; 1118 1142 }; 1119 1143 }; ··· 1121 1145 '/api/v{api-version}/multiple-tags/a': { 1122 1146 get: { 1123 1147 res: { 1148 + /** 1149 + * Success 1150 + */ 1124 1151 204: void; 1125 1152 }; 1126 1153 }; ··· 1128 1155 '/api/v{api-version}/multiple-tags/b': { 1129 1156 get: { 1130 1157 res: { 1158 + /** 1159 + * Success 1160 + */ 1131 1161 204: void; 1132 1162 }; 1133 1163 }; ··· 1195 1225 parameterString: string | null; 1196 1226 }; 1197 1227 res: { 1228 + /** 1229 + * Response is a simple number 1230 + */ 1198 1231 200: number; 1232 + /** 1233 + * Response is a simple string 1234 + */ 1199 1235 201: string; 1236 + /** 1237 + * Response is a simple boolean 1238 + */ 1200 1239 202: boolean; 1240 + /** 1241 + * Response is a simple object 1242 + */ 1201 1243 203: Record<string, unknown>; 1202 1244 }; 1203 1245 }; ··· 1221 1263 id: string; 1222 1264 }; 1223 1265 res: { 1266 + /** 1267 + * Success 1268 + */ 1224 1269 200: Blob | File; 1225 1270 }; 1226 1271 }; ··· 1244 1289 parameterReference: ModelWithString; 1245 1290 }; 1246 1291 res: { 1292 + /** 1293 + * Successful response 1294 + */ 1247 1295 200: Array<ModelWithString>; 1248 1296 }; 1249 1297 }; ··· 1267 1315 }; 1268 1316 }; 1269 1317 res: { 1318 + /** 1319 + * Success 1320 + */ 1270 1321 200: ModelWithString; 1271 1322 }; 1272 1323 }; ··· 1282 1333 }; 1283 1334 get: { 1284 1335 res: { 1336 + /** 1337 + * OK 1338 + */ 1285 1339 200: { 1286 1340 file?: Blob | File; 1287 1341 metadata?: { ··· 1295 1349 '/api/v{api-version}/header': { 1296 1350 post: { 1297 1351 res: { 1352 + /** 1353 + * Successful response 1354 + */ 1298 1355 200: string; 1299 1356 }; 1300 1357 }; ··· 1308 1365 status: number; 1309 1366 }; 1310 1367 res: { 1368 + /** 1369 + * Custom message: Successful response 1370 + */ 1311 1371 200: any; 1312 1372 }; 1313 1373 }; ··· 1321 1381 nonAsciiParamæøåÆøÅöôêÊ: number; 1322 1382 }; 1323 1383 res: { 1384 + /** 1385 + * Successful response 1386 + */ 1324 1387 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1325 1388 }; 1326 1389 };
+63
packages/openapi-ts/test/__snapshots__/test/generated/v3_models/models.ts.snap
··· 759 759 '/api/v{api-version}/simple/$count': { 760 760 get: { 761 761 res: { 762 + /** 763 + * Success 764 + */ 762 765 200: Model_From_Zendesk; 763 766 }; 764 767 }; ··· 1038 1041 '/api/v{api-version}/no-content': { 1039 1042 get: { 1040 1043 res: { 1044 + /** 1045 + * Success 1046 + */ 1041 1047 204: void; 1042 1048 }; 1043 1049 }; ··· 1045 1051 '/api/v{api-version}/multiple-tags/response-and-no-content': { 1046 1052 get: { 1047 1053 res: { 1054 + /** 1055 + * Response is a simple number 1056 + */ 1048 1057 200: number; 1058 + /** 1059 + * Success 1060 + */ 1049 1061 204: void; 1050 1062 }; 1051 1063 }; ··· 1058 1070 }; 1059 1071 post: { 1060 1072 res: { 1073 + /** 1074 + * Message for default response 1075 + */ 1061 1076 200: ModelWithString; 1062 1077 }; 1063 1078 }; 1064 1079 put: { 1065 1080 res: { 1081 + /** 1082 + * Message for default response 1083 + */ 1066 1084 200: ModelWithString; 1085 + /** 1086 + * Message for 201 response 1087 + */ 1067 1088 201: ModelThatExtends; 1089 + /** 1090 + * Message for 202 response 1091 + */ 1068 1092 202: ModelThatExtendsExtends; 1069 1093 }; 1070 1094 }; ··· 1072 1096 '/api/v{api-version}/multiple-tags/a': { 1073 1097 get: { 1074 1098 res: { 1099 + /** 1100 + * Success 1101 + */ 1075 1102 204: void; 1076 1103 }; 1077 1104 }; ··· 1079 1106 '/api/v{api-version}/multiple-tags/b': { 1080 1107 get: { 1081 1108 res: { 1109 + /** 1110 + * Success 1111 + */ 1082 1112 204: void; 1083 1113 }; 1084 1114 }; ··· 1146 1176 parameterString: string | null; 1147 1177 }; 1148 1178 res: { 1179 + /** 1180 + * Response is a simple number 1181 + */ 1149 1182 200: number; 1183 + /** 1184 + * Response is a simple string 1185 + */ 1150 1186 201: string; 1187 + /** 1188 + * Response is a simple boolean 1189 + */ 1151 1190 202: boolean; 1191 + /** 1192 + * Response is a simple object 1193 + */ 1152 1194 203: Record<string, unknown>; 1153 1195 }; 1154 1196 }; ··· 1172 1214 id: string; 1173 1215 }; 1174 1216 res: { 1217 + /** 1218 + * Success 1219 + */ 1175 1220 200: Blob | File; 1176 1221 }; 1177 1222 }; ··· 1195 1240 parameterReference: ModelWithString; 1196 1241 }; 1197 1242 res: { 1243 + /** 1244 + * Successful response 1245 + */ 1198 1246 200: Array<ModelWithString>; 1199 1247 }; 1200 1248 }; ··· 1218 1266 }; 1219 1267 }; 1220 1268 res: { 1269 + /** 1270 + * Success 1271 + */ 1221 1272 200: ModelWithString; 1222 1273 }; 1223 1274 }; ··· 1233 1284 }; 1234 1285 get: { 1235 1286 res: { 1287 + /** 1288 + * OK 1289 + */ 1236 1290 200: { 1237 1291 file?: Blob | File; 1238 1292 metadata?: { ··· 1246 1300 '/api/v{api-version}/header': { 1247 1301 post: { 1248 1302 res: { 1303 + /** 1304 + * Successful response 1305 + */ 1249 1306 200: string; 1250 1307 }; 1251 1308 }; ··· 1259 1316 status: number; 1260 1317 }; 1261 1318 res: { 1319 + /** 1320 + * Custom message: Successful response 1321 + */ 1262 1322 200: any; 1263 1323 }; 1264 1324 }; ··· 1272 1332 nonAsciiParamæøåÆøÅöôêÊ: number; 1273 1333 }; 1274 1334 res: { 1335 + /** 1336 + * Successful response 1337 + */ 1275 1338 200: Array<NonAsciiStringæøåÆØÅöôêÊ字符串>; 1276 1339 }; 1277 1340 };