From 9405e01fe755c266ecc82dcf00dcbb51dea65598 Mon Sep 17 00:00:00 2001 From: Jeremy Ho Date: Fri, 22 Nov 2024 17:11:38 -0800 Subject: [PATCH] Drop old "core" schema We have determined that this is not a schema that will satisfy needs. Signed-off-by: Jeremy Ho --- docs/intro/getting_started.md | 2 +- docs/intro/terminology.md | 2 +- docs/spec/schemas/core.mdx | 45 ----- docs/spec/schemas/core.schema.json | 268 ----------------------------- 4 files changed, 2 insertions(+), 315 deletions(-) delete mode 100644 docs/spec/schemas/core.mdx delete mode 100644 docs/spec/schemas/core.schema.json diff --git a/docs/intro/getting_started.md b/docs/intro/getting_started.md index 9ee44f1..2ec5e98 100644 --- a/docs/intro/getting_started.md +++ b/docs/intro/getting_started.md @@ -81,4 +81,4 @@ into the data standards. ## Schemas -- [Core Schema](../spec/schemas/core) +TBD diff --git a/docs/intro/terminology.md b/docs/intro/terminology.md index 6782640..dc18cd1 100644 --- a/docs/intro/terminology.md +++ b/docs/intro/terminology.md @@ -135,7 +135,7 @@ each other. --- title: Process Tracking Concept Map --- -flowchart TB +flowchart LR Status@{ shape: processes } subgraph Lifecycle diff --git a/docs/spec/schemas/core.mdx b/docs/spec/schemas/core.mdx deleted file mode 100644 index fb7cdde..0000000 --- a/docs/spec/schemas/core.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: core -title: Core Schema -description: Natural Resource Sector core permitting data schema -tags: - - business - - developer ---- - -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/schemas/core.schema.json"; - -This data schema provides a standard set of values for Natural Resource Sector core permitting data. - -:::info -This schema is currently under revision for scope and content. -::: - -## Scope - -The schema is intended to be used in general transactional situations. It comprises of the minimum set of data required to coherently represent a permit and their immediately related attributes. - -## Structure - -| Name | Cardinality | Type | Description & Constraints | -| --- | --- | --- | --- | -| project_linking_id | 1..1 | `uuid` | A unique key to track all permits related to a project or activity from all permitting systems. | -| project_name | 0..1 | `string` | Short name of the project, e.g., The Hudson, Capitol Hill. | -| TBD | 0..* | `object` | More will be filled in later... | - -## Specification - - - - - - - - {JSON.stringify(Schema, null, 2)} - - - diff --git a/docs/spec/schemas/core.schema.json b/docs/spec/schemas/core.schema.json deleted file mode 100644 index 84d0a14..0000000 --- a/docs/spec/schemas/core.schema.json +++ /dev/null @@ -1,268 +0,0 @@ -{ - "$id": "https://github.com/bcgov/nr-pies/blob/main/docs/spec/schemas/core.schema.json", - "$schema": "https://json-schema.org/draft-07/schema", - "title": "Core Permitting Schema", - "description": "This data specification provides a standard list of values for Natural Resource Sector core permitting data.", - "type": "object", - "properties": { - "project_linking_id": { - "type": "string", - "description": "A unique key to track all permits related to a project or activity from all permitting systems.", - "format": "uuid" - }, - "project_name": { - "type": [ - "string", - "null" - ], - "description": "Short name of the project, e.g., The Hudson, Capitol Hill." - }, - "project_description": { - "type": [ - "string", - "null" - ], - "description": "Full description of the project. This field may contain information to better understand a project" - }, - "project_location_description": { - "type": [ - "string", - "null" - ], - "description": "A short description for the geographical location or area of interest of the project." - }, - "physical_address": { - "type": [ - "string", - "null" - ], - "description": "This is the physical address if provided for a project." - }, - "region_name": { - "type": "string", - "description": "Natural Resource administrative boundary associated with the physical project location.", - "enum": [ - "Cariboo", - "Kootenay-Boundary", - "Northeast", - "Omineca", - "Skeena", - "South Coast", - "Thompson-Okanagan", - "West Coast" - ] - }, - "agency": { - "type": "string", - "description": "Acronym for the agency or ministry issuing the permit.", - "enum": [ - "AGRI", - "ENV", - "EMLI", - "FOR", - "MIRR", - "MOTI", - "WLRS", - "BCER" - ] - }, - "business_domain": { - "type": "string", - "description": "Business domain, office or area responsible for the permit.", - "enum": [ - "Archaeology", - "Contaminated Sites", - "Lands", - "Riparian", - "Transportation", - "Water" - ] - }, - "source_system_acronym": { - "type": "string", - "description": "Acronym for the source system providing the permit tracking.", - "enum": [ - "APTS", - "CATS", - "EPUPS; PPA", - "FTA", - "MOTI", - "RARN", - "RRS", - "TANTALIS", - "WILD", - "WMA" - ] - }, - "application_id": { - "type": "string", - "description": "Unique ID of the submitted application for a permit." - }, - "application_name": { - "type": [ - "string", - "null" - ], - "description": "Name of the application for a permit." - }, - "application_type": { - "type": "string", - "description": "The form type for a permit or licence application.", - "enum": [ - "Amendment", - "Cancel", - "Change Ownership", - "New" - ] - }, - "application_lifecycle_state": { - "type": "string", - "description": "Tracking state of an application in progress.", - "enum": [ - "Active", - "Closed", - "On hold" - ] - }, - "application_status": { - "type": "string", - "description": "Status of the application during the process and final decision.", - "enum": [ - "Abandoned", - "Approved", - "Cancelled", - "In Process", - "In Referral", - "Issued", - "Offered", - "Rejected", - "Requested", - "Suspended", - "With client" - ] - }, - "permit_id": { - "type": "string", - "description": "A permit specific ID used to identify the issued permit id. A meaningful number/code used by the business area to identify the permit.", - "format": "uuid" - }, - "permit_name": { - "type": "string", - "description": "The business domain permit name type", - "enum": [ - "Change approval for work in and about a stream", - "Commercial General", - "Contaminated Sites Remediation", - "Groundwater Licence", - "Heritage Inspection Permit", - "Highway Use Permit", - "Investigation Permit", - "Municipal subdivision", - "Nominal Rent Tenure", - "Notification of authorized changes in and about a stream", - "Occupant Licence to Cut", - "Other", - "Private Timber Mark", - "Residential", - "Rezoning", - "Riparian Area Development Permit", - "Roadways - Public", - "Rural subdivision", - "Short-term use approval", - "Site Alteration Permit", - "Sponsored Crown Grant", - "Surface Water Licence", - "Utilities" - ] - }, - "permit_application_type": { - "type": [ - "string", - "null" - ], - "description": "The form type for a permit or licence application", - "enum": [ - "New", - "Amendment", - "Cancel", - "Change Ownership" - ] - }, - "received_date": { - "type": "string", - "description": "Date in which the application for permit was submitted", - "format": "date-time" - }, - "accepted_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the review of the initial application's completeness concludes", - "format": "date-time" - }, - "tech_review_completion_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the technical team concludes their review of the application", - "format": "date-time" - }, - "rejected_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the permit is rejected", - "format": "date-time" - }, - "adjudication_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the permit is adjudicated as either issued or not issued.", - "format": "date-time" - }, - "amendment_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the permit is amended", - "format": "date-time" - }, - "fn_consultn_start_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the consultation with First Nations starts", - "format": "date-time" - }, - "fn_consultn_completion_date": { - "type": [ - "string", - "null" - ], - "description": "Date in which the consultation with First Nations ends", - "format": "date-time" - } - }, - "required": [ - "project_linking_id", - "region_name", - "agency", - "business_domain", - "source_system_acronym", - "application_id", - "application_type", - "application_tracking_state", - "application_status", - "project_id", - "permit_application_type", - "permit_name", - "received_date" - ] -}