OpenAPITools / OpenAPITools/openapi-generator

[REQ][Go] Add support for YAML tags to generated model structs

Open
#9,855 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

go-yaml relies uses yaml:"" tags from struct definitions to drive marshalling/unmarshalling. When the tags aren't present, it defaults to using field names in all lowercase. This causes problems when sending requests to a server that uses case-sensitive unmarshalling.

Describe the solution you'd like

The go generator already supports a withXml parameter to optionally add xml:"" tags to struct fields. I'd propose adding a withYaml parameter to add yaml:"" tags.

Describe alternatives you've considered

Users can extract model_simple.mustache and add the yaml:"" tags themselves (my current workaround). It's not ideal because the file is large, and there are only 2 lines that need editing to add the tags.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read model_simple.mustache and the Go generator's existing withXml option first. Add the parallel withYaml option and YAML tags to generated model fields, then verify that generated structs contain the requested tags.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.