From 5c6eca546cd6ce5536bfc8b547093ccc4b7d251b Mon Sep 17 00:00:00 2001 From: dakota002 Date: Wed, 16 Oct 2024 11:25:35 -0400 Subject: [PATCH] Revise the docs for schema --- app/routes/docs.notices.schema.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/routes/docs.notices.schema.mdx b/app/routes/docs.notices.schema.mdx index 0f2fc1ceb..5362dff8a 100644 --- a/app/routes/docs.notices.schema.mdx +++ b/app/routes/docs.notices.schema.mdx @@ -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', @@ -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 @@ -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: