Skip to content
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.

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

style_guide.rst: update describing JSON Schema guidance #291

Merged
merged 3 commits into from
Nov 21, 2024
Merged
Changes from 1 commit
Commits
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: 9 additions & 3 deletions docs/meta/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Data concepts
- "data package", **not** "datapackage"
- "dataset", **not** "data set"
- "metadata", **not** "meta-data" or "meta data"
- "subschema", **not** "sub-schema"

When describing data:

Expand All @@ -68,10 +69,15 @@ When describing data:

When describing JSON Schema:

- "field" to refer to OCDS fields, like ``tender.id``
- "property" to refer to JSON Schema metadata properties, like ``enum``
- "array", **not** "list"
- "object", **not** "block"
- "field" to refer to a literal (number, integer, string, boolean, GeoJSON), like ``tender.id``
- "array", **not** "list" to refer to an array
- "object", **not** "block" to refer to an object

When referring to a **subschema**:

- "object" if the subschema is used in the context of building a JSON document
- "subschema" otherwise. Where appropriate consider rephasing the sentence to be about building a JSON document (and therefore using "object")
odscjen marked this conversation as resolved.
Show resolved Hide resolved

When referring to a field, prefer the notation for the path in the data, like ``contracts.period``, rather than the notation for the path in the schema, like ``Contract.period``.

Expand Down