From 33a0dfcd1c81bc14e856868fa16ba8c3fcc9c2c4 Mon Sep 17 00:00:00 2001 From: David Scourfield Date: Thu, 5 Aug 2021 12:27:18 +0100 Subject: [PATCH 1/2] #216 Added JSDoc comments to all overloads of operation functions in typescript client --- .../boat-angular/api.service.mustache | 50 ++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/boat-scaffold/src/main/templates/boat-angular/api.service.mustache b/boat-scaffold/src/main/templates/boat-angular/api.service.mustache index e8bb05843..3adf3afe0 100644 --- a/boat-scaffold/src/main/templates/boat-angular/api.service.mustache +++ b/boat-scaffold/src/main/templates/boat-angular/api.service.mustache @@ -109,6 +109,7 @@ export class {{classname}} { } {{#operation}} +{{#produces}} /** {{#summary}} * {{summary}} @@ -125,11 +126,58 @@ export class {{classname}} { * @deprecated This endpoint is deprecated {{/isDeprecated}} */ -{{#produces}} public {{nickname}}({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}RequestParams, {{/allParams.0}}observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: '{{mediaType}}'}): Observable<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>; + /** +{{#summary}} + * {{summary}} +{{/summary}} +{{#notes}} + * {{notes}} +{{/notes}} + {{#allParams.0}} + * @param requestParameters + {{/allParams.0}} + * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. + * @param reportProgress flag to report request and response progress. + {{#isDeprecated}} + * @deprecated This endpoint is deprecated + {{/isDeprecated}} + */ public {{nickname}}({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}RequestParams, {{/allParams.0}}observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: '{{mediaType}}'}): Observable>; + /** +{{#summary}} + * {{summary}} +{{/summary}} +{{#notes}} + * {{notes}} +{{/notes}} + {{#allParams.0}} + * @param requestParameters + {{/allParams.0}} + * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. + * @param reportProgress flag to report request and response progress. + {{#isDeprecated}} + * @deprecated This endpoint is deprecated + {{/isDeprecated}} + */ public {{nickname}}({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}RequestParams, {{/allParams.0}}observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: '{{mediaType}}'}): Observable>; {{/produces}} + /** +{{#summary}} + * {{summary}} +{{/summary}} +{{#notes}} + * {{notes}} +{{/notes}} + {{#allParams.0}} + * @param requestParameters + {{/allParams.0}} + * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. + * @param reportProgress flag to report request and response progress. + {{#isDeprecated}} + * @deprecated This endpoint is deprecated + {{/isDeprecated}} + */ public {{nickname}}({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}RequestParams, {{/allParams.0}}observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: {{#produces}}'{{mediaType}}'{{#hasMore}} | {{/hasMore}}{{/produces}}{{^produces}}undefined{{/produces}}}): Observable { {{#allParams}} const _{{paramName}} = requestParameters["{{paramName}}"]; From d4373ce1bcba93ca11815140c09ec8004f159b90 Mon Sep 17 00:00:00 2001 From: David Scourfield Date: Fri, 6 Aug 2021 08:59:21 +0100 Subject: [PATCH 2/2] Update readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7385f3e5a..976ecbc88 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,11 @@ The project is very much Work In Progress and will be published on maven central # Release Notes BOAT is still under development and subject to change. +## 0.14.6 + +* *Boat Scaffold* + * Fixed bug in typescript generator where only one of the overloaded function signatures per deprecated endpoint was marked as deprecated. + ## 0.14.5 * *Boat Marina* * Added `boat-markers` directory in target to keep track of successful and unsuccessful actions on OpenAPI specs