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.

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

fix content type validation for OAS3 #75

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

mildsunrise
Copy link

the contentTypeValidation option is currently broken for OAS3 schemas, this PR fixes it

the contentTypeValidation option is currently
broken for OAS3 schemas, this PR fixes it
current code throws on relative server URLs, i.e.:

    servers:
      - url: /v2

fix it by providing a dummy base to URL
@kobik
Copy link
Collaborator

kobik commented May 11, 2021

Hi @mildsunrise , thank you very much for your PR!

can you please fix the lint issues that are failing the build?

edit: can you also please add relevant tests?

@@ -37,7 +37,7 @@ function buildValidations(referenced, dereferenced, receivedOptions) {
const schemas = {};

const basePaths = dereferenced.servers && dereferenced.servers.length
? dereferenced.servers.map(({ url }) => new URL(url).pathname)
? dereferenced.servers.map(({ url }) => new URL(url, 'http://foo').pathname)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why 'http://foo'?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there has to be an origin, but any origin works (we just want to extract the pathname)

@@ -123,8 +123,10 @@ function buildRequestValidator(referenced, dereferenced, currentPath, currentMet
}

if (localParameters.length > 0 || options.contentTypeValidation) {
requestSchema.parameters = buildParametersValidation(localParameters,
dereferenced.paths[currentPath][currentMethod].consumes || dereferenced.paths[currentPath].consumes || dereferenced.consumes, options);
const contentTypes = isOpenApi3 ?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i know the code base isn't pretty to say least, but i suggest that will try not to make it even harder to read. what do you say about extracting this to a function?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'd also suggest adding a test for covering both cases when content type exists and missing from the request body

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants