<commit_before>swagger-examples-validator
==========================

Validates embedded examples in Swagger-JSONs

[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)

Install
=======

    npm install swagger-examples-validator

Test
====

    npm test

TODO
====<commit_msg>docs(publish): add docs for CLI<commit_after>swagger-examples-validator
==========================

Validates embedded examples in Swagger-specs (only JSON supported, yet)

[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)

Install
-------

Install using [npm](https://docs.npmjs.com/getting-started/what-is-npm):

    npm install -g swagger-examples-validator

Usage
-----

```
swagger-examples-validator [options] <filePath>

Validate embedded examples in Swagger-JSONs

Options:

  -h, --help     output usage information
  -V, --version  output the version number
````

The validator will search the Swagger-JSON for response-examples and
validate them against it's schema.

Test
----

To run the tests, execute

    npm test

or to check the coverage

    npm run coverage

Future features
---------------

- YAML support
{'fraction_non_alphanumeric': 0.1687022900763359, 'fraction_numerical': 0.0030534351145038168, 'mean_word_length': 4.12109375, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2576324', 'n_tokens_mistral': 411, 'n_tokens_neox': 372, 'n_words': 95}