Schema Enum Invalid (v3)

• Query id: 03856cb2-e46c-4daf-bfbf-214ec93c882b
• Query name: Schema Enum Invalid (v3)
• Platform: OpenAPI
• Severity: Info
• Category: Structure and Semantics
• URL: Github

Description

The field 'enum' of Schema Object should be consistent with the schema's type
Documentation

Code samples

Code samples with security vulnerabilities

Positive test num. 1 - json file

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "201": {
            "description": "201 response",
            "content": {
              "text/html": {
                "schema": {
                  "type": "number",
                  "enum": [
                    "black"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Positive test num. 2 - json file

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "201": {
            "description": "201 response",
            "content": {
              "text/html": {
                "schema": {
                  "type": "integer",
                  "enum": [
                    "black"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Positive test num. 3 - yaml file

openapi: 3.0.0
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "201":
          description: 201 response
          content:
            "text/html":
              schema:
                type: number
                enum:
                  - black

Positive test num. 4 - yaml file

openapi: 3.0.0
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "201":
          description: 201 response
          content:
            "text/html":
              schema:
                type: integer
                enum:
                  - black

Positive test num. 5 - json file

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "$ref": "#/definitions/User"
          }
        },
        "parameters": [
          {
            "$ref": "#/parameters/limitParam"
          }
        ]
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "body",
      "description": "max records to return",
      "required": true,
      "schema": {
        "type": "integer"
      }
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string",
          "enum": [
            "kics",
            1
          ]
        }
      }
    }
  }
}

Positive test num. 6 - yaml file

swagger: "2.0"
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "200":
          "$ref": "#/definitions/User"
      parameters:
        - "$ref": "#/parameters/limitParam"
parameters:
  limitParam:
    name: limit
    in: body
    description: max records to return
    required: true
    schema:
      type: integer
definitions:
  User:
    type: object
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
        enum:
          - kics
          - 1

Code samples without security vulnerabilities

Negative test num. 1 - json file

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "201": {
            "description": "201 response",
            "content": {
              "text/html": {
                "schema": {
                  "type": "number",
                  "enum": [
                    1,
                    2,
                    3,
                    4,
                    5
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Negative test num. 2 - json file

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "201": {
            "description": "201 response",
            "content": {
              "text/html": {
                "schema": {
                  "type": "integer",
                  "enum": [
                    1,
                    2,
                    3,
                    4,
                    5
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

Negative test num. 3 - yaml file

openapi: 3.0.0
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "201":
          description: 201 response
          content:
            "text/html":
              schema:
                type: number
                enum:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5

Negative test num. 4 - yaml file

openapi: 3.0.0
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "201":
          description: 201 response
          content:
            "text/html":
              schema:
                type: integer
                enum:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5

Negative test num. 5 - json file

{
  "swagger": "2.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "get": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "$ref": "#/definitions/User"
          }
        },
        "parameters": [
          {
            "$ref": "#/parameters/limitParam"
          }
        ]
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "body",
      "description": "max records to return",
      "required": true,
      "schema": {
        "type": "integer"
      }
    }
  },
  "definitions": {
    "User": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "name": {
          "type": "string",
          "enum": [
            "kics",
            "checkmarx"
          ]
        }
      }
    }
  }
}

Negative test num. 6 - yaml file

swagger: "2.0"
info:
  title: Simple API Overview
  version: 1.0.0
paths:
  "/":
    get:
      operationId: listVersionsv2
      summary: List API versions
      responses:
        "200":
          "$ref": "#/definitions/User"
      parameters:
        - "$ref": "#/parameters/limitParam"
parameters:
  limitParam:
    name: limit
    in: body
    description: max records to return
    required: true
    schema:
      type: integer
definitions:
  User:
    type: object
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
        enum:
          - kics
          - checkmarx