registry-api-descriptor-template

Documentation

Overview

registry-api-descriptor-template uses the APIDescriptor defined in the api/v2 package to execute templates passed to the command line.

For example, to generate a new API specification, one would execute the following command from the repo root:

$ registry-api-descriptor-template docs/spec/api.md.tmpl > docs/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 syntax is from Go's standard library text/template package. For information on Go's template syntax, please see golang.org/pkg/text/template.