Move API specification into correct position
The goal is to maintain a specification heirarchy under doc/spec. This change sets the example. The Makefile has also been changed update the AUTHORS file and can now generate the specification. Signed-off-by: Stephen J Day <stephen.day@docker.com>
This commit is contained in:
parent
10a194c775
commit
b429176dd7
5 changed files with 23 additions and 16 deletions
|
@ -4,7 +4,7 @@
|
|||
// For example, to generate a new API specification, one would execute the
|
||||
// following command from the repo root:
|
||||
//
|
||||
// $ registry-api-descriptor-template doc/SPEC.md.tmpl > doc/SPEC.md
|
||||
// $ registry-api-descriptor-template doc/spec/api.md.tmpl > doc/spec/api.md
|
||||
//
|
||||
// The templates are passed in the api/v2.APIDescriptor object. Please see the
|
||||
// package documentation for fields available on that object. The template
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue