Skip to content

Adding metadata docs #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GavinMendelGleason merged 1 commit into from
Jan 4, 2023
Merged

Adding metadata docs #201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions guides/reference-guides/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,18 @@ A long-form `@description` of the purpose of the schema, the type of documents c

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

#### @metadata

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:

```json
{ "@type" : "@context",
"@base" : "http://my_stuff/",
"@schema" : "http://my_schema#",
"@metadata" : { "configuration" : { "frob" : 29 } }
}
```

## Class keywords

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