-
Notifications
You must be signed in to change notification settings - Fork 3
Conventions and Guidelines
garyhodgson edited this page Jan 22, 2013
·
3 revisions
The following is a list of conventions and guidelines to consider when putting together the specification and related documents. They are only meant as a suggestion at this time - opinions welcome.
- Datetime values should be in UTC and follow the format defined by the W3C: http://www.w3.org/TR/NOTE-datetime, e.g.
1994-11-05T13:15:30Z. - It may be useful to know the originating timezone, and so the following format should also be supported:
1994-11-05T08:15:30-05:00
- For consistency and clarity , the name of attributes should be given in lowercase, with words separated by a hyphen, e.g.
x-identity-metadata. This should also be followed for terms which would normally be written in uppercase, e.g. acronyms. - Attributes of type Array should be plural.
- Where sensible the specification should allow extension of sections through a map of key-value pairs. The convention for such attributes being
x-section-metadata, where section describes the pertinent part.