Add model spec format descriptions #39
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Model spec format descriptions (including the native csv format) are added to both the README and the service's index template. Signed-off-by: Aaron Browne <[email protected]>
|
|
||
| ## Persistent CSV Format | ||
|
|
||
| Data model descriptions are stored persistently in this repository in csv format for portability and human readability. Each data model has its own directory with versions of the model in subdirectories. Each version has at least `definitions` and `schema` directories and, optionally, a `constraints` directory and `indexes.csv` and `references.csv` files. |
There was a problem hiding this comment.
Capitalize CSV (in the whole document). I will describe a couple of implementation details:
- The
datamodel.jsonfile is what signals that a data model exists in the current directory a subdirectory - From the service's standpoint, directories don't actually matter. Files are detected based on signature of the CSV header. That being said, it is still good to describe a convention to follow so contributors don't need to make the decisions themselves and each repository becomes familiar.
There was a problem hiding this comment.
Moved below noted description of datamodel.json up to the top, with a note about the non-necessity of directories. Trying to walk that fine line of setting a convention without misleading.
|
This is great. Thank you for taking the time and putting this together. |
Responded to @bruth's comments and added more links so users can "walk through" the CSV storage example as they read. Closes #28 Signed-off-by: Aaron Browne <[email protected]>
|
Updated with a new commit, for easy diff reading, although the auto-diff turned out really ugly. Happy to squash once reviewed. |
|
Great. One of things that is needed is a set of files (a template) with each file type (see #42). That will be linked off from this README once in place. |
bruth
added a commit
that referenced
this pull request
Jun 3, 2015
Add model spec format descriptions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Model spec format descriptions (including the native csv format) are
added to both the README and the service's index template.
Signed-off-by: Aaron Browne [email protected]