Skip to content

Conversation

@gcatanese
Copy link
Contributor

In OpenAPI 3.1 the description of the Reference Object SHOULD override that of the referenced component.

This PR corrects the unaliasing of the referenced schema, ovverriding the description of the referenced schema.
A test has been added to verify unaliasSchema as well a test in the Typescript generator.

@wing328

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@gcatanese
Copy link
Contributor Author

@wing328?

ref.setDescription(schema.getDescription());
}
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the fix

but this change will permanently update the description of the reference schema.

if the reference schema is used somewhere else, the description will be the overridden one instead of the original one.

i think a better way to fix it is in the fromProperty in default codegen. or maybe using normalizer to fix it.

I'll try to find time to come up with a fix later this week

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fromProperty what do you mean? Please clarify, maybe I can update the approach

@wing328
Copy link
Member

wing328 commented Nov 17, 2025

here is a workaround using allOf:

        date:
          allOf:
            - $ref: "#/components/schemas/Date"
          description: Reference description of Date schema

@gcatanese gcatanese closed this Nov 17, 2025
@gcatanese gcatanese reopened this Nov 17, 2025
@gcatanese
Copy link
Contributor Author

here is a workaround using allOf:

        date:
          allOf:
            - $ref: "#/components/schemas/Date"
          description: Reference description of Date schema

I don't understand the comment.

@wing328
Copy link
Member

wing328 commented Nov 17, 2025

working on a fix. stay tuned...

@wing328
Copy link
Member

wing328 commented Nov 17, 2025

Just filed #22364. Please test the change locally when you've time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants