Skip to content
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

Jump to bottom

fix: treat response schemas with an items field as arrays #99

Merged
merged 1 commit into from
Aug 27, 2019
Merged

fix: treat response schemas with an items field as arrays #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 10 additions & 2 deletions src/plugins/validation/2and3/semantic-validators/operations-shared.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ module.exports.validate = function({ resolvedSpec, isOAS3 }, config) {
each(op.responses, (response, name) => {
if (isOAS3) {
each(response.content, (content, contentType) => {
if (content.schema && content.schema.type === 'array') {
const isArray =
content.schema &&
(content.schema.type === 'array' || content.schema.items);

if (isArray) {
result[checkStatusArrRes].push({
path: `paths.${pathKey}.${opKey}.responses.${name}.content.${contentType}.schema`,
message:
Expand All @@ -81,7 +85,11 @@ module.exports.validate = function({ resolvedSpec, isOAS3 }, config) {
}
});
} else {
if (response.schema && response.schema.type === 'array') {
const isArray =
response.schema &&
(response.schema.type === 'array' || response.schema.items);

if (isArray) {
result[checkStatusArrRes].push({
path: `paths.${pathKey}.${opKey}.responses.${name}.schema`,
message:
Expand Down
85 changes: 85 additions & 0 deletions test/plugins/validation/2and3/operations-shared.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,40 @@ describe('validation plugin - semantic - operations-shared', function() {
expect(res.warnings.length).toEqual(0);
});

it('should complain about an anonymous array response model with no type but an `items` field', function() {
const spec = {
paths: {
'/stuff': {
get: {
summary: 'list stuff',
operationId: 'list_stuff',
produces: ['application/json'],
responses: {
200: {
description: 'successful operation',
schema: {
items: {
type: 'string'
}
}
}
}
}
}
}
};

const res = validate({ resolvedSpec: spec }, config);
expect(res.errors.length).toEqual(1);
expect(res.errors[0].path).toEqual(
'paths./stuff.get.responses.200.schema'
);
expect(res.errors[0].message).toEqual(
'Arrays MUST NOT be returned as the top-level structure in a response body.'
);
expect(res.warnings.length).toEqual(0);
});

it('should not complain about an empty summary within a vendor extension', function() {
const spec = {
paths: {
Expand Down Expand Up @@ -726,6 +760,57 @@ describe('validation plugin - semantic - operations-shared', function() {
expect(res.warnings.length).toEqual(0);
});

it('should complain about a top-level array response without a type but with an `items` field', function() {
const spec = {
paths: {
'/': {
put: {
operationId: 'get_everything',
summary: 'get everything as a string or an array',
requestBody: {
description: 'simple body',
content: {
'application/json': {
schema: {
type: 'string'
}
}
}
},
responses: {
'200': {
content: {
'text/plain': {
schema: {
type: 'string'
}
},
'application/json': {
schema: {
items: {
type: 'string'
}
}
}
}
}
}
}
}
}
};

const res = validate({ resolvedSpec: spec, isOAS3: true }, config);
expect(res.errors.length).toEqual(1);
expect(res.errors[0].path).toEqual(
'paths./.put.responses.200.content.application/json.schema'
);
expect(res.errors[0].message).toEqual(
'Arrays MUST NOT be returned as the top-level structure in a response body.'
);
expect(res.warnings.length).toEqual(0);
});

it('should complain about an unused tag', function() {
const spec = {
tags: [
Expand Down