Enhance lifecycle.md with abstract and version info - #3
Conversation
Add abstract and versioning details to lifecycle spec. A refactor to a format more compatible with other the other specs.
handrews
left a comment
handrews
left a comment
There was a problem hiding this comment.
I haven't thought about all of this in detail, but noted some oddities with starting this up from the template (which... I have no idea where that template came from TBH).
| # Lifecycle Specification | ||
|
|
||
| ## Version History | ||
| ## Abstract |
There was a problem hiding this comment.
The abstract gets added by the build system, and its text is in spec.config.json. I have no idea why, but I assume this is a ReSpec thing.
| ## Definitions | ||
|
|
||
| ### Lifecycle Object | ||
| ### Lifecycle | ||
|
|
||
| A **Lifecycle Object** is ... | ||
|
|
||
| #### Fixed Fields | ||
|
|
||
| | Field Name | Type | Description | | ||
| | ---- | ---- | ---- | | ||
| | TODO | TODO | TODO | | ||
| TODO: A short, informal description of what a Lifecycle is conceptually — | ||
| not the field-by-field schema. The Fixed Fields for the Lifecycle Object | ||
| live under [Schema](#schema) below. | ||
|
|
||
| ### Schema Object | ||
|
|
There was a problem hiding this comment.
We don't have this section in the OAS (or at least not anymore), so I went looking at Arazzo. I think based on how Arazzo uses it, defining "Lifecycle" in general terms here makes sense, but not "Schema Object".
| ### Versions | ||
|
|
||
| This document is the Lifecycle Specification version 1.0.0. | ||
| The Lifecycle Specification is versioned using a `major`.`minor`.`patch` | ||
| scheme. The `major`.`minor` portion of the version string (for example, | ||
| `1.0`) designates the Lifecycle feature set in effect. `patch` releases | ||
| address errors in, or provide clarifications to, this document without | ||
| changing the feature set; tooling SHOULD treat all patch releases within a | ||
| `major`.`minor` line as equivalent. |
There was a problem hiding this comment.
Given the ongoing debate about the patch number, let's do the version stuff in its own PR so that people can debate that separately.
| [Relationship to the OpenAPI Specification](#relationship-to-the-openapi-specification) | ||
| above). | ||
|
|
||
| ### Schema |
There was a problem hiding this comment.
We've changed this to Specification in the other documents.
2 participants
Add abstract and versioning details to lifecycle spec. A refactor to a format more compatible with other the other specs.