CRREL / GRiD-API

9 stars 3 forks source link

Initial cut at a Swagger YAML spec #19

Closed chambbj closed 7 years ago

chambbj commented 7 years ago

This PR introduces a Swagger specification (http://swagger.io/) for the GRiD v2 API.

Swagger YAML and JSON files can be ingested by a number of tools (http://swagger.io/tools/ and http://swagger.io/open-source-integrations/), making it easier for API users to navigate and digest the growing API. It also reduces the tedium of maintaining the specification via our previous workflow whereby the specification was documented in Pandoc markdown but converted to reStructuredText for display.

There is one exception. The WFS endpoint continues to be maintained as a reStructuredText file, as it is not expected to change, is not accessed via the typical API means, and is not easily represented in Swagger.