From fd0b7df768885d12baded571bade3cc4fcf84739 Mon Sep 17 00:00:00 2001 From: Jeremy Ho Date: Fri, 22 Nov 2024 17:31:13 -0800 Subject: [PATCH] Restructure to data, message and resource types Signed-off-by: Jeremy Ho --- docs/spec/{types => data}/_category_.json | 2 +- docs/spec/{types => data}/code.mdx | 2 +- docs/spec/{types => data}/code.schema.json | 0 docs/spec/{types => data}/parcel_id.example.json | 0 docs/spec/{types => data}/parcel_id.mdx | 4 ++-- docs/spec/{types => data}/parcel_id.schema.json | 0 docs/spec/{types => data}/project_bundle.example.json | 0 docs/spec/{types => data}/project_bundle.mdx | 4 ++-- docs/spec/{types => data}/project_bundle.schema.json | 0 docs/spec/message/_category_.json | 8 ++++++++ docs/spec/resource/_category_.json | 8 ++++++++ docs/spec/schemas/_category_.json | 8 -------- 12 files changed, 22 insertions(+), 14 deletions(-) rename docs/spec/{types => data}/_category_.json (86%) rename docs/spec/{types => data}/code.mdx (94%) rename docs/spec/{types => data}/code.schema.json (100%) rename docs/spec/{types => data}/parcel_id.example.json (100%) rename docs/spec/{types => data}/parcel_id.mdx (96%) rename docs/spec/{types => data}/parcel_id.schema.json (100%) rename docs/spec/{types => data}/project_bundle.example.json (100%) rename docs/spec/{types => data}/project_bundle.mdx (92%) rename docs/spec/{types => data}/project_bundle.schema.json (100%) create mode 100644 docs/spec/message/_category_.json create mode 100644 docs/spec/resource/_category_.json delete mode 100644 docs/spec/schemas/_category_.json diff --git a/docs/spec/types/_category_.json b/docs/spec/data/_category_.json similarity index 86% rename from docs/spec/types/_category_.json rename to docs/spec/data/_category_.json index 561a3b5..13ee5ef 100644 --- a/docs/spec/types/_category_.json +++ b/docs/spec/data/_category_.json @@ -1,6 +1,6 @@ { "label": "Data Types", - "position": 3, + "position": 2, "link": { "type": "generated-index", "description": "Data Types" diff --git a/docs/spec/types/code.mdx b/docs/spec/data/code.mdx similarity index 94% rename from docs/spec/types/code.mdx rename to docs/spec/data/code.mdx index 3b24040..a0fbd5a 100644 --- a/docs/spec/types/code.mdx +++ b/docs/spec/data/code.mdx @@ -10,7 +10,7 @@ import CodeBlock from "@theme/CodeBlock"; import JSONSchemaViewer from "@theme/JSONSchemaViewer"; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -import Schema from "@site/docs/spec/types/code.schema.json"; +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 to a string which has at least one character and no leading or trailing whitespace, and where there is no whitespace diff --git a/docs/spec/types/code.schema.json b/docs/spec/data/code.schema.json similarity index 100% rename from docs/spec/types/code.schema.json rename to docs/spec/data/code.schema.json diff --git a/docs/spec/types/parcel_id.example.json b/docs/spec/data/parcel_id.example.json similarity index 100% rename from docs/spec/types/parcel_id.example.json rename to docs/spec/data/parcel_id.example.json diff --git a/docs/spec/types/parcel_id.mdx b/docs/spec/data/parcel_id.mdx similarity index 96% rename from docs/spec/types/parcel_id.mdx rename to docs/spec/data/parcel_id.mdx index 175b422..dedf7e2 100644 --- a/docs/spec/types/parcel_id.mdx +++ b/docs/spec/data/parcel_id.mdx @@ -11,8 +11,8 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer"; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -import Example from "@site/docs/spec/types/parcel_id.example.json"; -import Schema from "@site/docs/spec/types/parcel_id.schema.json"; +import Example from "@site/docs/spec/data/parcel_id.example.json"; +import Schema from "@site/docs/spec/data/parcel_id.schema.json"; An identifier for a specific area with clear boundaries. diff --git a/docs/spec/types/parcel_id.schema.json b/docs/spec/data/parcel_id.schema.json similarity index 100% rename from docs/spec/types/parcel_id.schema.json rename to docs/spec/data/parcel_id.schema.json diff --git a/docs/spec/types/project_bundle.example.json b/docs/spec/data/project_bundle.example.json similarity index 100% rename from docs/spec/types/project_bundle.example.json rename to docs/spec/data/project_bundle.example.json diff --git a/docs/spec/types/project_bundle.mdx b/docs/spec/data/project_bundle.mdx similarity index 92% rename from docs/spec/types/project_bundle.mdx rename to docs/spec/data/project_bundle.mdx index 850b125..8116231 100644 --- a/docs/spec/types/project_bundle.mdx +++ b/docs/spec/data/project_bundle.mdx @@ -11,8 +11,8 @@ import JSONSchemaViewer from "@theme/JSONSchemaViewer"; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -import Example from "@site/docs/spec/types/project_bundle.example.json"; -import Schema from "@site/docs/spec/types/project_bundle.schema.json"; +import Example from "@site/docs/spec/data/project_bundle.example.json"; +import Schema from "@site/docs/spec/data/project_bundle.schema.json"; A set of one or more permits related to an activity. diff --git a/docs/spec/types/project_bundle.schema.json b/docs/spec/data/project_bundle.schema.json similarity index 100% rename from docs/spec/types/project_bundle.schema.json rename to docs/spec/data/project_bundle.schema.json diff --git a/docs/spec/message/_category_.json b/docs/spec/message/_category_.json new file mode 100644 index 0000000..8ed7ef0 --- /dev/null +++ b/docs/spec/message/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Message Types", + "position": 3, + "link": { + "type": "generated-index", + "description": "Message Types" + } +} diff --git a/docs/spec/resource/_category_.json b/docs/spec/resource/_category_.json new file mode 100644 index 0000000..02677fb --- /dev/null +++ b/docs/spec/resource/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Resource Types", + "position": 4, + "link": { + "type": "generated-index", + "description": "Resource Types" + } +} diff --git a/docs/spec/schemas/_category_.json b/docs/spec/schemas/_category_.json deleted file mode 100644 index 7d76d4a..0000000 --- a/docs/spec/schemas/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Schemas", - "position": 2, - "link": { - "type": "generated-index", - "description": "Schemas" - } -}