Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !9989

[swift5 client] fix filename for binary downloads

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/gretzki/fix-filename-from-header-response-retrieval into master Jul 20, 2021
  • Overview 0
  • Commits 3
  • Pipelines 0
  • Changes 15

Created by: gretzki

Problem:

When a file download is handled within URLSessionImplementations, the filename is retrieved via the header Content-Disposition part of the response. The header is looked for an entry starting with filename=. But the search is skipped too early, since the loop is exited if the first iteration does not match.

Example:

Try to download a file with a swift5 client for a spec like this:

  /PublicDocument/Download:
    get:
      tags:
        - Public Area
      description: 'Document Download for Public Documents. Login not Required'
      parameters:
        - $ref: '#/components/parameters/queryId'
      responses:
        '200':
          description: 'OK'
          content:
            application/pdf:
              schema:
                type: string
                format: binary

When downloading from a server, the response header could have an answer like so:

Content-Disposition: attachment; filename=downloaded.pdf; filename*=UTF-8''downloaded.pdf

There, the server says to use downloaded.pdf as filename. But the actual implementation of the swift5 client will exit after checking attachment and won't find filename= in the next section (separated by semicolon).

Solution:

Simply replacing break with continue in the matching logic inside the loop fixes the algorithm.

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/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.3.x, 6.0.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. @jgavris, @ehyche, @Edubits, @jaz-ah, @4brunu
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/gretzki/fix-filename-from-header-response-retrieval