Skip to content
GitLab

Validation of type `object` will fail when no schema is defined - bug fix

Open Administrator requested to merge github/fork/gbmarc1/validation_type_object_bug into master

Created by: gbmarc1

@taxpon @frol @mbohlool @cbornet @kenjones-cisco @tomplus @Jyhess @arun-nalla @spacether

Assume that we have an endpoint that uses the schema ObjectWithNoReferenceSchema as a response. If this object definition contains another object that is NOT defined in a schema it will fail to validate the sub-object. For example, at deserialization the items in the array are expecting a type object when in fact it is a dict. Validation fails in the client and responses cannot be deserialize.


openapi: 3.0.2
info:
  version: 0.60.1
  title: api
servers:
  - url: /v1


paths:
  /resource:
    get:
      operationId: v1_get
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectWithNoReferenceSchema'
          description: My description
components:
  schemas:
    ObjectWithNoReferenceSchema:
      items:
        additionalProperties: false
        properties:
          id:
            description: identifier
            readOnly: true
            type: integer
        required:
          - id
        type: object
      minItems: 1
      type: array

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.1.x, 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.