Skip to content

An effort to improve the OpenAPI for OpenCage Geocoder API.

Notifications You must be signed in to change notification settings

philsturgeon/opencage-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

opencage-openapi

An effort to improve the OpenAPI for OpenCage Geocoder API.

File Structure

The main OpenAPI document is openapi.yaml and everything else is $ref'ed in from there, using the following folder structure.

├── components
│   ├── parameters
│   │   └── *.yaml
│   └── schemas
│   │   └── *.yaml
├── paths
│   ├── geojson.yaml
│   ├── google-v3-json.yaml
│   ├── json.yaml
│   └── xml.yaml
├── openapi.yaml

These split files are easier to work with and reduce repetition, but are harder to distribute. We can "bundle" the documents ot make single files, and those live in export/.

Exporting OpenAPI

Using Redocly CLI you can bundle multiple documents into one, then share that document around easily.

redocly bundle openapi.yaml -o export/opencage-openapi-3.1.0.yaml

About

An effort to improve the OpenAPI for OpenCage Geocoder API.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published