Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 998 Bytes

README.md

File metadata and controls

39 lines (25 loc) · 998 Bytes

OpenAPI v3 schemas

CircleCI

This repo contains useful and reusable schemas to implement REST APIs distributed via github pages.

Getting the specs

Latest master is available at:

Tagged specs are here:

Specs are assebled from the following directories:

docs/
├── headers             # HTTP Headers
├── parameters          # HTTP query parameters
├── responses           # Responses
└── schemas             # Various schema files
    ├── money.yaml
    ├── ...
    └── problem.yaml

Building the specs

Every commit is tested via the tox python framework.

master and tags trigger make ghpages which:

  • generates definitions.yaml
  • push it to gh-pages branch, under $tag/definitions.yaml