# raml-definition-system

> [![Build Status](https://travis-ci.org/raml-org/raml-definition-system.svg?branch=master)](https://travis-ci.org/raml-org/raml-definition-system) [![Greenkeeper badge](https://badges.greenkeeper.io/raml-org/raml-definition-system.svg)](https://greenkeeper

Latest version **0.0.94** (published 2020-04-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install raml-definition-system
pnpm add raml-definition-system
yarn add raml-definition-system
bun add raml-definition-system
```

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.94 |
| Published | 2020-04-07 |
| First published | 2016-03-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | denis.denisenko, petrochenko-pavel-a |
| Keywords | raml, definition, typesystem, specification |

## Links

- npm: https://www.npmjs.com/package/raml-definition-system
- Repository: https://github.com/raml-org/raml-definition-system
- Issues: https://github.com/raml-org/raml-definition-system/issues
- npm.io page: https://npm.io/package/raml-definition-system

## Dependencies (4)

- [underscore](https://npm.io/package/underscore.md) ^1.9.2
- [raml-typesystem](https://npm.io/package/raml-typesystem.md) ^0.0.96
- [ts-structure-model](https://npm.io/package/ts-structure-model.md) 0.0.1
- [know-your-http-well](https://npm.io/package/know-your-http-well.md) 0.5.0

## Recent versions

- 0.0.94 (latest) — 2020-04-07
- 0.0.22-rc2 (beta) — 2016-05-06
- 0.0.93 — 2020-03-10
- 0.0.92 — 2020-03-10
- 0.0.91 — 2019-10-24
- 0.0.90 — 2019-07-25
- 0.0.89 — 2019-07-03
- 0.0.88 — 2019-03-28
- 0.0.87 — 2018-11-23
- 0.0.86 — 2018-11-23
- 0.0.85 — 2018-09-25
- 0.0.84 — 2018-08-28
- 0.0.83 — 2018-08-21
- 0.0.82 — 2018-07-12
- 0.0.81 — 2018-05-17
- … 79 more at https://npm.io/package/raml-definition-system/versions

## README

# RAML Definition System

[![Build Status](https://travis-ci.org/raml-org/raml-definition-system.svg?branch=master)](https://travis-ci.org/raml-org/raml-definition-system) [![Greenkeeper badge](https://badges.greenkeeper.io/raml-org/raml-definition-system.svg)](https://greenkeeper.io/)

> This repository contains a set of interfaces that represents a declarative description of the RAML specification.

**IMPORTANT: This is still in development and should be considered alpha.**

## Installation

### From NPM

```
npm install raml-definition-system --save
```

### From Sources

```
npm install
```

## Generate

Make sure you executed all necessary installation steps before you try to generate anything. See section [From Sources](#from-sources) for more information.

The result files can be found inside the `dist/` repository ending with `.json`.

### Build Sources

 ```
 npm run build
 ```

### JSON Structure for the Definition System

One can either use the provided interfaces in TypeScript or a JSON representation of the definition system that can be generated by running either the [complete build](#build sources) or `npm run generateJSON`.

## Contribute

The `raml-definition-system` is an open source project and any contribution is always welcome. **Please bear in mind that the definition system is a full reflection of the RAML specification and must not contain anything that is not mentioned inside the specification. Therefore, contribution to the actual interfaces should be limited to bug fixes only.**

1. Check for open issues or open a fresh issue to start a discussion around an idea or a bug.
2. Fork the repository on Github and make your changes on the **develop** branch (or branch off of it).
4. Send a pull request (with the develop branch as the target).

A big thank you goes out to everyone who helped with the project, the [contributors](https://github.com/raml-org/raml-definition-system/graphs/contributors) and everyone who took the time to report issues and give feedback.

You can also directly get in touch with us. Simply send us an email to: info@raml.org

## RAML version support

Currently, the definition system provides interfaces for RAML 0.8 and 1.0 RC1 version.

## License

Apache License 2.0

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