[BUG] [typescript-angular] DELETE method - TS2554: Expected 1-2 arguments, but got 3

[constantant]

Description

It generates a wrong way to call the HttpClient.delete method

openapi-generator version

5.3.1-SNAPSHOT

OpenAPI declaration file content or url

"/v1/project/{projectId}": {
  "delete": {
    "tags": [
      "Project"
    ],
    "parameters": [
      {
        "name": "projectId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Success"
      }
    }
  }
}

Generation Details

return this.httpClient.delete<any>(`${this.configuration.basePath}/v1/project/${encodeURIComponent(String(projectId))}`,
    null, // <-- the issue
    {
        context: localVarHttpContext,
        responseType: <any>responseType_,
        withCredentials: this.configuration.withCredentials,
        headers: localVarHeaders,
        observe: observe,
        reportProgress: reportProgress
    }
);

Steps to reproduce

Generate from the DELETE method definition

Suggest a fix

In case of the DELETE method do not provide the body payload

[eiswind]

I see the same issue here with ng 13.0.1 and generator 5.3.1-SNAPSHOT

[PeterOeClausen]

I'm seeing the same issue with:

Angular CLI: 13.1.2
Node: 16.13.1
Package Manager: npm 8.3.0
OS: win32 x64

I ran:
npx @openapitools/openapi-generator-cli generate -i ./src/api/swagger.json -g typescript-angular -o ./src/api

Also seems like the methods like get, delete and so on of the httpClient of Angular 13.1.1 is only taking two arguments: The url and options:

https://github.com/angular/angular/blob/13.1.1/packages/common/http/src/client.ts#L941-L949

Once, it took a middle argument, body, but that's a long time ago. - Even at 5.0.x, it was only 2 arguments: https://github.com/angular/angular/blob/5.0.x/packages/common/http/src/client.ts

So it seems like a bug :)

[maxs-rose]

There is a PR for this here #10976

[coder925]

Suggest a fix
In case of the DELETE method do not provide the body payload

Isn't the fix simply to use the options.body property instead (as suggested in #11172 )?

I'm actually in need of a body for DELETE.

[amakhrov]

Duplicate of #10975

[cghislai]

@coder925 Unfortunately, the specification does not allow a body for delete methods. See https://swagger.io/specification/#operation-object mentionning The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers. and RFC7231 metionning A payload within a DELETE request message has no defined semantics;

When fixing this for angular13, i tried to update the test spec to include a delete body so that i could test the generated code, but i got errors due to the invalid spec. I think I edited a former spec I will give it another try

[EE1234EE]

Hey guys,

link to comment. I do not have a requestBody but still have the same issue.

[lfarci]

Same issue as @EE1234EE , I have a delete method without any request body and still get this issue.

Here is my specification:

delete:
      summary: Deletes a user by ID.
      operationId: 'deleteById'
      tags:
        - User
      parameters:
        - name: userId
          in: path
          required: true
          description: This is the user identifier.
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: The user has been successfuly deleted.
        '404':
          description: The user could not be deleted because it doesn't exist.
          content:
            application/json:
              schema:
                $ref: './resources/shared/ServiceError.yaml'

[maxs-rose]

The generator is attempting to add the request body whether it is in your specification or not that is why you are seeing the issues

[pwiesinger]

any updates regarding this issue?