Skip to content

Conversation

@epou
Copy link
Contributor

@epou epou commented Nov 7, 2025

This PR updates the examples and documentation to use UUID fields of type UUID instead of str.

While str works for UUID fields (since Pydantic automatically casts strings to UUID objects), using the actual UUID type provides better clarity and type consistency in the generated models and examples.
Notes:

  • This change introduces UUID to languageSpecificPrimitives, similar to how datetime is handled.
  • The uuid package is part of Python’s standard library, so this doesn’t add any external dependencies.
  • Although using str isn’t technically incorrect, adopting UUID makes the documentation more explicit and aligned with real-world usage.

Relates to PR #21740

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.

@cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)

@wing328 wing328 merged commit f37b8cc into OpenAPITools:master Nov 8, 2025
36 checks passed
@wing328 wing328 added this to the 7.18.0 milestone Nov 8, 2025
@wing328 wing328 mentioned this pull request Nov 8, 2025
6 tasks
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