-
-
Notifications
You must be signed in to change notification settings - Fork 28
Specification: topics
Version 1.1. 2014-10-2
The id is used by other files to refer to a specific json file.
Keep it simple, lowercase. Use a "-" for any non-Az-01 character.
For instance: "jurisdiction-law"
This is the title of the topic as the user sees it.
For instance: "Jurisdiction and governing laws"
To complement the title.
For instance: "Where can you sue, or be sued, for breaching of the rules?"
A paragraph to describe the topics more indepth. Don't hesitate to add links to articles about the subejct but keep it short enough.
Can be "topic" or "category". Categories are usually broad topics with many child-topics.
When a topic belongs to a category, use the category's "id" to refer to it.
For instance: "category": "governance" for the "jurisdiction-law" topic.
Meta information
Which version of this spec the file is using. (Useful to maintain API versioning).