Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add type+format mappings for go #21032

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cbascom
Copy link
Contributor

@cbascom cbascom commented Apr 4, 2025

Add type+format mappings for Go generator

Description

Adds support for explicit type+format mappings in the Go generator, allowing precise control over numeric types through both integer and number formats. This enhancement enables users to specify exact Go numeric types using OpenAPI's type and format fields.

New Type Mappings

Integer Format Mappings

OpenAPI Type+Format Go Type
integer+int8 int8
integer+uint8 uint8
integer+int16 int16
integer+uint16 uint16
integer+int32 int32
integer+int64 int64
integer+uint32 uint32
integer+uint64 uint64

Number Format Mappings

OpenAPI Type+Format Go Type
number+int8 int8
number+uint8 uint8
number+int16 int16
number+uint16 uint16
number+int32 int32
number+int64 int64
number+uint32 uint32
number+uint64 uint64
number+float32 float32
number+float64 float64

Default mappings remain unchanged:

  • integerint32
  • numberfloat32
  • longint64
  • floatfloat32
  • doublefloat64
  • decimalfloat64

Usage Example

components:
  schemas:
    MyModel:
      type: object
      properties:
        byteValue:
          type: integer
          format: uint8
        preciseFloat:
          type: number
          format: float64
        standardInt:
          type: integer  # defaults to int32

Closes: #21031

@antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) @lwj5 (2023/04)

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 Git BASH)
    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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

We now register type+format mappings for the go generator so that types
like integer with format uint64 get mapped correctly.
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.

[REQ] Update go generator to honor type and format for numbers
1 participant