Object Without Required Property (v2)

• Query id: 5e5ecb9d-04b5-4e4f-b5a5-6ee04279b275
• Query name: Object Without Required Property (v2)
• Platform: OpenAPI
• Severity: Info
• Category: Structure and Semantics
• URL: Github

Description

OpenAPI Object should contain all of its required fields
Documentation

Code samples

Code samples with security vulnerabilities

Positive test num. 1 - json file

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API Overview"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "200 response"
          }
        }
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "query",
      "description": "max records to return",
      "required": true
    }
  }
}

Positive test num. 2 - yaml file

swagger: "2.0"
info:
  title: Simple API Overview
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "200":
          description: 200 response
parameters:
  limitParam:
    name: limit
    in: query
    description: max records to return
    required: true

Code samples without security vulnerabilities

Negative test num. 1 - json file

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "200 response"
          }
        }
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "query",
      "description": "max records to return",
      "required": true,
      "type": "string"
    }
  }
}

Negative test num. 2 - yaml file

swagger: "2.0"
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "200":
          description: 200 response
parameters:
  limitParam:
    name: limit
    in: query
    description: max records to return
    required: true
    type: string