mirror of
https://github.com/arthur-pbty/portfolio2023.git
synced 2026-06-05 13:52:25 +02:00
modified
This commit is contained in:
Tutur33
-26
@@ -1,26 +0,0 @@
|
||||
# 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
@@ -1,21 +0,0 @@
|
||||
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
@@ -1,92 +0,0 @@
|
||||
# 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
|
||||
-35
@@ -1,35 +0,0 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user