OpenAPITools / OpenAPITools/openapi-generator

[BUG] [Go] Optional values should be pointers

Open
#22,237 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?
  • 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

It is the same issue described in https://github.com/OpenAPITools/openapi-generator/issues/522. It was fixed for client, but not server.

openapi-generator version

7.16.0

OpenAPI declaration file content or url
---
openapi: 3.0.0
info:
  title: unset
  version: 0.1.0

paths:
  "/foo":
    get:
      summary: foo
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                "$ref": "#/components/schemas/Bar"

components:
  schemas:
    Bar:
      properties:
        X:
          type: integer
        Y:
          type: integer
      required:
        - X
Related issues/PRs

https://github.com/OpenAPITools/openapi-generator/issues/522 fixed it in the client.

Similar issue: https://github.com/OpenAPITools/openapi-generator/issues/22096

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 the minimal OpenAPI declaration in the issue and reproduce the generated Go server output for schema Bar. Compare the server behavior with the client fix from issue 522, then inspect the Go server generation path. Done means optional schema properties are represented as pointers while required properties retain their required semantics.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.