npmpackage.info

Gathering detailed insights and metrics for @leoscope/openapi-response-validator

@leoscope/openapi-response-validator - 1.0.2 | npmpackage.info

@leoscope/openapi-response-validator

A Monorepo of various packages to power OpenAPI in node

1.0.2

918

MIT

JavaScript

52.62 kB

Installations

npm install @leoscope/openapi-response-validator

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

17.2.0

NPM Version

8.1.4 Pull Requests

Open

26

Total

600

Closed

105

Merged

469

Issues

Open

114

Total

316

Closed

202

Releases

Version 0.9.1

v0.9.1

Updated on Feb 06, 2016

Version 0.9.0

v0.9.0

Updated on Feb 05, 2016

Version 0.8.0

v0.8.0

Updated on Feb 05, 2016

Version 0.7.1

v0.7.1

Updated on Feb 05, 2016

Version 0.7.0

v0.7.0

Updated on Feb 05, 2016

Version 0.6.3

v0.6.3

Updated on Feb 05, 2016

View All 8 releases

Languages

JavaScript

TypeScript

Shell

JavaScript (64.43%)

TypeScript (35.38%)

Shell (0.19%)

Developer

kogosoftwarellc

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

918 Stars

1,374 Commits

239 Forks

13 Watchers

228 Branches

114 Contributors

Updated on Jul 10, 2025

Maintainers

View All 114 Contributors

Package Meta Information

Latest Version

1.0.2

Package Id

@leoscope/openapi-response-validator@1.0.2

Unpacked Size

52.62 kB

Size

16.17 kB

File Count

NPM Version

8.1.4

Node Version

17.2.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

ajv openapi-types

openapi-response-validator

Validate a response according to an openapi schema.

Highlights

Performant.
Extensively tested.
Small footprint.
Leverages jsonschema.
Supports $ref in response schemas i.e. #/definitions/SomeType.

Example

See ./test/data-driven/*.js for more examples.

1var OpenAPIResponseValidator = require('openapi-response-validator');
2var responseValidator = new OpenAPIResponseValidator({
3  responses: {
4    200: {
5      description: 'We found what you were looking for.',
6      schema: {
7        $ref: '#/definitions/ResourceResponse'
8      }
9    },
10    default: {
11      description: 'Something happened...',
12      schema: {
13        $ref: '#/definitions/SomeErrorResponse'
14      }
15    }
16  },
17  definitions: {
18    ResourceResponse: {
19      type: 'object',
20      properties: {
21        id: {
22          type: 'integer'
23        },
24        name: {
25          type: 'string'
26        }
27      },
28      required: ['id', 'name']
29    },
30    SomeErrorResponse: {
31      type: 'object',
32      properties: {
33        errorCode: {
34          type: 'string'
35        },
36        message: {
37          type: 'string'
38        }
39      }
40    }
41  }
42});
43
44var someResource = {};
45var validationError = responseValidator.validateResponse(200, someResource);
46
47/*
48  Validation errors look like this (except for objects in the errors array which
49  may be overridden with errorTransformer):
50  {
51    status: 500,
52    message: 'The response was not valid.',
53    errors: [
54      {
55        path: 'foo',
56        errorCode: 'type.openapi.responseValidation',
57        message: is not of a type(s) string'
58      }
59    ]
60  }
61*/

API

OpenapiResponseValidator(args)

args

Type	Required	Default Value	Description
Object	Y	N/A	Arguments to configure the middleware.

args.loggingKey

Type	Required	Default Value	Description
String	N	''	A prefix to use with constructor errors and logging messages.

Keys may be any HTTP status code or default (for all HTTP status codes). See http://swagger.io/specification/#responsesObject.

args.responses

Type	Required	Default Value	Description
Object	Y	N/A	A key value pair of response definitions. At least one response definition is to be provided.

Keys may be any HTTP status code or default (for all HTTP status codes). See http://swagger.io/specification/#responsesObject.

args.definitions

Type	Required	Default Value	Description
Object	N	N/A	A key value pair of type definitions

This object is used to support $ref in your responses

args.errorTransformer

Type	Required	Default Value	Description
Function	N	toOpenapiValidationError (see the source)	A function that receives an error and returns a mapped version of the error.

This function is passed 2 arguments.

  errorTransformer: function(openapiError, ajvError) {
    return {
      message: openapiError.message
    };
  }

See the error format in ajv for ajvError. openapiErrors have the following properties:

errorCode - A jsonschema error suffixed with .openapi.responseValidation. failed.
message - A detailed message as to why validation failed.
path - The property of the response body that failed validation.

args.customFormats

Type	Required	Default Value	Description
Object	N	null	An object of custom formats.

Each key is the name of the format to be used with the format keyword. Each value is a function that accepts an input and returns a boolean value.

See Custom Formats in jsonschema.

LICENSE

The MIT License (MIT)

Copyright (c) 2018 Kogo Software LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

51 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-wm7h-9275-46v2
Warn: Project is vulnerable to: GHSA-44fp-w29j-9vj5
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-593f-38f6-jp5m
Warn: Project is vulnerable to: GHSA-x2rg-q646-7m2v

Score

3

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More