Repository navigation
References to incorrect components should be considered invalid #171
Description
Expected
Referencing a component that does not meet the criteria an object requires should be considered invalid.
Example
A Response object referencing a component that does not contain a "description" should be considered invalid.
Reasoning
"description" is a REQUIRED property for a Response object.
Actual
Referencing a component that does not meet the criteria an object requires is considered valid.
Example
$api = Reader::readFromJson(<<<JSON
{
"openapi": "3.0.0",
"info": {
"title": "Test API",
"version": "1.0.0"
},
"paths": {
"/path": {
"get": {
"responses": {
"200": {
"\$ref": "#/components/schemas/notAResponse"
}
}
}
}
},
"components": {
"schemas": {
"notAResponse": {
"type": "integer"
}
}
}
}
JSON);
var_dump($api->validate()); // bool(true)
Activity
SOHELAHMED7 commentedon Dec 29, 2022
Concrete validation of entire OpenAPI spec doc is work in progress.
In above case validate of
pathsof OpenAPI is considered.However if you want to validate schema you can see solution at https://github.com/thephpleague/openapi-psr7-validator#standalone-openapi-validator
You can get all schema as:
[-]openApi->validate returns true with invalid response $ref[/-][+]References to incorrect components should be considered invalid[/+]