Unknown Property (v3)
- Query id: fb7d81e7-4150-48c4-b914-92fc05da6a2f
- Query name: Unknown Property (v3)
- Platform: OpenAPI
- Severity: Info
- Category: Structure and Semantics
- CWE: 665
- URL: Github
Description¶
All properties defined in OpenAPI objects should be known
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": {
"200": {
"descrinnption": "200 response"
}
}
}
}
},
"security": [
{
"exampleSecurity": []
}
],
"tags": [
{
"name": "pets",
"desdddcription": "Everything about your Pets",
"externalDocs": {
"url": "http://docs.my-api.com/pet-operations.htm"
}
},
{
"name": "store",
"description": "Access to Petstore orders",
"externalDocs": {
"url": "http://docs.my-api.com/store-orders.htm"
}
}
]
}
Positive test num. 2 - json file
{
"openapi": "3.0.0",
"infjnjnjno": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"get": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"tybhbhbpe:": "object",
"discriminator": {
"propertyName": "petType"
},
"properties": {
"code": {
"type": "string",
"format": "binary"
},
"message": {
"type": "string"
}
}
},
"encoding": {
"code": {
"contentType": "image/png, image/jpeg"
}
}
}
}
}
},
"operationId": "listVersionsv2",
"summary": "List API versions"
}
}
}
}
Positive test num. 3 - json file
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "OK"
}
},
"callbacks": {
"inProgress": {
"{$request.body#/inProgressUrl}": {
"pbhbhbost": {
"requestBody": {
"$ref": "#/components/requestBodies/callbackMessage1"
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
}
}
}
}
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:
"200":
descrinnption: 200 response
security:
- exampleSecurity: []
tags:
- name: pets
desdddcription: Everything about your Pets
externalDocs:
url: http://docs.my-api.com/pet-operations.htm
- name: store
description: Access to Petstore orders
externalDocs:
url: http://docs.my-api.com/store-orders.htm
Positive test num. 5 - yaml file
openapi: 3.0.0
infjnjnjno:
title: Simple API Overview
version: 1.0.0
info:
title: Simple API Overview
version: 1.0.0
paths:
"/":
get:
operationId: listVersionsv2
summary: List API versions
responses:
"200":
description: 200 response
content:
application/json:
schema:
tybhbhbpe: object
discriminator:
propertyName: petType
properties:
code:
type: string
format: binary
message:
type: string
encoding:
code:
contentType: image/png, image/jpeg
Positive test num. 6 - yaml file
openapi: 3.0.0
info:
title: Simple API Overview
version: 1.0.0
paths:
"/":
get:
operationId: listVersionsv2
summary: List API versions
responses:
"200":
description: OK
callbacks:
inProgress:
"{$request.body#/inProgressUrl}":
pbhbhbost:
requestBody:
$ref: "#/components/requestBodies/callbackMessage1"
responses:
"200":
description: OK
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": {
"200": {
"description": "200 response"
}
}
}
}
},
"security": [
{
"exampleSecurity": []
}
],
"tags": [
{
"name": "pets",
"description": "Everything about your Pets",
"externalDocs": {
"url": "http://docs.my-api.com/pet-operations.htm"
}
},
{
"name": "store",
"description": "Access to Petstore orders",
"externalDocs": {
"url": "http://docs.my-api.com/store-orders.htm"
}
}
]
}
Negative test num. 2 - json file
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"get": {
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"schema": {
"type": "object",
"discriminator": {
"propertyName": "petType"
},
"properties": {
"code": {
"type": "string",
"format": "binary"
},
"message": {
"type": "string"
}
}
},
"encoding": {
"code": {
"contentType": "image/png, image/jpeg"
}
}
}
}
}
},
"operationId": "listVersionsv2",
"summary": "List API versions"
}
}
}
}
Negative test num. 3 - json file
{
"openapi": "3.0.0",
"info": {
"title": "Simple API Overview",
"version": "1.0.0"
},
"paths": {
"/": {
"get": {
"operationId": "listVersionsv2",
"summary": "List API versions",
"responses": {
"200": {
"description": "OK"
}
},
"callbacks": {
"inProgress": {
"{$request.body#/inProgressUrl}": {
"post": {
"requestBody": {
"$ref": "#/components/requestBodies/callbackMessage1"
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
}
}
}
}
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:
"200":
description: 200 response
security:
- exampleSecurity: []
tags:
- name: pets
description: Everything about your Pets
externalDocs:
url: http://docs.my-api.com/pet-operations.htm
- name: store
description: Access to Petstore orders
externalDocs:
url: http://docs.my-api.com/store-orders.htm
Negative test num. 5 - yaml file
openapi: 3.0.0
info:
title: Simple API Overview
version: 1.0.0
paths:
"/":
get:
operationId: listVersionsv2
summary: List API versions
responses:
"200":
description: 200 response
content:
application/json:
schema:
type: object
discriminator:
propertyName: petType
properties:
code:
type: string
format: binary
message:
type: string
encoding:
code:
contentType: image/png, image/jpeg
Negative test num. 6 - yaml file
openapi: 3.0.0
info:
title: Simple API Overview
version: 1.0.0
paths:
"/":
get:
operationId: listVersionsv2
summary: List API versions
responses:
"200":
description: OK
callbacks:
inProgress:
"{$request.body#/inProgressUrl}":
post:
requestBody:
$ref: "#/components/requestBodies/callbackMessage1"
responses:
"200":
description: OK