(data): Auto build _data

Author: ChaiJs Bot

_data/plugins/chai_openapi_response_validator.json

@@ -1162,7 +1162,7 @@
         "content_type": "text/javascript",
         "state": "uploaded",
         "size": 117322,
-        "download_count": 7646,
+        "download_count": 7648,
         "created_at": "2014-01-30T00:03:47Z",
         "updated_at": "2014-01-30T00:03:53Z",
         "browser_download_url": "https://github.com/chaijs/chai/releases/download/1.9.0/chai.js"

_data/releases.json

@@ -12,18 +12,21 @@ pluginName: chai-openapi-response-validator
 ![dependencies](https://img.shields.io/david/RuntimeTools/OpenAPIValidators)
 ![style](https://img.shields.io/badge/code%20style-airbnb-ff5a5f.svg)
 [![codecov](https://codecov.io/gh/RuntimeTools/OpenAPIValidators/branch/master/graph/badge.svg)](https://codecov.io/gh/RuntimeTools/OpenAPIValidators)
+[![included](https://badgen.net/npm/types/jest-openapi)](https://github.com/RuntimeTools/OpenAPIValidators/blob/master/packages/chai-openapi-response-validator/index.d.ts)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/RuntimeTools/OpenAPIValidators/blob/master/CONTRIBUTING.md)
 
 Simple Chai support for asserting that HTTP responses satisfy an OpenAPI spec.
 
-## Problem
+## Problem 😕
 
 If your server's behaviour doesn't match your API documentation, then you need to correct your server, your documentation, or both. The sooner you know the better.
 
-## Solution
+## Solution 😄
 
 This plugin lets you automatically test whether your server's behaviour and documentation match. It extends the [Chai Assertion Library](https://www.chaijs.com/) to support the [OpenAPI standard](https://swagger.io/docs/specification/about/) for documenting REST APIs. In your JavaScript tests, you can simply assert [`expect(responseObject).to.satisfyApiSpec`](#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
 
 Features:
+
 - Validates the status and body of HTTP responses against your OpenAPI spec [(see example)](#in-api-tests-validate-the-status-and-body-of-http-responses-against-your-openapi-spec)
 - Validates objects against schemas defined in your OpenAPI spec [(see example)](#in-unit-tests-validate-objects-against-schemas-defined-in-your-OpenAPI-spec)
 - Load your OpenAPI spec just once in your tests (load from a filepath or object)
@@ -35,21 +38,24 @@ Features:
 - Bundled with a TypeScript Declaration File for [use in TypeScript projects](#using-this-plugin-in-a-typescript-project)
 - Use in [Mocha](#usage), [Jest](https://github.com/RuntimeTools/OpenAPIValidators/tree/master/packages/jest-openapi#readme) and other test runners
 
-## Contributing
+## Contributing ✨
 
 If you've come here to help contribute - thanks! Take a look at the [contributing](https://github.com/RuntimeTools/OpenAPIValidators/blob/master/CONTRIBUTING.md) docs to get started.
 
 ## Installation
+
 This is an addon plugin for the [Chai Assertion Library](http://chaijs.com). Install via [npm](http://npmjs.org).
+
 ```bash
-$ npm install --save-dev chai-openapi-response-validator
+npm install --save-dev chai-openapi-response-validator
 ```
 
 ## Usage
 
 ### In API tests, validate the status and body of HTTP responses against your OpenAPI spec:
 
 #### 1. Write a test:
+
 ```javascript
 // Set up Chai
 const chai = require('chai');
@@ -62,9 +68,8 @@ const chaiResponseValidator = require('chai-openapi-response-validator');
 chai.use(chaiResponseValidator('path/to/openapi.yml'));
 
 // Write your test (e.g. using Mocha)
-describe('GET /example/endpoint', function() {
-  it('should satisfy OpenAPI spec', async function() {
-
+describe('GET /example/endpoint', () => {
+  it('should satisfy OpenAPI spec', async () => {
     // Get an HTTP response from your server (e.g. using axios)
     const res = await axios.get('http://localhost:3000/example/endpoint');
 
@@ -77,6 +82,7 @@ describe('GET /example/endpoint', function() {
 ```
 
 #### 2. Write an OpenAPI Spec (and save to `path/to/openapi.yml`):
+
 ```yaml
 openapi: 3.0.0
 info:
@@ -131,6 +137,7 @@ paths:
 ```
 
 ###### Output from test failure:
+
 ```javascript
 AssertionError: expected res to satisfy API spec
 
@@ -162,6 +169,7 @@ The '200' response defined for endpoint 'GET /example/endpoint' in API spec: {
 ### In unit tests, validate objects against schemas defined in your OpenAPI spec:
 
 #### 1. Write a test:
+
 ```javascript
 // Set up Chai
 const chai = require('chai');
@@ -174,8 +182,8 @@ const chaiResponseValidator = require('chai-openapi-response-validator');
 chai.use(chaiResponseValidator('path/to/openapi.yml'));
 
 // Write your test (e.g. using Mocha)
-describe('myModule.getObject()', function() {
-  it('should satisfy OpenAPI spec', async function() {
+describe('myModule.getObject()', () => {
+  it('should satisfy OpenAPI spec', async () => {
     // Run the function you want to test
     const myModule = require('path/to/your/module.js');
     const output = myModule.getObject();
@@ -187,6 +195,7 @@ describe('myModule.getObject()', function() {
 ```
 
 #### 2. Write an OpenAPI Spec (and save to `path/to/openapi.yml`):
+
 ```yaml
 openapi: 3.0.0
 info:
@@ -227,7 +236,6 @@ components:
 };
 ```
 
-
 ##### The assertion fails if the object does not satisfy the schema `ExampleSchemaObject`:
 
 ```javascript
@@ -272,7 +280,9 @@ The 'ExampleSchemaObject' schema in API spec: {
 ### Loading your OpenAPI spec (3 different ways):
 
 #### 1. From an absolute filepath ([see above](#usage))
+
 #### 2. From an object:
+
 ```javascript
 // Set up Chai
 const chai = require('chai');
@@ -292,7 +302,7 @@ const openApiSpec = {
     '/example/endpoint': {
       get: {
         responses: {
-          '200': {
+          200: {
             description: 'Response body should be a string',
             content: {
               'application/json': {
@@ -312,9 +322,8 @@ const openApiSpec = {
 chai.use(chaiResponseValidator(openApiSpec));
 
 // Write your test (e.g. using Mocha)
-describe('GET /example/endpoint', function() {
-  it('should satisfy OpenAPI spec', async function() {
-
+describe('GET /example/endpoint', () => {
+  it('should satisfy OpenAPI spec', async () => {
     // Get an HTTP response from your server (e.g. using axios)
     const res = await axios.get('http://localhost:3000/example/endpoint');
 
@@ -327,6 +336,7 @@ describe('GET /example/endpoint', function() {
 ```
 
 #### 3. From a web endpoint:
+
 ```javascript
 // Set up Chai
 const chai = require('chai');
@@ -336,18 +346,16 @@ const expect = chai.expect;
 const chaiResponseValidator = require('chai-openapi-response-validator');
 
 // Write your test (e.g. using Mocha)
-describe('GET /example/endpoint', function() {
-
+describe('GET /example/endpoint', () => {
   // Load your OpenAPI spec from a web endpoint
-  before(async function() {
+  before(async () => {
     const axios = require('axios');
     const response = await axios.get('url/to/openapi/spec');
     const openApiSpec = response.data; // e.g. { openapi: '3.0.0', <etc> };
     chai.use(chaiResponseValidator(openApiSpec));
   });
 
-  it('should satisfy OpenAPI spec', async function() {
-
+  it('should satisfy OpenAPI spec', async () => {
     // Get an HTTP response from your server (e.g. using axios)
     const res = await axios.get('http://localhost:3000/example/endpoint');
 
@@ -362,18 +370,23 @@ describe('GET /example/endpoint', function() {
 ### Using this plugin in a TypeScript project
 
 #### Installation
-You don't need to `npm install --save-dev @types/chai-openapi-response-validator` because we bundle our TypeScript Definition file into this package (see `index.d.ts`).
+
+You don't need to `npm install --save-dev @types/chai-openapi-response-validator` because we [bundle our TypeScript Definition file into this package](https://github.com/RuntimeTools/OpenAPIValidators/blob/master/packages/chai-openapi-response-validator/index.d.ts).
 
 #### Importing
+
 1. Make sure your `tsconfig.json` includes:
+
 ```javascript
 {
   "compilerOptions": {
     esModuleInterop: true,
   }
 }
 ```
+
 2. Import like this:
+
 ```javascript
 import chai from 'chai';
 import chaiResponseValidator from 'chai-openapi-response-validator';