OpenAPITools / OpenAPITools/openapi-generator

[BUG] OpenAPI 3.1: description & summary override when referencing object

Open
#21,191 1 comment 2 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

According to the OpenAPI 3.1 Specification (section 4.8.23), reference objects may include a description and a summary field alongside $ref. The description or summary should override the one defined in the referenced component when present.

However, when generating client code (I've tried with the typescript-axios and go generators), the description is not overridden (and I guess the summary field too), and the incorrect documentation appears for that field in the output code.

openapi-generator version

v7.12.0

OpenAPI declaration file content or url
openapi: 3.1.0
info:
  title: Example API
  version: 1.0.0
paths: {}
components:
  schemas:
    BaseType:
      type: string
      description: The base string type.

    ExampleObject:
      type: object
      properties:
        myField:
          $ref: '#/components/schemas/BaseType'
          description: A field-specific description that should override the base.

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 3.1 declaration in the issue and reproduce generation with the typescript-axios and go generators. Compare the generated field documentation against the component description; done when a sibling Reference Object description or summary overrides the referenced component text.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, openapi, typescript
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.