Skip to content

Conversation

@shockey
Copy link
Contributor

@shockey shockey commented Jan 26, 2018

Description

This pull request modifies the J sonSchema display components to accept a new errors property from ParameterRow instead of reaching into schema for an errors property.

This is necessary for OAS3 to validate intelligently (i..e, provide user indications and messages), since which Swagger 2 has its schema properties spread at the parameter's top level, OpenAPI Specification 3.0 has a schema property within a parameter.

Motivation and Context

Fixes #3747.

How Has This Been Tested?

  • Manually tested in 2.0 and 3.0 definitions.
  • All existing tests continued to pass.

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.

Breaking private change: JsonSchemaForm now needs a errors prop to display validation information; it no longer reaches into schema for the information.

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.

Existing tests seem adequate.

@shockey shockey merged commit 1e1b7f6 into swagger-api:master Jan 26, 2018
@pho-enix
Copy link

Issue happens again for me using latest version (3.13.1).

    parameters:
    - name: mustbeset
      schema:
        type: string
      in: path
      required: true

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.

OAS 3.0 | Swagger-UI | Required input parameters not getting validated

2 participants