openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

fix(typescript-axios): Correct the content type for a list of objects in form-data when contentType is present

Open Kavan72 opened this issue 1 year ago • 1 comments

Cannot pass a data-type object as an array of items in a form using Axios. It works perfectly for a normal object, but it's not working as expected for a form.

openapi: 3.0.3
info:
  title: Backend
  version: 1.0.0
paths:
  /company:
    put:
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateCompanyDetails'
            encoding:
              industry:
                contentType: application/json
      responses:
        '204':
          description: The company data successfully updated

components:
  schemas:
    UpdateCompanyDetails:
      type: object
      properties:
        name:
          type: string
          description: the name of the company
        industry:
          type: array
          items:
            $ref: '#/components/schemas/Industry'
    Industry:
      type: object
      properties:
        id:
          type: integer
          description: The unique identifier of the industry
        name:
          type: string
          description: The name of the industry

Expected:

localVarFormParams.append('industry', new Blob([JSON.stringify(industry)], { type: 'application/json' }))

Received:

industry.forEach((element) => {
    localVarFormParams.append('industry', element as any);
})

PR checklist

  • [X] Read the contribution guidelines.
  • [X] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [X] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [X] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [X] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Fixes.

@macjohnny

Kavan72 avatar Apr 26 '24 07:04 Kavan72

@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka

Kavan72 avatar Apr 30 '24 06:04 Kavan72

can you please update the samples?

macjohnny avatar May 03 '24 13:05 macjohnny

can you please update the samples?

Sure

Kavan72 avatar May 03 '24 13:05 Kavan72

@Kavan72 please run

./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh

and commit the changes

macjohnny avatar May 03 '24 13:05 macjohnny

@Kavan72 please run

./mvnw clean package 
./bin/generate-samples.sh ./bin/configs/*.yaml
./bin/utils/export_docs_generators.sh

and commit the changes

done

Kavan72 avatar May 03 '24 13:05 Kavan72