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
  • Issues
  • #4384
Closed
Open
Issue created Nov 06, 2019 by Administrator@rootContributor

[BUG][JAVASCRIPT] Node scope in projectName generates code that is unusable (e.g. projectName=@mypackagescope/mypackagename)

Created by: rburbidge

Description

If you want use a scoped node package name, then the generator will generate unusable code.

Actual openapi-generator generate -i .\api-with-examples.yaml -g javascript -o generated-sources/openapi --additional-properties="projectName=@mypackagescope/mypackagename Will generate the README.md excerpt

var @MypackagescopeMypackagename = require('@mypackagescope/mypackagename');
var api = new @MypackagescopeMypackagename.DefaultApi()

Expected Expected input is up for discussion. What I would do is add a nodeScope parameter so that --additional-properties="nodeScopeName=mypackagescope,projectName=mypackagename generates

var Mypackagename = require('@mypackagescope/mypackagename');
var api = new Mypackagename.DefaultApi()
openapi-generator version

4.2.0

OpenAPI declaration file content or url
openapi: "3.0.0"
info:
  title: Simple API overview
  version: 2.0.0
paths:
  /:
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        '200':
          description: |-
            200 response
          content:
            application/json:
              examples: 
                foo:
                  value: { }
Command line used for generation

Actual openapi-generator generate -i .\api-with-examples.yaml -g javascript -o generated-sources/openapi --additional-properties="projectName=@mypackagescope/mypackagename" Expected (suggested) openapi-generator generate -i .\api-with-examples.yaml -g javascript -o generated-sources/openapi --additional-properties="nodeScope=mypackagescope,projectName=mypackagename"

Steps to reproduce

Run the command on any valid specification.yaml. Observe the generated README and code.

Related issues/PRs
Suggest a fix
Assignee
Assign to
Time tracking