use path from spec in ts angular documentation (#22194)

Author: wing328

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

@@ -461,6 +461,9 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap operations, L
                 }
             }
 
+            // backup path in extensions
+            op.vendorExtensions.put("x-path-from-spec", op.path);
+
             // Overwrite path to TypeScript template string, after applying everything we just did.
             op.path = pathBuffer.toString();
         }

modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

@@ -74,7 +74,7 @@ export class {{classname}} extends BaseService {
 {{#notes}}
      * {{.}}
 {{/notes}}
-     * @endpoint {{httpMethod}} {{{path}}}
+     * @endpoint {{httpMethod}} {{{vendorExtensions.x-path-from-spec}}}
      {{^useSingleRequestParameter}}
      {{#allParams}}
      * @param {{paramName}} {{description}}

modules/openapi-generator/src/main/resources/typescript-angular/apiInterface.mustache

@@ -38,7 +38,7 @@ export interface {{classname}}Interface {
     /**
      * {{summary}}
      * {{notes}}
-     * @endpoint {{httpMethod}} {{{path}}}
+     * @endpoint {{httpMethod}} {{{vendorExtensions.x-path-from-spec}}}
      {{^useSingleRequestParameter}}
      {{#allParams}}* @param {{paramName}} {{description}}
      {{/allParams}}{{/useSingleRequestParameter}}{{#useSingleRequestParameter}}{{#allParams.0}}* @param requestParameters

samples/client/petstore/typescript-angular-v12-provided-in-any/builds/default/api/pet.service.ts

@@ -104,7 +104,7 @@ export class PetService extends BaseService {
 
     /**
      * Deletes a pet
-     * @endpoint delete /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint delete /pet/{petId}
      * @param petId Pet id to delete
      * @param apiKey 
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -292,7 +292,7 @@ export class PetService extends BaseService {
     /**
      * Find pet by ID
      * Returns a single pet
-     * @endpoint get /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint get /pet/{petId}
      * @param petId ID of pet to return
      * @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.
@@ -413,7 +413,7 @@ export class PetService extends BaseService {
 
     /**
      * Updates a pet in the store with form data
-     * @endpoint post /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint post /pet/{petId}
      * @param petId ID of pet that needs to be updated
      * @param name Updated name of the pet
      * @param status Updated status of the pet
@@ -492,7 +492,7 @@ export class PetService extends BaseService {
 
     /**
      * uploads an image
-     * @endpoint post /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}/uploadImage
+     * @endpoint post /pet/{petId}/uploadImage
      * @param petId ID of pet to update
      * @param additionalMetadata Additional data to pass to server
      * @param file file to upload

samples/client/petstore/typescript-angular-v12-provided-in-any/builds/default/api/store.service.ts

@@ -38,7 +38,7 @@ export class StoreService extends BaseService {
     /**
      * Delete purchase order by ID
      * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
-     * @endpoint delete /store/order/${this.configuration.encodeParam({name: "orderId", value: orderId, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint delete /store/order/{orderId}
      * @param orderId ID of the order that needs to be deleted
      * @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.
@@ -142,7 +142,7 @@ export class StoreService extends BaseService {
     /**
      * Find purchase order by ID
      * For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
-     * @endpoint get /store/order/${this.configuration.encodeParam({name: "orderId", value: orderId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint get /store/order/{orderId}
      * @param orderId ID of pet that needs to be fetched
      * @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.

samples/client/petstore/typescript-angular-v12-provided-in-any/builds/default/api/user.service.ts

@@ -219,7 +219,7 @@ export class UserService extends BaseService {
     /**
      * Delete user
      * This can only be done by the logged in user.
-     * @endpoint delete /user/${this.configuration.encodeParam({name: "username", value: username, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint delete /user/{username}
      * @param username The name that needs to be deleted
      * @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.
@@ -270,7 +270,7 @@ export class UserService extends BaseService {
 
     /**
      * Get user by user name
-     * @endpoint get /user/${this.configuration.encodeParam({name: "username", value: username, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint get /user/{username}
      * @param username The name that needs to be fetched. Use user1 for testing.
      * @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.
@@ -435,7 +435,7 @@ export class UserService extends BaseService {
     /**
      * Updated user
      * This can only be done by the logged in user.
-     * @endpoint put /user/${this.configuration.encodeParam({name: "username", value: username, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint put /user/{username}
      * @param username name that need to be deleted
      * @param body Updated user object
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

samples/client/petstore/typescript-angular-v12-provided-in-root/builds/default/api/pet.service.ts

@@ -104,7 +104,7 @@ export class PetService extends BaseService {
 
     /**
      * Deletes a pet
-     * @endpoint delete /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint delete /pet/{petId}
      * @param petId Pet id to delete
      * @param apiKey 
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -292,7 +292,7 @@ export class PetService extends BaseService {
     /**
      * Find pet by ID
      * Returns a single pet
-     * @endpoint get /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint get /pet/{petId}
      * @param petId ID of pet to return
      * @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.
@@ -413,7 +413,7 @@ export class PetService extends BaseService {
 
     /**
      * Updates a pet in the store with form data
-     * @endpoint post /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint post /pet/{petId}
      * @param petId ID of pet that needs to be updated
      * @param name Updated name of the pet
      * @param status Updated status of the pet
@@ -492,7 +492,7 @@ export class PetService extends BaseService {
 
     /**
      * uploads an image
-     * @endpoint post /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}/uploadImage
+     * @endpoint post /pet/{petId}/uploadImage
      * @param petId ID of pet to update
      * @param additionalMetadata Additional data to pass to server
      * @param file file to upload

samples/client/petstore/typescript-angular-v12-provided-in-root/builds/default/api/store.service.ts

@@ -38,7 +38,7 @@ export class StoreService extends BaseService {
     /**
      * Delete purchase order by ID
      * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
-     * @endpoint delete /store/order/${this.configuration.encodeParam({name: "orderId", value: orderId, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint delete /store/order/{orderId}
      * @param orderId ID of the order that needs to be deleted
      * @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.
@@ -142,7 +142,7 @@ export class StoreService extends BaseService {
     /**
      * Find purchase order by ID
      * For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
-     * @endpoint get /store/order/${this.configuration.encodeParam({name: "orderId", value: orderId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint get /store/order/{orderId}
      * @param orderId ID of pet that needs to be fetched
      * @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.

samples/client/petstore/typescript-angular-v12-provided-in-root/builds/default/api/user.service.ts

@@ -219,7 +219,7 @@ export class UserService extends BaseService {
     /**
      * Delete user
      * This can only be done by the logged in user.
-     * @endpoint delete /user/${this.configuration.encodeParam({name: "username", value: username, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint delete /user/{username}
      * @param username The name that needs to be deleted
      * @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.
@@ -270,7 +270,7 @@ export class UserService extends BaseService {
 
     /**
      * Get user by user name
-     * @endpoint get /user/${this.configuration.encodeParam({name: "username", value: username, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint get /user/{username}
      * @param username The name that needs to be fetched. Use user1 for testing.
      * @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.
@@ -435,7 +435,7 @@ export class UserService extends BaseService {
     /**
      * Updated user
      * This can only be done by the logged in user.
-     * @endpoint put /user/${this.configuration.encodeParam({name: "username", value: username, in: "path", style: "simple", explode: false, dataType: "string", dataFormat: undefined})}
+     * @endpoint put /user/{username}
      * @param username name that need to be deleted
      * @param body Updated user object
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

samples/client/petstore/typescript-angular-v12-provided-in-root/builds/with-npm/api/pet.service.ts

@@ -104,7 +104,7 @@ export class PetService extends BaseService {
 
     /**
      * Deletes a pet
-     * @endpoint delete /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint delete /pet/{petId}
      * @param petId Pet id to delete
      * @param apiKey 
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
@@ -292,7 +292,7 @@ export class PetService extends BaseService {
     /**
      * Find pet by ID
      * Returns a single pet
-     * @endpoint get /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint get /pet/{petId}
      * @param petId ID of pet to return
      * @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.
@@ -413,7 +413,7 @@ export class PetService extends BaseService {
 
     /**
      * Updates a pet in the store with form data
-     * @endpoint post /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}
+     * @endpoint post /pet/{petId}
      * @param petId ID of pet that needs to be updated
      * @param name Updated name of the pet
      * @param status Updated status of the pet
@@ -492,7 +492,7 @@ export class PetService extends BaseService {
 
     /**
      * uploads an image
-     * @endpoint post /pet/${this.configuration.encodeParam({name: "petId", value: petId, in: "path", style: "simple", explode: false, dataType: "number", dataFormat: "int64"})}/uploadImage
+     * @endpoint post /pet/{petId}/uploadImage
      * @param petId ID of pet to update
      * @param additionalMetadata Additional data to pass to server
      * @param file file to upload