Skip to content

Fix OpenAPI v3.0 Schema Violation: Array value found, but an object is required #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 9, 2022
Merged

Fix OpenAPI v3.0 Schema Violation: Array value found, but an object is required #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
874984d
Add test to demonstrate OpenAPI v3.0 schema validation fails with emp…
thejamescollins Oct 8, 2021
331fd7d
During serialization convert empty Map fields to empty Objects
thejamescollins Oct 8, 2021
1bd42dd
add comments, optimize tests for #125
cebe Feb 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,21 @@ install: composer.lock yarn.lock
$(DOCKER_PHP) composer install --prefer-dist --no-interaction --no-progress --ansi
$(DOCKER_NODE) yarn install

test:
test: unit test-recursion.json test-recursion2.yaml test-empty-maps.json

unit:
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) vendor/bin/phpunit --verbose --colors=always $(TESTCASE)
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion.json
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion2.yaml

# test specific JSON files in tests/spec/data/
# e.g. test-recursion will run validation on tests/spec/data/recursion.json
test-%: tests/spec/data/%
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate $<

lint: install
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/reference/playlist.json
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion.json
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/recursion2.yaml
$(DOCKER_PHP) php $(PHPARGS) $(XPHPARGS) bin/php-openapi validate tests/spec/data/empty-maps.json
$(DOCKER_NODE) yarn run speccy lint tests/spec/data/reference/playlist.json
$(DOCKER_NODE) yarn run speccy lint tests/spec/data/recursion.json

Expand Down
22 changes: 15 additions & 7 deletions src/SpecBaseObject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,23 @@ public function getSerializableData()
if ($v instanceof SpecObjectInterface) {
$data[$k] = $v->getSerializableData();
} elseif (is_array($v)) {
// test if php arrays should be represented as object in YAML/JSON
$toObject = false;
$j = 0;
foreach ($v as $i => $d) {
if ($j++ !== $i) {
$toObject = true;
}
if ($d instanceof SpecObjectInterface) {
$data[$k][$i] = $d->getSerializableData();
if (!empty($v)) {
// case 1: non-empty array should be an object if it does not contain
// consecutive numeric keys
$j = 0;
foreach ($v as $i => $d) {
if ($j++ !== $i) {
$toObject = true;
}
if ($d instanceof SpecObjectInterface) {
$data[$k][$i] = $d->getSerializableData();
}
}
} elseif (isset($this->attributes()[$k]) && is_array($this->attributes()[$k]) && 2 === count($this->attributes()[$k])) {
// case 2: Attribute type is an object (specified in attributes() by an array which specifies two items (key and value type)
$toObject = true;
}
if ($toObject) {
$data[$k] = (object) $data[$k];
Expand Down
22 changes: 22 additions & 0 deletions tests/spec/data/empty-maps.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"openapi": "3.0.1",
"info": {
"title": "test",
"version": "1.0"
},
"paths": {
"/products": {
"description": "default",
"get": {
"responses": {
"200": {
"description": "Products",
"headers": {},
"content": {},
"links": {}
}
}
}
}
}
}