Skip to content

Commit 655c012

Browse files
Adding metadata docs (#201)
1 parent 5895993 commit 655c012

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

guides/reference-guides/schema.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,18 @@ A long-form `@description` of the purpose of the schema, the type of documents c
146146

147147
A list of strings of `@authors` involved in writing the schema.
148148

149+
#### @metadata
150+
151+
If you would like to add arbitrary JSON structured metadata to a schema, you can place it in the `@metadata` field of the context object. This can be used to store data product-wide information in a structured format. For instance:
152+
153+
```json
154+
{ "@type" : "@context",
155+
"@base" : "http://my_stuff/",
156+
"@schema" : "http://my_schema#",
157+
"@metadata" : { "configuration" : { "frob" : 29 } }
158+
}
159+
```
160+
149161
## Class keywords
150162

151163
A class definition includes several properties, and the keywords, prefixed `@`, describing class behavior.

0 commit comments

Comments
 (0)