Update all JSONSchemaViewer to use resolverOptions

This change ensures external json schemas can be expanded by default Signed-off-by: Jeremy Ho <jujaga@gmail.com>
bcgov · Jan 4, 2025 · 6c4e2ce · 6c4e2ce
1 parent 82d4dbb
commit 6c4e2ce
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 5 deletions.
diff --git a/docs/spec/data/code.mdx b/docs/spec/data/code.mdx
@@ -11,6 +11,7 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
+import { generateResolverOptions } from "@site/src/components/shared";
 import schema from "@site/docs/spec/data/code.schema.json";
 
 Indicates that the value is taken from a set of controlled strings defined elsewhere. Technically, a code is restricted
@@ -28,7 +29,11 @@ Type: `string`
 
 <Tabs queryString="tab">
   <TabItem value="schema" label="Schema" default>
-    <JSONSchemaViewer schema={schema} viewerOptions={{ showExamples: true }} />
+    <JSONSchemaViewer
+      resolverOptions={generateResolverOptions({ "remote": true })}
+      schema={schema}
+      viewerOptions={{ showExamples: true }}
+    />
   </TabItem>
   <TabItem value="source" label="Source">
     <CodeBlock language="json" showLineNumbers>

diff --git a/docs/spec/data/event.mdx b/docs/spec/data/event.mdx
@@ -11,6 +11,7 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
+import { generateResolverOptions } from "@site/src/components/shared";
 import exampleDateRange from "@site/docs/spec/data/event.example.date_range.json";
 import exampleDateStart from "@site/docs/spec/data/event.example.date_start.json";
 import exampleDateTimeRange from "@site/docs/spec/data/event.example.datetime_range.json";
@@ -44,7 +45,11 @@ and context of an event will be dependent on which [resource type](../../categor
 
 <Tabs queryString="tab">
   <TabItem value="schema" label="Schema" default>
-    <JSONSchemaViewer schema={schema} viewerOptions={{ showExamples: true }} />
+    <JSONSchemaViewer
+      resolverOptions={generateResolverOptions({ "remote": true })}
+      schema={schema}
+      viewerOptions={{ showExamples: true }}
+    />
   </TabItem>
   <TabItem value="source" label="Source">
     <CodeBlock language="json" showLineNumbers>

diff --git a/docs/spec/data/parcel_id.mdx b/docs/spec/data/parcel_id.mdx
@@ -11,6 +11,7 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
+import { generateResolverOptions } from "@site/src/components/shared";
 import example from "@site/docs/spec/data/parcel_id.example.json";
 import schema from "@site/docs/spec/data/parcel_id.schema.json";
 
@@ -42,7 +43,11 @@ The parcel identification number (PIN) is the Crown Land Registry Parcel Identif
 
 <Tabs queryString="tab">
   <TabItem value="schema" label="Schema" default>
-    <JSONSchemaViewer schema={schema} viewerOptions={{ showExamples: true }} />
+    <JSONSchemaViewer
+      resolverOptions={generateResolverOptions({ "remote": true })}
+      schema={schema}
+      viewerOptions={{ showExamples: true }}
+    />
   </TabItem>
   <TabItem value="source" label="Source">
     <CodeBlock language="json" showLineNumbers>

diff --git a/docs/spec/data/process.mdx b/docs/spec/data/process.mdx
@@ -11,6 +11,7 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
+import { generateResolverOptions } from "@site/src/components/shared";
 import example from "@site/docs/spec/data/process.example.json";
 import schema from "@site/docs/spec/data/process.schema.json";
 
@@ -36,7 +37,11 @@ Loosely taking inspiration from [HL7 Timing](https://www.hl7.org/fhir/datatypes.
 
 <Tabs queryString="tab">
   <TabItem value="schema" label="Schema" default>
-    <JSONSchemaViewer schema={schema} viewerOptions={{ showExamples: true }} />
+    <JSONSchemaViewer
+      resolverOptions={generateResolverOptions({ "remote": true })}
+      schema={schema}
+      viewerOptions={{ showExamples: true }}
+    />
   </TabItem>
   <TabItem value="source" label="Source">
     <CodeBlock language="json" showLineNumbers>

diff --git a/docs/spec/data/project_bundle.mdx b/docs/spec/data/project_bundle.mdx
@@ -11,6 +11,7 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer";
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
+import { generateResolverOptions } from "@site/src/components/shared";
 import example from "@site/docs/spec/data/project_bundle.example.json";
 import schema from "@site/docs/spec/data/project_bundle.schema.json";
 
@@ -34,7 +35,11 @@ This data type is intended to represent a grouping of related permits that are r
 
 <Tabs queryString="tab">
   <TabItem value="schema" label="Schema" default>
-    <JSONSchemaViewer schema={schema} viewerOptions={{ showExamples: true }} />
+    <JSONSchemaViewer
+      resolverOptions={generateResolverOptions({ "remote": true })}
+      schema={schema}
+      viewerOptions={{ showExamples: true }}
+    />
   </TabItem>
   <TabItem value="source" label="Source">
     <CodeBlock language="json" showLineNumbers>