Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
May 3, 2024

Conversation

Kavan72
Copy link
Contributor

@Kavan72 Kavan72 commented Apr 26, 2024

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

  • Read the contribution guidelines.
  • 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.
  • 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.
  • 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)
  • 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
Copy link
Contributor Author

Kavan72 commented Apr 30, 2024

@macjohnny
Copy link
Member

can you please update the samples?

@Kavan72
Copy link
Contributor Author

Kavan72 commented May 3, 2024

can you please update the samples?

Sure

@macjohnny
Copy link
Member

@Kavan72 please run

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

and commit the changes

@Kavan72
Copy link
Contributor Author

Kavan72 commented May 3, 2024

@Kavan72 please run

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

and commit the changes

done

@macjohnny macjohnny merged commit 73f2d82 into OpenAPITools:master May 3, 2024
17 checks passed
@wing328 wing328 added this to the 7.6.0 milestone May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants