This commit is contained in:
Tutur33
2023-11-24 22:35:41 +01:00
parent 3c0b507a93
commit 7644b2a0f7
45165 changed files with 4803356 additions and 3 deletions
+26
View File
@@ -0,0 +1,26 @@
# openapi-schema-validator Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## 3.0.3 - 2019-01-31
### Fixed
- openapi-types: OpenAPIV3: relax security requirement object types (#327)
## 3.0.2 - 2018-10-03
### Fixed
- Updating .npmignore to publish `dist`
## 3.0.1 - 2018-10-03
### Fixed
- Casing in README examples.
## 3.0.0 - 2018-10-01
### Added
- `export interface IOpenAPISchemaValidator`
- `export interface OpenAPISchemaValidatorArgs`
- `export interface OpenAPISchemaValidatorResult`
### Changed
- `module.exports` to `export default`
+21
View File
@@ -0,0 +1,21 @@
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.
+92
View File
@@ -0,0 +1,92 @@
# openapi-schema-validator [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
> A validator for OpenAPI documents.
## Supported OpenAPI versions
* `v3`
* `v2` (formerly known as Swagger V2
## Document examples and full specs:
* [Official 2.0 docs](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#itemsObject)
* [Official 3.0.0 docs](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md)
## Highlights
* Validate openapi documents against openapi schema documents.
* Uses [jsonschema](https://github.com/tdegrunt/jsonschema) under the hood.
* Performant.
* Currently supports type definitions included in the `definitions` property of the
provided openapi document.
* Extensively tested.
* Small footprint.
**Huge thank you to the [gnostic](https://github.com/googleapis/gnostic) project for building up a 3.0.0 JSON schema.**
## Example
```javascript
var OpenAPISchemaValidator = require('openapi-schema-validator');
var validator = new OpenAPISchemaValidator({
//optional
version: 2,
// optional
version2Extensions: {
/* place any properties here to extend the schema. */
},
// optional
version3Extensions: {
/* place any properties here to extend the schema. */
}
});
console.log(validator.validate(apiDoc));
```
* `version` _optional number_ openapi document schema version to use (2 or 3).
* 2 - `openapi-2.0.0` (default)
* 3 - `openapi-3.0.0`
[see here](https://github.com/tdegrunt/jsonschema#results) for example results.
## API
### .validate(apiDoc)
* `apiDoc` _object_ is any api document you wish to validate.
## 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.
``````
[downloads-image]: http://img.shields.io/npm/dm/openapi-schema-validator.svg
[npm-url]: https://npmjs.org/package/openapi-schema-validator
[npm-image]: http://img.shields.io/npm/v/openapi-schema-validator.svg
[travis-url]: https://travis-ci.org/kogosoftwarellc/open-api
[travis-image]: https://api.travis-ci.org/kogosoftwarellc/open-api.svg?branch=master
[coveralls-url]: https://coveralls.io/r/kogosoftwarellc/open-api
[coveralls-image]: https://coveralls.io/repos/github/kogosoftwarellc/open-api/badge.svg?branch=master
[gitter-url]: https://gitter.im/kogosoftwarellc/open-api
[gitter-image]: https://badges.gitter.im/kogosoftwarellc/open-api.png
+21
View File
@@ -0,0 +1,21 @@
import * as Ajv from 'ajv';
import { IJsonSchema, OpenAPI } from 'openapi-types';
export interface IOpenAPISchemaValidator {
/**
* Validate the provided OpenAPI doc against this validator's schema version and
* return the results.
*/
validate(doc: OpenAPI.Document): OpenAPISchemaValidatorResult;
}
export interface OpenAPISchemaValidatorArgs {
version: number | string;
extensions?: IJsonSchema;
}
export interface OpenAPISchemaValidatorResult {
errors: Ajv.ErrorObject[];
}
export default class OpenAPISchemaValidator implements IOpenAPISchemaValidator {
private validator;
constructor(args: OpenAPISchemaValidatorArgs);
validate(openapiDoc: OpenAPI.Document): OpenAPISchemaValidatorResult;
}
+27
View File
@@ -0,0 +1,27 @@
"use strict";
exports.__esModule = true;
var Ajv = require("ajv");
var openapi2Schema = require('swagger-schema-official/schema.json');
var openapi3Schema = require('./resources/openapi-3.0.json');
var merge = require('lodash.merge');
var OpenAPISchemaValidator = /** @class */ (function () {
function OpenAPISchemaValidator(args) {
var v = new Ajv({ schemaId: 'auto', allErrors: true });
v.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json'));
var version = (args && parseInt(String(args.version), 10)) || 2;
var schema = merge({}, version === 2 ? openapi2Schema : openapi3Schema, args ? args.extensions : {});
v.addSchema(schema);
this.validator = v.compile(schema);
}
OpenAPISchemaValidator.prototype.validate = function (openapiDoc) {
if (!this.validator(openapiDoc)) {
return { errors: this.validator.errors };
}
else {
return { errors: [] };
}
};
return OpenAPISchemaValidator;
}());
exports["default"] = OpenAPISchemaValidator;
//# sourceMappingURL=index.js.map
+1
View File
@@ -0,0 +1 @@
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;AAAA,yBAA2B;AAC3B,IAAM,cAAc,GAAG,OAAO,CAAC,qCAAqC,CAAC,CAAC;AACtE,IAAM,cAAc,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;AAC/D,IAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAoBtC;IAEE,gCAAY,IAAgC;QAC1C,IAAM,CAAC,GAAG,IAAI,GAAG,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,wCAAwC,CAAC,CAAC,CAAC;QACnE,IAAM,OAAO,GAAG,CAAC,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAClE,IAAM,MAAM,GAAG,KAAK,CAClB,EAAE,EACF,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,EAC/C,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAC5B,CAAC;QACF,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAEM,yCAAQ,GAAf,UAAgB,UAA4B;QAC1C,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE;YAC/B,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;SAC1C;aAAM;YACL,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;SACvB;IACH,CAAC;IACH,6BAAC;AAAD,CAAC,AAtBD,IAsBC"}
File diff suppressed because it is too large Load Diff
+35
View File
@@ -0,0 +1,35 @@
{
"name": "openapi-schema-validator",
"version": "3.0.3",
"description": "A validator for OpenAPI documents.",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"files": [
"dist/**/*"
],
"scripts": {
"cover": "nyc",
"prepare": "tsc",
"test-watch": "mocha --watch-extensions ts -w",
"test": "mocha",
"travis-test": "npm run cover"
},
"repository": "https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-schema-validator",
"keywords": [
"openapi",
"schema",
"validator"
],
"author": "Joseph Spencer",
"license": "MIT",
"bugs": {
"url": "https://github.com/kogosoftwarellc/open-api/issues"
},
"homepage": "https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-schema-validator#readme",
"dependencies": {
"ajv": "^6.5.2",
"lodash.merge": "^4.6.1",
"openapi-types": "1.3.4",
"swagger-schema-official": "2.0.0-bab6bed"
}
}