Skip to content

Commit b9e0df2

Browse files
authored
Merge pull request #1414 from Adyen/mark-deprecated-model-attributes
Add @deprecated tag: mark deprecated attributes of the models in the OpenAPI files
2 parents e22b955 + 317d064 commit b9e0df2

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

templates/typescript/api_summary.mustache

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,9 @@
1515
{{#returnType}}
1616
* @return {@link {{.}} }
1717
{{/returnType}}
18+
{{#isDeprecated}}
19+
*
20+
* @deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
21+
* {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}
22+
{{/isDeprecated}}
1823
*/

templates/typescript/model.mustache

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,20 @@ export class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{
1616
{{#description}}
1717
/**
1818
* {{{.}}}
19+
{{#deprecated}}
20+
*
21+
* @deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
22+
* {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}
23+
{{/deprecated}}
1924
*/
25+
{{/description}}
26+
{{^description}}
27+
{{#deprecated}}
28+
/**
29+
* @deprecated {{#vendorExtensions.x-deprecatedInVersion}}since {{#appName}}{{{.}}}{{/appName}} v{{.}}{{/vendorExtensions.x-deprecatedInVersion}}{{#vendorExtensions.x-deprecatedMessage}}
30+
* {{{.}}}{{/vendorExtensions.x-deprecatedMessage}}
31+
*/
32+
{{/deprecated}}
2033
{{/description}}
2134
'{{name}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}};
2235
{{/vars}}

0 commit comments

Comments
 (0)