https://github.com/cbetta/json-schema-sensitivity-checker

Check the sensitivity of your JSON Schema (including OpenAPI!) documents
https://github.com/cbetta/json-schema-sensitivity-checker

alexjs checker json openapi3

Last synced: about 1 month ago
JSON representation

Check the sensitivity of your JSON Schema (including OpenAPI!) documents

• Host: GitHub
• URL: https://github.com/cbetta/json-schema-sensitivity-checker
• Owner: cbetta
• Created: 2019-12-13T14:41:20.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-17T13:21:06.000Z (about 1 year ago)
• Last Synced: 2024-08-03T23:03:33.767Z (4 months ago)
• Topics: alexjs, checker, json, openapi3
• Language: JavaScript
• Homepage:
• Size: 1.71 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-docs - json-schema-sensitivity-checker

README

        
# json-schema-sensitivity-checker

[![npm

version](https://badge.fury.io/js/json-schema-sensitivity-checker.svg)](https://badge.fury.io/js/json-schema-sensitivity-checker)

![ci status](https://github.com/cbetta/json-schema-sensitivity-checker/workflows/Node%20CI/badge.svg)

This CLI allows you to provide a JSONPath expression and run

[`alex`](https://alexjs.com) against any matching lines.

> This tool is currently in alpha and has primarily been tested against OpenAPI

> files. PRs are welcome!

This project is very much inspired by and based on the work done on the

[`json-schema-spell-checker`](https://github.com/mheap/json-schema-spell-checker)

by Michael Heap.

## Installation

```bash

npm install -g json-schema-sensitivity-checker

```

## Usage

Check against specific field names at any depth:

```bash

json-schema-sensitivity-checker -f 'description,title' path/to/openapi.json

```

Alternatively, you can specify a JSONPath expression yourself.

```bash

json-schema-sensitivity-checker -j '$..["description","title"]' path/to/openapi.json

```

## Options

```bash

Usage: bin [options] source-file

Options:

  -V, --version           output the version number

  -t, --text              treat input as plain-text (not markdown)

  -l, --html              treat input as html (not markdown)

  -d, --diff              ignore unchanged lines (affects Travis only)

  -j, --json-path [path]  specify a jsonpath expression to match

  -c, --config [path]     specify a JSON formatted Alex config to pass to every match

  -f, --fields [fields]   specify a comma separated l

```