https://github.com/temando/lincoln-schema-spec

Specification for the schema that Lincoln 🎩 understands, and can visualise.
https://github.com/temando/lincoln-schema-spec

Last synced: 8 months ago
JSON representation

Specification for the schema that Lincoln 🎩 understands, and can visualise.

• Host: GitHub
• URL: https://github.com/temando/lincoln-schema-spec
• Owner: temando
• License: mit
• Created: 2017-07-24T06:47:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-07-24T07:26:41.000Z (almost 9 years ago)
• Last Synced: 2024-12-27T18:22:54.474Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 8.79 KB
• Stars: 1
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lincoln UI Schema Specification

[![NPM](https://img.shields.io/npm/v/lincoln-schema-spec.svg)](https://npmjs.org/packages/lincoln-schema-spec/)

[![Travis CI](https://img.shields.io/travis/temando/lincoln-schema-spec.svg)](https://travis-ci.org/temando/lincoln-schema-spec)

[![MIT License](https://img.shields.io/github/license/temando/lincoln-schema-spec.svg)](https://en.wikipedia.org/wiki/MIT_License)

This project contains the specification for the [Lincoln UI](https://github.com/temando/open-api-renderer) schema.

This simplified schema is designed to allow UI projects to simply display data and not require large amounts of logic. It is heavily based on the upcoming [OpenAPI v3 specification](https://github.com/oai/OpenAPI-Specification/tree/OpenAPI.next).

- [lincoln-ui+v1](src/lincoln-ui+v1.schema.json)

> This project is relatively immature and does not fully capture all possibilities of the OpenAPI v3 specification.

## Installation

```sh

npm install @temando/lincoln-schema-spec

```

## Usage

```js

var schema = require('@temando/lincoln-schema-spec');

console.log(schema); // POJO, JSON Schema Draft 6

```