OpenAPI And Reference Documentation

About

This repository contains example APIs (OAS v3) and related (reference) documentation written in Markdown.

Features

• Spectral for OAS linting and validation

Repository Breakdown

├── CHANGELOG.md
├── LICENSE
├── README.md
├── docs
│   ├── README.md
│   ├── assets
│   │   └── ocular-d-logo.png
│   ├── lefthook.md
│   └── spectral.md
├── lefthook.yml
├── package.json
├── spec
│   ├── demo
│   │   ├── docs
│   │   └── openapi.yaml
│   └── petstore
│       ├── docs
│       └── openapi.yaml
├── yarn-error.log
└── yarn.lock

CHANGELOG.md: The Changelog of this repository

LICENSE: The License of this repository

README.md: The README of this repository

docs: The directory containing all the docs about this repository

spec: The directory with the example APIs