[typescript-fetch] Document request-parameter interfaces and fix parameter isDeprecated

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptFetchClientCodegen.java

@@ -1206,6 +1206,7 @@ public boolean isDateTimeType() {
         public ExtendedCodegenParameter(CodegenParameter cp) {
             super();
 
+            this.isDeprecated = cp.isDeprecated;
             this.isFormParam = cp.isFormParam;
             this.isQueryParam = cp.isQueryParam;
             this.isPathParam = cp.isPathParam;

modules/openapi-generator/src/main/resources/typescript-fetch/apis.mustache

@@ -25,6 +25,12 @@ import {
 {{#allParams.0}}
 export interface {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request {
 {{#allParams}}
+    /**
+     * {{#lambda.indented_star_4}}{{{unescapedDescription}}}{{/lambda.indented_star_4}}
+    {{#isDeprecated}}
+     * @deprecated
+    {{/isDeprecated}}
+     */
     {{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{#hasReadOnly}}Omit<{{{dataType}}}, {{#readOnlyVars}}'{{name}}'{{^-last}}|{{/-last}}{{/readOnlyVars}}>{{/hasReadOnly}}{{^hasReadOnly}}{{{dataType}}}{{/hasReadOnly}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}};
 {{/allParams}}
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/typescript/fetch/TypeScriptFetchClientCodegenTest.java

@@ -93,6 +93,35 @@ public void testModelsWithoutPaths() throws IOException {
         TestUtils.assertFileExists(Paths.get(output + "/models/index.ts"));
     }
 
+    @Test
+    public void testDeprecatedParameter() throws IOException {
+        File output = Files.createTempDirectory("test").toFile();
+        output.deleteOnExit();
+
+        Map<String, Object> properties = new HashMap<>();
+        // bundle parameters into a request interface so per-parameter JSDoc is emitted
+        properties.put("useSingleRequestParameter", true);
+
+        final CodegenConfigurator configurator = new CodegenConfigurator()
+                .setGeneratorName("typescript-fetch")
+                .setInputSpec("src/test/resources/3_0/typescript/deprecated-parameter.yaml")
+                .setAdditionalProperties(properties)
+                .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+        Generator generator = new DefaultGenerator();
+        List<File> files = generator.opts(configurator.toClientOptInput()).generate();
+        files.forEach(File::deleteOnExit);
+
+        // the deprecated `name` query parameter must carry an @deprecated JSDoc tag in the
+        // generated request-parameter interface
+        Path file = Paths.get(output + "/apis/DefaultApi.ts");
+        TestUtils.assertFileContains(file, "* @deprecated");
+
+        // only the single deprecated parameter is tagged (the operation is not deprecated)
+        String content = Files.readString(file);
+        Assert.assertEquals(TestUtils.countOccurrences(content, "@deprecated"), 1);
+    }
+
     @Test
     public void testWithoutSnapshotVersion() {
         OpenAPI api = TestUtils.createOpenAPI();

samples/client/others/typescript-fetch/additional-properties-in-multipart-issue/apis/FileApi.ts

@@ -20,9 +20,21 @@ import {
 } from '../models/StructuredType';
 
 export interface CreateFileRequest {
+    /**
+     * 
+     */
     documentBytes: Blob;
+    /**
+     * 
+     */
     documentType: string;
+    /**
+     * 
+     */
     properties: { [key: string]: string; };
+    /**
+     * 
+     */
     structured?: StructuredType;
 }
 

samples/client/others/typescript-fetch/multipart-file-array/apis/DefaultApi.ts

@@ -15,7 +15,13 @@
 import * as runtime from '../runtime';
 
 export interface UploadFilesRequest {
+    /**
+     * 
+     */
     files: Array<Blob>;
+    /**
+     * 
+     */
     metadata?: string;
 }
 

samples/client/petstore/typescript-fetch/builds/allOf-nullable/apis/DefaultApi.ts

@@ -20,6 +20,9 @@ import {
 } from '../models/Club';
 
 export interface ListRequest {
+    /**
+     * The id of the person to retrieve
+     */
     personId: string;
 }
 

samples/client/petstore/typescript-fetch/builds/allOf-readonly/apis/DefaultApi.ts

@@ -20,6 +20,9 @@ import {
 } from '../models/Club';
 
 export interface ListRequest {
+    /**
+     * The id of the person to retrieve
+     */
     personId: string;
 }
 

samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/AnotherFakeApi.ts

@@ -20,6 +20,9 @@ import {
 } from '../models/Client';
 
 export interface 123testSpecialTagsRequest {
+    /**
+     * 
+     */
     client: Client;
 }