-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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
[WIP] Make Schema type retrieval and checks 3.1 compatible #18034
base: master
Are you sure you want to change the base?
[WIP] Make Schema type retrieval and checks 3.1 compatible #18034
Conversation
@@ -841,9 +841,6 @@ components: | |||
type: string | |||
message: | |||
type: string | |||
StringOrInt: | |||
description: string or int | |||
type: [string, integer] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed because its not correct syntax. The one bellow it, OneOfStringOrInt
, is.
@@ -593,97 +601,97 @@ public static boolean isMapSchema(Schema schema) { | |||
* @return true if the specified schema is an Array schema. | |||
*/ | |||
public static boolean isArraySchema(Schema schema) { | |||
return (schema instanceof ArraySchema); | |||
return schema instanceof ArraySchema || "array".equals(getSchemaType(schema)); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This check now allows 3.1 JsonSchema with type "array" which is the equivalent of the 3.0.X ArraySchema. This is the cause of the large number of changes around ArraySchema
casts in this commit.
@g-getsov thanks for the PR. Can you please PM me via Slack to discuss this PR when you've time next week? https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g |
Swagger Parser only populates the Schema's
type
field for OAS3.0.X
and under. For schemas versioned3.1.0
and above the type will be populated in thetypes
field instead (reference).The solution proposed by swagger-parser is to set the System property
bind-type
which will ensure that thegetType()
method of theSchema
object will perform the same process of extracting the type as theModelUtils.getSchemaType()
function that I've implemented in this MR.I believe that using the proposed
ModelUtils.getSchemaType()
function will allow for more flexibility when writing logic for backward compatibility that might require a distinction of the origin of thetype
field.This MR makes almost all
type
checks spec version agnostic which should hopefully resolve a good chunk of edge cases for3.1.0
generations.PR checklist
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.
master
(upcoming 7.1.0 minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)