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

[Go] Prevent naming collisions between model properties and generated getter/setter methods

  • Review changes

  • Download
  • Email patches
  • Plain diff
Open Administrator requested to merge github/fork/knazarenko-ptc/go-fix-field-naming-conflicts into master Jun 23, 2022
  • Overview 0
  • Commits 3
  • Pipelines 1
  • Changes 1

Created by: DouglasDwyer

This PR adds a small fix for naming collisions in Go between generated struct fields and getter/setter method names. When using the Go generator, specifications that include model properties like Area and HasArea will cause code to be generated with compilation errors. This occurs because the HasArea field on the generated model has the same name as the HasArea() function for checking whether the model contains an Area property. This change adds a conflict resolution method which automatically renames model fields by appending underscore characters (_) to them until no more naming conflicts occur (without changing the underlying JSON names).

Here is a simple example of a specification which causes issues:

openapi: 3.0.1
info:
  title: Test REST API
  description: ''
  termsOfService: ''
  version: 0.0.0
paths: {}
components:
  schemas:
    Broken:
      type: object
      properties:
        hasMass:
          type: boolean
        mass:
          type: array
          items:
            type: number
            format: double

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 (6.0.1) (patch release), 6.1.x (breaking changes with fallbacks), 7.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. @antihax @grokify @kemokemo @jirikuncar @ph4r5h4d
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/knazarenko-ptc/go-fix-field-naming-conflicts