/open-api

Open API specification of Netlify's API
  1. JavaScript 86.7%
  2. Go 8.5%
  3. CSS 4.6%
  4. Other 0.2%
JavaScript Go CSS Other
Find file
Latest commit 959ad8e Dec 10, 2016 @calavera calavera committed on GitHub Merge pull request #13 from netlify/fix_trying_to_upload_zero_files 
Do not try to upload 0 files.
Permalink
Failed to load latest commit information.
go Merge pull request #13 from netlify/fix_trying_to_upload_zero_files Dec 9, 2016
ui Add UI. Jul 16, 2016
.gitignore ignore iml files Nov 24, 2016
LICENSE Add README and LICENSE files. May 2, 2016
Makefile Generate the json spec for the ui when the client is generated. Jul 16, 2016
README.md Add a link to the public UI. Jul 16, 2016
netlify.toml Add UI. Jul 16, 2016
swagger.yml Remove auth scopes. Jul 16, 2016

README.md

Introduction

This repository contains Netlify's API definition in the Open API format, formerly known as Swagger.

It's still a work in progress and we welcome feedback and contributions.

Installation

We use go-swagger to validate our spec against the 2.0 spec of Open API.

To download the toolchain follow the installation instructions in that repository. You'll need to have Go installed.

Spec validation

You can run this command to validate the spec:

make validate

Code generation

Currently, we're generating client code for Go, but we're planning on releasing libraries in any language that can generate code from the spec.

You can use this command to generate the Go client:

make generate

Explore API

Go to https://open-api.netlify.com to explore the spec definitions using Open-Api's UI.

License

MIT. See LICENSE for more details.