|
@@ -14,8 +14,8 @@ It consists of various components in this repository:
|
|
|
|
|
|
|
|
The API is defined by the [Swagger](http://swagger.io/specification/) definition in `api/swagger.yaml`. This definition can be used to:
|
|
The API is defined by the [Swagger](http://swagger.io/specification/) definition in `api/swagger.yaml`. This definition can be used to:
|
|
|
|
|
|
|
|
-1. To automatically generate documentation.
|
|
|
|
|
-2. To automatically generate the Go server and client. (A work-in-progress.)
|
|
|
|
|
|
|
+1. Automatically generate documentation.
|
|
|
|
|
+2. Automatically generate the Go server and client. (A work-in-progress.)
|
|
|
3. Provide a machine readable version of the API for introspecting what it can do, automatically generating clients for other languages, etc.
|
|
3. Provide a machine readable version of the API for introspecting what it can do, automatically generating clients for other languages, etc.
|
|
|
|
|
|
|
|
## Updating the API documentation
|
|
## Updating the API documentation
|
ryancooper7