Chrome overrides User-Agent specified as parameter

[pikazlou]

Q&A (please complete the following information)

• OS: macOS
• Browser: chrome
• Browser Version: 70.0.3538.77
• Method of installation: dist assets
• Swagger-UI version: 3.19.5
• Swagger/OpenAPI version: Swagger 2.0

Content & configuration

Example Swagger/OpenAPI definition:

      - name: "User-Agent"
        in: "header"
        description: "user agent"
        required: true
        type: "string"
        default: "CustomAgent"

Swagger-UI configuration options:

    window.onload = function() {
      // Begin Swagger UI call region
      const ui = SwaggerUIBundle({
        url: "swagger.yaml",
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout"
      })
      // End Swagger UI call region

      window.ui = ui
    }

Describe the bug you're encountering

Browser always overrides User-Agent header and sends its own, no matter what value I type into parameter

To reproduce...

Steps to reproduce the behavior:

1. Go to method with User-Agent parameter
2. Click on Execute

Expected behavior

Request is sent with User-Agent equal to specified parameter

Actual behavior

Request is sent with standard browser User-Agent

[shockey]

Hey @pikazlou!

This is the same root cause as swagger-api/swagger-js#1163 - there are certain headers that the browser doesn't let us set.

For now, this is a limitation of Swagger UI - see the linked ticket for some possible solutions.

[pikazlou]

hi @shockey
Thanks for your reply!
I must note that User-Agent header does work in Safari: swagger successfully sends specified value.

[czxsj]

@shockey it certainly works in Safari.Thanks for the advice.

[matt1munich]

It also works properly in Windows Firefox -- not so much in Chrome & Edge.