Skip to content

Conversation

@spacether
Copy link
Contributor

@spacether spacether commented Nov 23, 2021

Adds codegenParameter.schema to allow referenced schemas in parameters
This allows referenced schemas in request parameters as #10927 requests.
In the future whole parameters may be referenced, so adding a class property which stores a schema codegenProperty allows us to:

  • store when there is a schema for a Parameter
  • tell when that schema is referenced to a component
  • will allow us to tell the difference in the future between a referenced Parameter and a referenced parameter schema
    • right now for a single schema or content schema, those schema's properties like isMap are stored on codegenParameter.
    • that is an unclear way to do it because let's say the parameter references parameter definition in components/parameters as a ref property in codegenParameter. Does that ref property mean that the Parameter is referenced or the parameter schema is referenced?

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.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@spacether spacether added this to the 5.3.1 milestone Nov 26, 2021
@spacether spacether merged commit 06faa28 into OpenAPITools:master Nov 26, 2021
@spacether spacether deleted the feat_codegenParameter_adds_schema branch November 26, 2021 02:00
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.

[REQ] Support referenced Schemas, Parameters, Headers, Request Bodies

1 participant