search

projectatomic / nulecule

[UNMAINTAINED] Specification describing a container-based application
209 stars 47 forks source link

Maintain single spec file #32

Open aweiteka opened 9 years ago

aweiteka commented 9 years ago

Currently we have both a human-readable README and a machine-readable JSON file to describe the specification. With some extension we could put all of the additional data from the README into the JSON and create a parser script to render it.

aweiteka commented 9 years ago

Approach: add --format option to compose.py https://github.com/projectatomic/nulecule/blob/master/spec/0.0.1-alpha/compose/compose.py

$ python compose.py schema.json --output README.asciidoc --format asciidoc

For completeness we also need to add some arbitrary text to the schema file such as Introduction and Data types.

vpavlin commented 9 years ago

We will probably need either extend description in schema or introduce new keys like doc_text...any thoughts about preferred approach?

aweiteka commented 9 years ago

Good idea. I think doc_text is best alongside some top-level data for Intro text, etc.

aweiteka commented 9 years ago

Consider https://github.com/swagger-api/swagger-spec