# Product OS : OpenAPI

Product OS : OpenAPI provides a set of structs for defining the structure of an OpenAPI / Swagger specification.  This crate is intended to be used with Product OS : Connector.

### What is Product OS?

Product OS is a collection of packages that provide different tools and features that can work together to build products more easily for the Rust ecosystem.

## Installation

Use the Rust crate package manager [cargo](https://www.rust-lang.org/tools/install) to install Product OS : OpenAPI.

```bash
cargo add product-os-openapi
```

or add Product OS : OpenAPI to your cargo.toml ```[packages]``` section.

```rust
product-os-openapi = { version = "0.0.4", features = [], default-features = true, optional = false }
```

## Features

Product OS OpenAPI provides a collection of Structs to define an OpenAPI / Swagger specification:

- Supports both v2 and v3 specifications
- Supports references 
- Should be used in combination with the Product OS : Connector crate


```rust
// Feature samples TODO
```

## Usage

```rust
// Examples TODO
```

## Contributing

Contributions are not currently available but will be available on a public repository soon.

## License

[GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/)