OpenAPITools / OpenAPITools/openapi-generator

[BUG][GO] OpenAPI gen seems to generate incorrect struct for a list of maps/dicts

Open
#15,582 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
    Response:
      type: object
      properties:
        size:
          type: integer
          format: int32
        next:
          type: string
        resources:
          type: array
          items:
            type: object
            additionalProperties:
              type: object

I have the above yaml spec
generated from the Java code:

public class Response {
  private int size;
  private String next;
  private List<Map<String, Object> resources = new ArrayList<>();
}

The go-client generated based on my full yaml spec has this definition of the Response struct:

// Response struct for Response
type Response struct {
	Size *int32 `json:"size,omitempty"`
	Next *string `json:"next,omitempty"`
	Resources []map[string]map[string]interface{} `json:"resources,omitempty"`
}

The type that is generated for Resources seems incorrect for me;
My Java code is a List<Map<String, Object>, and the equivalent generated go code is: List<Map<String, Map<String, Object>>.

Is this a bug? Am I misinterpreting what is happening?

openapi-generator version

6.4.0

Could anyone please advise if this is a bug or something is defined incorrectly on my side?

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

Reproduce the issue from the supplied OpenAPI YAML with the Go client generator at version 6.4.0, then inspect the generated Response struct and its Resources field. Compare that output with the Java List<Map<String, Object>> example and determine whether the schema interpretation or generation is incorrect; done means the behavior is corrected or clearly explained with coverage for the supplied case.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, java, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.