Skip to content

Commit

Permalink
style_guide.rst: update describing JSON Schema guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
odscjen committed Nov 7, 2024
1 parent 7c97ca6 commit 0b61f4e
Showing 1 changed file with 9 additions and 3 deletions.
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")

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

0 comments on commit 0b61f4e

Please sign in to comment.