Skip to content

Commit

Permalink
Revise the docs for schema
Browse files Browse the repository at this point in the history
  • Loading branch information
dakota002 authored and lpsinger committed Oct 17, 2024
1 parent 6fa3a06 commit 5c6eca5
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions app/routes/docs.notices.schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Here is a basic schema file, `sample.schema.json`, and an example file, `sample.
},
],
properties: {
$schema: true,
$schema: { type: 'string', format: 'uri' },
example_field_1: {
type: 'string',
description: 'A custom field that can hold text',
Expand Down Expand Up @@ -122,7 +122,7 @@ List of core schema to include fields from. [Browse the core schema](/docs/schem

#### `properties`

Mapping of custom, mission-specific fields. The first property, `'$schema: true'`, must be included when using `'unevaluatedProperties': false`, otherwise the inclusion of the `$schema` property in your example files will cause validation to fail. Field names should use [snake_case](https://en.wikipedia.org/wiki/Snake_case). Each entry should at least have a description and a type. See the [list of available data types](https://json-schema.org/understanding-json-schema/reference/type.html).
Mapping of custom, mission-specific fields. The first property, `'$schema: { type: "string", format: "uri" }'`, must be included when using `'unevaluatedProperties': false`, otherwise the inclusion of the `$schema` property in your example files will cause validation to fail. Field names should use [snake_case](https://en.wikipedia.org/wiki/Snake_case). Each entry should at least have a description and a type. See the [list of available data types](https://json-schema.org/understanding-json-schema/reference/type.html).

## Extended Example

Expand Down Expand Up @@ -150,7 +150,7 @@ We recommend exploring our [schema browser](/docs/schema/stable/gcn/notices) and
{ $ref: '../../core/AdditionalInfo.schema.json' },
],
properties: {
$schema: true,
$schema: { type: 'string', format: 'uri' },
follow_up_event: {
type: 'string',
description:
Expand Down

0 comments on commit 5c6eca5

Please sign in to comment.