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

fix(sample-gen): additionalProps generation for minProperties=1 #7431

Conversation

hkosova
Copy link
Contributor

@hkosova hkosova commented Jul 23, 2021

Description

This PR fixes an issue where an empty example was generated for an object with additionalProperties and minProperties: 1. And in general, examples for minProperties: N + additionalProperties were generated with N-1 properties.

The issue occurred because the loop that added additionalProps used < instead of <= to check the exit condition, and so it never executed when toGenerateCount was 1.

for (let i = 1; i < toGenerateCount; i++) {

Motivation and Context

Fix/improve example generation.

How Has This Been Tested?

Tested manually + added tests.

Example 1

Sample schema:

type: object
minProperties: 1
additionalProperties:
  type: string

Result before the fix:

{}

After the fix:

{
  "additionalProp1": "string"
}

Example 2

Sample schema:

type: object
minProperties: 2
additionalProperties:
  type: string

Result before the fix:

{
  "additionalProp1": "string"
}

After the fix:

{
  "additionalProp1": "string",
  "additionalProp2": "string"
}

Screenshots (if appropriate):

n/a

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@hkosova
Copy link
Contributor Author

hkosova commented Jul 23, 2021

Closing because this PR was created from a wrong branch that had extra commits.

Replaced by PR #7432.

@hkosova hkosova closed this Jul 23, 2021
@hkosova hkosova deleted the fix/sample-gen-additionalProperties-minProperties branch July 23, 2021 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant