# @influxdata/oats

> ``` yarn add -D @influxdata/oats ```

Latest version **0.7.0** (published 2022-09-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @influxdata/oats
pnpm add @influxdata/oats
yarn add @influxdata/oats
bun add @influxdata/oats
```

Provides the command `oats`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.0 |
| Published | 2022-09-15 |
| First published | 2019-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 52.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | mrpowersj, sspaink, myalongmire, reimda, popeydc, wdoconnell, asalem1, blegesse, brandentenbrink, chunyellow, subirjolly, chitlangesahas, influxmark, influxdata-ci, mavarius, reed_de_la_mer, nvcook42, hoorayimhelping, drdelambre, tcl735, rhajek, bednar.b, scbrickley, bnelson_influx, monono, jzbridges, genehynson, zoesteinkamp |

## Links

- npm: https://www.npmjs.com/package/@influxdata/oats
- npm.io page: https://npm.io/package/@influxdata/oats

## Dependencies (4)

- [humps](https://npm.io/package/humps.md) ^2.0.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.14
- [commander](https://npm.io/package/commander.md) ^2.20.0
- [swagger-parser](https://npm.io/package/swagger-parser.md) ^8.0.0

## Recent versions

- 0.7.0 (latest) — 2022-09-15
- 0.5.3 — 2021-06-01
- 0.5.2 — 2019-12-12
- 0.5.1 — 2019-12-12
- 0.5.0 — 2019-10-14
- 0.4.0 — 2019-08-30

## README

An opinionated OpenAPI doc to TypeScript HTTP client generator.

In comparison to [openapi-generator](https://github.com/OpenAPITools/openapi-generator):

- Strives to generate readable output
- Supports enums, `oneOf`, and `allOf`
- Does not require Java runtime
- Generates `fetch`-based HTTP client with typed error responses 
- Does not support significant portions of the OpenAPI spec


## Installation

```
yarn add -D @influxdata/oats
```

## Usage

```
$ yarn run oats --help
```

```
Usage: oats [options] <openApiSpec...>

An opinionated OpenAPI doc to TypeScript HTTP client generator

Options:
  -V, --version                output the version number
  -i, --include <parts>        comma sepated list of code parts to generate (all by default: "types,request,operations")
  -p, --prettier [true/false]  prettier output code (default: true)
  --withDoc [true/false]       document generated types (default: true)
  --patchScript <file>         apply script that modifies openapi document (example: https://github.com/influxdata/influxdb-client-js/blob/master/packages/apis/scripts/patchSwagger.js)
  --storeOperations <file>     store operations to file
  -h, --help                   output usage information
  ```

## Contributing

See [`CONTRIBUTING.md`](./CONTRIBUTING.md).

---
_Source: https://npm.io/package/@influxdata/oats · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._