Skip to content

Add style and explode#4042

Merged
wing328 merged 9 commits intoOpenAPITools:masterfrom
ackintosh:style-explode
Oct 17, 2019
Merged

Add style and explode#4042
wing328 merged 9 commits intoOpenAPITools:masterfrom
ackintosh:style-explode

Conversation

@ackintosh
Copy link
Copy Markdown
Contributor

@ackintosh ackintosh commented Oct 3, 2019 •
edited
Loading

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Related issue: #4039

In order to provide better collection serialization support, add style and explode attributes to CodegenParameter.

@ackintosh
Copy link
Copy Markdown
Contributor Author

ackintosh commented Oct 13, 2019 •
edited
Loading

I've checked that the values are available in mustache files.

(PHP)

  • api.mustache
        {{#allParams}}

+       {{#style}}var_dump('{{style}}');{{/style}}
+       var_dump({{isExplode}});

        {{/allParams}}
  • FakeApi.php
    protected function testQueryParameterCollectionFormatRequest($pipe, $ioutil, $http, $url, $context)
    {

        var_dump('form');
        var_dump(true);

@ackintosh ackintosh marked this pull request as ready for review October 13, 2019 08:24
@ackintosh
Copy link
Copy Markdown
Contributor Author

ackintosh commented Oct 13, 2019

cc @OpenAPITools/generator-core-team

wing328
wing328 reviewed Oct 15, 2019
View reviewed changes
Comment thread modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java Outdated
public boolean isFormParam, isQueryParam, isPathParam, isHeaderParam,
isCookieParam, isBodyParam, hasMore, isContainer,
secondaryParam, isCollectionFormatMulti, isPrimitiveType, isModel;
secondaryParam, isCollectionFormatMulti, isPrimitiveType, isModel, shouldExplode;
Copy link
Copy Markdown
Member

@wing328 wing328 Oct 15, 2019

Choose a reason for hiding this comment

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

@ackintosh thanks for the PR. What about using isExplode to follow the naming convention of other boolean flags?

cc @OpenAPITools/generator-core-team

Copy link
Copy Markdown
Member

@wing328 wing328 Oct 15, 2019

Choose a reason for hiding this comment

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

Please update the following functions to include the new property:

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java

Line 100 in df8d9d1

public CodegenParameter copy() {

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java

Line 181 in df8d9d1

public boolean equals(Object o) {

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java

Line 254 in df8d9d1

public int hashCode() {

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenParameter.java

Line 323 in df8d9d1

public java.lang.String toString() {

Copy link
Copy Markdown
Contributor Author

@ackintosh ackintosh Oct 17, 2019

Choose a reason for hiding this comment

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

Thanks for pointing it out!

Copy link
Copy Markdown
Contributor Author

@ackintosh ackintosh Oct 17, 2019

Choose a reason for hiding this comment

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

Updated the comment according to the renaming.
#4042 (comment)

wing328
wing328 approved these changes Oct 17, 2019
View reviewed changes
Copy link
Copy Markdown
Member

@wing328 wing328 left a comment

Choose a reason for hiding this comment

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

LGTM

@wing328 wing328 added this to the 4.2.0 milestone Oct 17, 2019
@wing328
Copy link
Copy Markdown
Member

wing328 commented Oct 17, 2019

CircleCI failure not related to this change.

@wing328 wing328 merged commit 3f35590 into OpenAPITools:master Oct 17, 2019
@ackintosh ackintosh deleted the style-explode branch October 18, 2019 10:08
@ackintosh ackintosh mentioned this pull request Oct 19, 2019
Merged
4 tasks
@wing328
Copy link
Copy Markdown
Member

wing328 commented Oct 31, 2019

@ackintosh thanks for the PR, which has been included in v4.2.0 release: https://twitter.com/oas_generator/status/1189824932345069569

This was referenced Nov 28, 2019
Merged
Closed
@ybelenko ybelenko mentioned this pull request May 14, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wing328 wing328 wing328 approved these changes

Assignees

No one assigned

Labels

Enhancement: Feature Feature: OAS 3.0 spec support

Projects

None yet

Milestone

4.2.0

Development

Successfully merging this pull request may close these issues.

2 participants

@ackintosh @wing328