Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Wsdl] Handle schema property of type array with oneOf items and other minor updates/fixes #10434

Merged
merged 11 commits into from
Sep 21, 2021

Conversation

adessoDpd
Copy link
Contributor

@adessoDpd adessoDpd commented Sep 20, 2021

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Description of the PR
This small PR adds handling of specific case: Schema with property of type array with oneOf items. In case of this example following WSDL-construct is created.

components:
   schemas:
      fruit:
         title: fruit
         properties:
            color:
               type: string
            Fruitarray:
              type: array
              items:
                oneOf:
                  - $ref: "#/components/schemas/apple"
                  - $ref: "#/components/schemas/banana"

<xs:complexType name="Fruit">
  <xs:sequence>
    <xs:element minOccurs="0" name="color" type="xs:string" />
    <xs:element minOccurs="0" maxOccurs="unbounded" name="apple" type="schemas:Apple" />
    <xs:element minOccurs="0" maxOccurs="unbounded" name="banana" type="schemas:Banana" />
  </xs:sequence>
</xs:complexType>

Some minor updates/fixes has been added as well in this PR since the handling of the oneOf-case was rather small:

  • Uppercase first letter of basetype/datatype of responses (in case of models) to handle the case if schema name was lowercase
    in openapi spec to have a correct reference to the wsdl-complextype:
...
<xs:complexType name="Get_ResponseMessage">
  <xs:sequence>
    <xs:element minOccurs="1" name="Fruit" type="schemas:Fruit">  // instead of  type="schemas:fruit" = schema not found
      ...
  • Remove unnecessary vendor-extension which checked if a openapi model was just an enum, since for this case "isEnum" already existed.
  • Shortening the code in some places for upper-/lowercasing the first letter using substring
  • If response is a file (isFile) type xs:string is now used instead of xs:anyType

I am aware that "oneOf" is still barely handled in this generator like in some other generators, so it is definitely something that needs to be done in the future.

@wing328
Copy link
Member

wing328 commented Sep 21, 2021

Looks good 👍

I'll update the samples and docs after merging this PR.

@wing328 wing328 merged commit 1a48c5f into OpenAPITools:master Sep 21, 2021
@wing328 wing328 added this to the 5.3.0 milestone Sep 21, 2021
@adessoDpd adessoDpd deleted the wsdl-oneof branch September 21, 2021 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants