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
  • !3927

typescript-node: Fix cookie auth, fix multiple API key auth

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/janjongboom/typescript-node-bugs into master Sep 20, 2019
  • Overview 0
  • Commits 3
  • Pipelines 0
  • Changes 10

Created by: janjongboom

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

TC: @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @nicokoenig (2018/09) @topce @akehir

Description of the PR

This pull request fixes two issues with the typescript-node generator:

  1. If multiple API Key authentication schemas are defined the generator emits code that won't compile.
  2. in: cookie is not supported.

Multiple API Key authentication schemas

If you have the following OpenAPI definition:

components:
    securitySchemes:
        ApiKeyAuthentication:
            type: apiKey
            in: header
            name: x-api-key
        JWTAuthentication:
            type: apiKey
            in: cookie
            name: jwt

The generator emits the following code:

import { ApiKeyAuth } from '../model/models';		
import { ApiKeyAuth } from '../model/models';		

This won't compile. In api-single.mustache there's currently a loop around all authentication methods that outputs a single line depending on the authentication mode. This is not necessary as HttpBasicAuth, ApiKeyAuth and OAuth are always present in ../models/models. Always emitting a single line that references all of these will prevent this error.

in: cookie

components:
    securitySchemes:
        JWTAuthentication:
            type: apiKey
            in: cookie
            name: jwt

Will emit code that adds the API key to the query string, as in: cookie is not handled at all. This patch adds a handler that sets the Cookie header if this field is present.

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/janjongboom/typescript-node-bugs