OpenAPITools / OpenAPITools/openapi-generator

[BUG][Go] Inline enums not generated

Open
#2,360 4 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Go Inline Schema Handling Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • [ x ] Have you provided a full/minimal spec to reproduce the issue?
  • [ x ] Have you validated the input using an OpenAPI validator (example)?
  • [ x ] What's the version of OpenAPI Generator used?
  • [ x ] Have you search for related issues/PRs?
  • [ x ] What's the actual output vs expected output?
Description

Enums that are declared inline are simply being declared as strings, while the same enum defined as a separate schema is properly captured with all legal values.

openapi-generator version

4.0.0-SNAPSHOT built from this commit: https://github.com/OpenAPITools/openapi-generator/commit/b128d1470709c44c6c7b6a906e1993d1c2758b52

OpenAPI declaration file content or url

sample.yaml:

openapi: "3.0.0"
info:
  version: v1
  title: Fake Service
servers:
- url: https://fake.net
paths:
  /status/details:
    get:
      summary: Get status details
      operationId: getStatus
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/StatusDetails"

components:
  schemas:
    State:
      type: string
      enum:
      - "IN_PROGRESS"
      - "READY"
      - "FAILED"
    StatusDetails:
      properties:
        id:
          type: string
        stateInline: # enum not captured, just declared as "string"
          type: string
          enum:
          - "IN_PROGRESS"
          - "READY"
          - "FAILED"
        state: # works as expected
          $ref: "#/components/schemas/State"
Command line used for generation

java -jar openapi-generator-cli.jar generate -i sample.yaml -g go -o ./sample-go

Steps to reproduce
  1. git clone https://github.com/OpenAPITools/openapi-generator.git
  2. cd openapi-generator
  3. git checkout b128d1470709c44c6c7b6a906e1993d1c2758b52
  4. mvn clean install
  5. ln -s modules/openapi-generator-cli/target/openapi-generator-cli.jar .
  6. java -jar openapi-generator-cli.jar generate -i sample.yaml -g go -o ./sample-go
Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/issues/2200
https://github.com/OpenAPITools/openapi-generator/issues/1702
https://github.com/OpenAPITools/openapi-generator/issues/1706

Actual vs Expected output

Go:
model_status_details.go (actual):

package openapi

type StatusDetails struct {
	Id string `json:"id,omitempty"`
	StateInline string `json:"stateInline,omitempty"`
	State State `json:"state,omitempty"`
}

model_status_details.go (expected):

package openapi

type StatusDetails struct {
	Id string `json:"id,omitempty"`
	StateInline StateInlineEnum `json:"stateInline,omitempty"`
	State State `json:"state,omitempty"`
}

type StateInlineEnum string

// List of StateInlineEnum
const (
	IN_PROGRESS StateInlineEnum = "IN_PROGRESS"
	READY StateInlineEnum = "READY"
	FAILED StateInlineEnum = "FAILED"
)
Suggest a fix

PR has been put up: https://github.com/OpenAPITools/openapi-generator/pull/2494

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

Start with sample.yaml and reproduce the issue using the stated openapi-generator-cli command. Inspect how the Go generator produces model_status_details.go for inline enums, then compare it with the expected StateInlineEnum type and constants. Done means inline enum properties are represented with their legal values rather than as plain strings; PR 2494 is already linked from the report.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, java, openapi
Domain
backend-api-design, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.