OpenAPITools / OpenAPITools/openapi-generator

[BUG][GO-SERVER] Enum fromValue functions always returns string in case of invalid values

Open
#20,084 0 comments 1 reaction 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

The current golang server enum template modules/openapi-generator/src/main/resources/go-server/model.mustache produces a bugged code for enum values.
The New{{{classname}}}FromValue function always returns an empty string when the ev is not valid, so for integer enums the code does not compile.

The bugged code is the following

func NewErrorCodesFromValue(v int32) (ErrorCodes, error) {
	ev := ErrorCodes(v)
	if ev.IsValid() {
		return ev, nil
	}

	return "", fmt.Errorf("invalid value '%v' for ErrorCodes: valid values are %v", v, AllowedErrorCodesEnumValues)
}

Expected output

func NewErrorCodesFromValue(v int32) (ErrorCodes, error) {
	ev := ErrorCodes(v)
	if ev.IsValid() {
		return ev, nil
	}
	noValue := new(ErrorCodes)
	return *noValue, fmt.Errorf("invalid value '%v' for ErrorCodes: valid values are %v", v, AllowedErrorCodesEnumValues)
}
openapi-generator version

The latest version is affected

OpenAPI declaration file content or url

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 modules/openapi-generator/src/main/resources/go-server/model.mustache and generate a go-server project from the provided schema containing integer enum values. Check the generated New{{{classname}}}FromValue function and compile the result. Done means invalid integer enum values return the typed zero value and an error without compilation failures.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.