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

[codegen][Go] Fix compilation error of generated go code when schema is free form object

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/CiscoM31/go-experimental-free-form into master Feb 20, 2020
  • Overview 0
  • Commits 37
  • Pipelines 0
  • Changes 18

Created by: sebastien-rosset

codegen:

  1. Add helper function isAnyTypeSchema()
  2. Add code comments to clearly differentiate between free-form object (which must be a map of string to value) and any type value (which can be array, object, string, integer...).
  3. Remove unused min/max fields in CodegenProperty
  4. Add code comments in CodegenProperty
  5. Fix equals() method in CodegenProperty. The deprecated attribute was a comparison to itself

golang: When a schema is Free Form object, the go-experimental generator sets the golang dataType to NullableMap[string]interface{}, which is not a valid go type. This causes a compilation failure of the generated code.

This PR is a fix for this problem.

components:
  schema:
        stuff:
            type: object
            nullable: true

Issue: #5387

From this PR, it's clear there is a different interpretation of the OAS spec between the go-experimental generator versus the python-experimental generator. This is a problem that needs to be addressed to get consistency across languages.

  • In the generated go client, the only accepted type is a map of string to values
  • In the generated python client, any valid JSON document will be accepted.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/CiscoM31/go-experimental-free-form