Skip to content

[go-server] Partially reverts and fix #15185#16258

Merged
wing328 merged 7 commits intoOpenAPITools:masterfrom
lwj5:revert-default
Aug 7, 2023
Merged

[go-server] Partially reverts and fix #15185#16258
wing328 merged 7 commits intoOpenAPITools:masterfrom
lwj5:revert-default

Conversation

@lwj5
Copy link
Copy Markdown
Contributor

@lwj5 lwj5 commented Aug 4, 2023

  1. Partially reverts [go-server] Support min/max/defaults for values #15185. Reverts default value feature.

    Adding UnmarshalJSON breaks struct embedding. Any struct that has embedding will be empty after unmarshalling and API is unusable.

    Such can be reproduced with a model like such:

    title: A
    type: object
    allOf:
      - $ref: "./b.yaml"
    properties:
      value_a:
        type: string
    required:
      - value_a
    
    title: B
    type: object
    discriminator:
      propertyName: type
    properties:
      value_b:
        type: string
      type:
        type: string
    required:
      - value_b
    

    Generated:

    type A struct {
        B
    
        valueA string `json:"value_a,omitempty"`
    }
    
    // UnmarshalJSON sets *m to a copy of data while respecting defaults if specified.
    func (m *A) UnmarshalJSON(data []byte) error {
    
        type Alias A // To avoid infinite recursion
        return json.Unmarshal(data, (*Alias)(m))
    }
    type B struct {
        valueB string `json:"value_b,omitempty"`
    }
    
    // UnmarshalJSON sets *m to a copy of data while respecting defaults if specified.
    func (m *B) UnmarshalJSON(data []byte) error {
    
        type Alias B // To avoid infinite recursion
        return json.Unmarshal(data, (*Alias)(m))
    }

    valueA and valueB will be empty in Go.

  2. Fix optional param errors with empty value in [go-server] Support min/max/defaults for values #15185

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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.

@lwj5
Copy link
Copy Markdown
Contributor Author

lwj5 commented Aug 4, 2023

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

@lwj5 lwj5 changed the title [go-server] Partially reverts #15185 [go-server] Partially reverts and fix #15185 Aug 5, 2023
@wing328
Copy link
Copy Markdown
Member

wing328 commented Aug 6, 2023

@wing328 wing328 added this to the 7.0.0 milestone Aug 6, 2023
@lwj5 lwj5 requested a review from jimschubert as a code owner August 6, 2023 18:08
@lwj5
Copy link
Copy Markdown
Contributor Author

lwj5 commented Aug 6, 2023

That should do it for now.

  • It covers the above cases (optional query params)
  • covers some required checks
  • cover basic parsing

@wing328 wing328 merged commit 2b44d4e into OpenAPITools:master Aug 7, 2023
@lwj5 lwj5 deleted the revert-default branch November 12, 2023 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants