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

[typescript] Don't throw exception when additionalProperties is set to true #13003

Merged
merged 3 commits into from
Jul 24, 2022

Conversation

ty-v1
Copy link
Contributor

@ty-v1 ty-v1 commented Jul 24, 2022

resolves #12973

This PR enables typescript generator to generate code without throwing any exceptions when additionalProperty is explicitly set to true, as in the following example.

openapi: 3.0.3
components:
  schemas:
    foo:
      properties:
        bar:
          additionalProperties: true
          description: baz
          type: object
      type: object
info:
  title: Repro
  version: 1.0.0
paths:
  "/":
    get:
      description: Foo
      operationId: getFoo
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  foo:
                    description: Foo.
                    type: string
                required:
                - foo
                type: object
          description: Foo
      summary: Foo
      tags:
      - metadata

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 (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@ty-v1 ty-v1 marked this pull request as draft July 24, 2022 05:58
@ty-v1 ty-v1 changed the title [WIP][typescript] Fix #12973 [WIP][typescript] Don't throw exception when additionalProperties is set to true Jul 24, 2022
@ty-v1 ty-v1 changed the title [WIP][typescript] Don't throw exception when additionalProperties is set to true [WIP][typescript] Don't throw exception when additionalProperties is set to true Jul 24, 2022
@ty-v1 ty-v1 marked this pull request as ready for review July 24, 2022 06:06
@ty-v1
Copy link
Contributor Author

ty-v1 commented Jul 24, 2022

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

@ty-v1 ty-v1 changed the title [WIP][typescript] Don't throw exception when additionalProperties is set to true [typescript] Don't throw exception when additionalProperties is set to true Jul 24, 2022
Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

@macjohnny macjohnny merged commit 3eb3337 into OpenAPITools:master Jul 24, 2022
@macjohnny macjohnny added this to the 6.1.0 milestone Jul 24, 2022
@ty-v1 ty-v1 deleted the fix-#12973 branch July 25, 2022 01:44
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.

[BUG] typescript generator throws when additionalProperties is set to true
2 participants