Skip to content

Commit

Permalink
many changes
Browse files Browse the repository at this point in the history
Signed-off-by: Matteo Collina <[email protected]>
  • Loading branch information
mcollina committed Nov 13, 2024
1 parent 2d072c5 commit 12292c4
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 511 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/nodejs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ permissions: {}
jobs:
build:

runs-on: ubuntu-latest
runs-on: ${{ matrix.os }}
strategy:
matrix:
node-version: [ 'lts/-1', 'lts/*', 'node']
node-version: [ '20.x', '22.x' ]
os: ['ubuntu-latest', 'windows-latest']
steps:
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
Expand Down
20 changes: 0 additions & 20 deletions .github/workflows/npm-publish.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .github/workflows/update-license-year.sh

This file was deleted.

13 changes: 0 additions & 13 deletions .github/workflows/update-license-year.yml

This file was deleted.

190 changes: 0 additions & 190 deletions CHANGELOG.md

This file was deleted.

46 changes: 3 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,48 +49,6 @@ This module can be used in CommonJS code via:
const { Validator } = await (import("@platformatic/openapi-schema-validator"));
```

See also the [upgrading guide](UPGRADING.md) if you come from a previous major version.

<a name="CLI"></a>

### CLI for API validation

Run with global install:

```bash
npm install @platformatic/openapi-schema-validator -g
validate-api <filename>
```

Run without install:

```bash
npx -p @platformatic/openapi-schema-validator validate-api <filename>
```

Where `<filename>` refers to a YAML or JSON file containing the specification.

### CLI for API bundling

To make it easier to combine multiple YAML or JSON files into a single specification file there is the `bundle-api` command.
(see the [validateBundle](#validateBundle) section below)

```bash
npm install @platformatic/openapi-schema-validator -g
bundle-api <specFiles>
```

Run without install:

```bash
npx -p @platformatic/openapi-schema-validator bundle-api <spec files>
```

The output will be a validated JSON specification.
Options:
-o --output <filename> the filename to save the output to, default is STDOUT.
-t --type [JSON|YAML] the output format, default is JSON.

<a name="API"></a>

## API
Expand Down Expand Up @@ -275,7 +233,9 @@ This static property returns the OpenApi versions supported by this package as a

# Credits

This module was forked at [commit](https://github.com/seriousme/openapi-schema-validator/commit/e4f417ade9e675225381fb872e1b78a9fa392472).
This module was forked from
[https://github.com/seriousme/openapi-schema-validator](https://github.com/seriousme/openapi-schema-validator)
at [commit](https://github.com/seriousme/openapi-schema-validator/commit/e4f417ade9e675225381fb872e1b78a9fa392472).
We thank Hans Klunder for his original work on this module.

# License
Expand Down
32 changes: 0 additions & 32 deletions UPGRADING.md

This file was deleted.

Loading

0 comments on commit 12292c4

Please sign in to comment.