Better support for inline schemas in parameters - #12369

Merged
wing328 merged 11 commits into
masterfrom
inline-parameter-enhance
May 20, 2022
Merged

Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom
inline-parameter-enhance

Conversation

@wing328

@wing328wing328 commented May 14, 2022•
edited
Loading

Copy link
Copy Markdown
Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method

FYI. @OpenAPITools/generator-core-team

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

@wing328
wing328 marked this pull request as ready for review May 14, 2022 16:45
@wing328wing328 added Enhancement: General Inline Schema Handling Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf labels May 14, 2022
@wing328wing328 added this to the 6.0.0 milestone May 14, 2022
spacether
spacether reviewed May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
* @param schema potentially containing a '$ref'
* @return true if it's a model with at least one properties
*/
public static boolean isModelWithPropertiesOnly(Schema schema) {

@spacetherspacetherMay 15, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.

How about limiting this to type object and AnyType models only?
Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?

@wing328wing328May 16, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.

I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.

I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.

@spacetherspacetherMay 16, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed

@spacetherspacetherMay 18, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534

@spacetherspacetherMay 18, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?

@sorin-floreasorin-florea mentioned this pull request May 18, 2022
Open
spacether
spacether reviewed May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java Outdated
if (parameter.getSchema() != null) {
parameterSchema = parameter.getSchema();
parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());

@spacetherspacetherMay 18, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema
The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.

This code instead gets the schema from the ref automatically.
So why is unaliasSchema not handling this case automatically originally?

spacether
spacether reviewed May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
if (parameterDataType != null) {
codegenParameter.dataType = parameterDataType;
if (parameterModelName != null) {
codegenParameter.dataType = parameterModelName;

@spacetherspacetherMay 18, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?

@wing328wing328May 19, 2022

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.

spacetherand others added 4 commits May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328 mentioned this pull request May 19, 2022
Closed
5 tasks
@Dimon70007

Dimon70007 commented May 19, 2022

Copy link
Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022
Closed
Closed
@wing328
wing328 merged commit c270640 into masterMay 20, 2022
@wing328
wing328 deleted the inline-parameter-enhance branch May 20, 2022 12:25
@wing328

wing328 commented May 20, 2022

Copy link
Copy Markdown
MemberAuthor

@Dimon70007 please pull the latest master to give it a try.

@Dimon70007

Dimon70007 commented May 20, 2022

Copy link
Copy Markdown

Thanks. I'll try it this evening.

@Dimon70007

Dimon70007 commented May 23, 2022

Copy link
Copy Markdown

Have tried to build from source with

mvn clean package

but there were failed tests

[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?

@Dimon70007

Dimon70007 commented May 25, 2022•
edited
Loading

Copy link
Copy Markdown

succeed package jar with ./mvnw clean package
but have no luck when parsing schema with many $ref

@oujeskyoujesky mentioned this pull request Jun 24, 2022
Open
6 tasks
@spacetherspacether mentioned this pull request Oct 9, 2022
Open
5 tasks
spacether
spacether reviewed Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
.map(entry -> {
CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
return property;

@spacetherspacetherOct 9, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?
Can this be made to work without modifying the baseName?
Why not modify name instead or another string property.
baseName is historically used to store the spec case property name.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects

None yet

Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Better support for inline schemas in parameters - #12369
Merged
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
May 20, 2022
Merged
Better support for inline schemas in parameters#12369
wing328 merged 11 commits into
masterfrom 
inline-parameter-enhance
Conversation
@wing328
@wing328wing328
commented
May 14, 2022•

edited

Loading

Copy link


Copy Markdown

Member
  • better support for inline schemas in parameters
  • add isModelWithPropertiesOnly method
FYI. @OpenAPITools/generator-core-team
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.
  •  If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@wing328
wing328
marked this pull request as ready for review
May 14, 2022 16:45
@wing328wing328
added

Enhancement: General

Inline Schema Handling
Schema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf
labels
May 14, 2022
@wing328wing328
added this to the 6.0.0 milestone
May 14, 2022
spacether
spacether
reviewed
May 15, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java
 * @param schema potentially containing a '$ref'
 * @return true if it's a model with at least one properties
 */
 public static boolean isModelWithPropertiesOnly(Schema schema) {
@spacetherspacetherMay 15, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Do you want this to be true for AnyType models with properties and additionalProperties set? Right now it is true for that case.
  • Do you want this to be true for array/string/number models with properties and additionalProperties set? Right now it is true for that case.
How about limiting this to type object and AnyType models only?

Also type object with additionalProperties unset is the same as type object with additionalProperties true so why is this code returning different results for those same use cases?
@wing328wing328May 16, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review.
I previously didn't check getAdditionalProperties() but got a few issues (change in samples). Adding the check seems to fix it but you're right that it needs to revised further.
I simply want to set the isModel flag correctly because now isMap is set to true for a simple model. I've not touched the code in modules/openapi-generator/src/main/java/org/openapitools/codegen/IJsonSchemaValidationProperties.java for a while so I welcome suggestions on other way to fix the problem.
@spacetherspacetherMay 16, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me look into what is happening with python experimental. I think it is changing because the component schema changed
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Root cause investigation is here: https://github.com/OpenAPITools/openapi-generator/pull/12369/files#r876380534
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be true if the schema also has anyOf or allOf definitions?
@sorin-floreasorin-florea
mentioned this pull request
May 18, 2022

Open

spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
Outdated

 if (parameter.getSchema() != null) {
 parameterSchema = parameter.getSchema();
 parameterModelName = getParameterDataType(parameter ,parameter.getSchema());
 parameterSchema = ModelUtils.getReferencedSchema(openAPI, parameter.getSchema());
@spacetherspacetherMay 18, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something odd is happening with unaliasSchema

The original code extracts the schema, unaliases it, then uses that unaliased schemas to set properties.
This code instead gets the schema from the ref automatically.

So why is unaliasSchema not handling this case automatically originally?
spacether
spacether
reviewed
May 18, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 if (parameterDataType != null) {
 codegenParameter.dataType = parameterDataType;
 if (parameterModelName != null) {
 codegenParameter.dataType = parameterModelName;
@spacetherspacetherMay 18, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should codegenParameters handle dataType and complexType differently than codegenProperty?
@wing328wing328May 19, 2022

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change above simply uses a different (better) name in the code block as parameterDataType originally aims to store the model name so no change in code logic if I remember correctly.
spacetherand others
added 4 commits
May 19, 2022 10:50
@spacether
inline parameter enhance with python-experimental fix [WIP] (#12397)
ced1d53
* Uses unaliasSchema rather than ModelUtils.getReferencedSchema
* Fixes python-experimental, delays param schema setting
* Samples regenerated
* Adds parameterModelName setting back in
* Samples regenerated
* removes needToSetSchema
* Sets schema differently depending on if inline model resolver is used
* Adds step for getting ref schema
* Samples regen
@wing328
Merge branch 'inline-parameter-enhance' ofhttps://github.com/OpenAPI…
5ffc8c8
…Tools/openapi-generator into inline-parameter-enhance
@wing328
fix test
f531f37
@wing328
bug fix for rust generator
b7aa873
@wing328wing328
mentioned this pull request
May 19, 2022
 Closed

5 tasks
@Dimon70007
Dimon70007
commented
May 19, 2022

Copy link


Copy Markdown

Hi guys. Will this PR fixes #11151 ?

This was referenced May 20, 2022

Closed


Closed

@wing328
wing328
merged commit c270640
into
masterMay 20, 2022
@wing328
wing328
deleted the

inline-parameter-enhance

branch
May 20, 2022 12:25
@wing328
wing328
commented
May 20, 2022

Copy link


Copy Markdown

MemberAuthor
@Dimon70007 please pull the latest master to give it a try.
@Dimon70007
Dimon70007
commented
May 20, 2022

Copy link


Copy Markdown

Thanks. I'll try it this evening.
@Dimon70007
Dimon70007
commented
May 23, 2022

Copy link


Copy Markdown

Have tried to build from source with
mvn clean package

but there were failed tests
[ERROR] Failures: [ERROR] DefaultGeneratorTest.supportCustomTemplateEngine:313 » Runtime Could not generate api file for 'Ping'
[ERROR] StringHelpersTest.startsWithSectionalTest:47->evaluate:28 » Handlebars inline@486b7642:1:4: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@486b7642:1:4
[ERROR] StringHelpersTest.startsWithTest:61->evaluate:28 » Handlebars inline@43bd77be:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@43bd77be:1:2
[ERROR] StringHelpersTest.startsWithYesOverrideTest:81->evaluate:28 » Handlebars inline@689e2599:1:2: java.lang.reflect.InaccessibleObjectException: Unable to make field transient java.util.HashMap$Node[] java.util.HashMap.table accessible: module java.base does not "opens java.util" to unnamed module @3b22cdd0
inline@689e2599:1:2
[INFO] [ERROR] Tests run: 1634, Failures: 4, Errors: 0, Skipped: 0

Did i do something wrong?
@Dimon70007
Dimon70007
commented
May 25, 2022•

edited

Loading

Copy link


Copy Markdown

succeed package jar with ./mvnw clean package

but have no luck when parsing schema with many $ref
@oujeskyoujesky
mentioned this pull request
Jun 24, 2022

Open

6 tasks
@spacetherspacether
mentioned this pull request
Oct 9, 2022

Open

5 tasks
spacether
spacether
reviewed
Oct 9, 2022
View reviewed changes
Comment threadmodules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
 .map(entry -> {
 CodegenProperty property = fromProperty(entry.getKey(), entry.getValue());
 property.baseName = codegenParameter.baseName + "[" + entry.getKey() + "]";
 return property;
@spacetherspacetherOct 9, 2022•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is property.baseName being modified here?

Can this be made to work without modifying the baseName?

Why not modify name instead or another string property.

baseName is historically used to store the spec case property name.
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


1 more reviewer

@spacetherspacetherspacether left review comments
Reviewers whose approvals may not affect merge requirements

Assignees


No one assigned


Labels

Breaking change (without fallback)Enhancement: GeneralInline Schema HandlingSchema contains a complex schema in items/additionalProperties/allOf/oneOf/anyOf

Projects


None yet


Milestone

6.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@wing328@Dimon70007@spacether