diff --git a/autogen_docs/schemas/core-permit-schema.md b/autogen_docs/schemas/core-permit-schema.md index ec9d061..6de6729 100644 --- a/autogen_docs/schemas/core-permit-schema.md +++ b/autogen_docs/schemas/core-permit-schema.md @@ -1,6 +1,6 @@ -# permitting_mvd +# Core Permitting Schema -*Standardisation of the attributes collected from all LOB source systems associated with the PMT* +*This data specification provides a standard list of values for Natural Resource Sector core permitting data.* ## Properties @@ -10,7 +10,7 @@ - **`source_system_id`** *(string, format: uuid)*: Unique ID of the permit in the source system. - **`project_id`** *(string, format: uuid)*: ID of the project this permit relates to. - **`agency`** *(string)*: Acronym for the agency or ministry issuing the permit. Must be one of: `["AF", "ENV", "FOR", "MOTI", "WLRS", "BCER"]`. -- **`business`** *(string)*: Business domain or area responsible for the permit. Must be one of: `["Archaeology", "Contaminated Sites", "Lands", "Riparian", "Transportation", "Water"]`. +- **`business`** *(string)*: Business domain, office or area responsible for the permit. Must be one of: `["Archaeology", "Contaminated Sites", "Lands", "Riparian", "Transportation", "Water"]`. - **`application_status`** *(string)*: Status of the application to obtain a permit. Must be one of: `["Issued", "Denied", "Pending", "In Review"]`. - **`permit_application_name`** *(string)*: The business domain permit type. Must be one of: `["Commercial General", "Nominal Rent Tenure", "Residential", "Roadways - Public", "Utilities", "New Groundwater Licence", "Water Licence", "Change Approval for Works in and About a Stream"]`. - **`permit_application_type`** *(['string', 'null'])*: The form type for a permit or licence application. Must be one of: `["New", "Amendment", "Cancel", "Change Ownership"]`. diff --git a/autogen_docs/schemas/housing-permit-schema.md b/autogen_docs/schemas/housing-permit-schema.md index cc4fbf6..718344f 100644 --- a/autogen_docs/schemas/housing-permit-schema.md +++ b/autogen_docs/schemas/housing-permit-schema.md @@ -1,6 +1,6 @@ -# housing-permit-schema +# Housing Permitting Schema -*Standardisation of the supplementary housing permit schema.* +*This data specification provides a standard list of values for Natural Resource Sector permitting data realted to housing attributes to supplement the core permit schema.* ## Properties diff --git a/autogen_docs/schemas/metadata-discovery-schema.md b/autogen_docs/schemas/metadata-discovery-schema.md index ad01d11..560a66c 100644 --- a/autogen_docs/schemas/metadata-discovery-schema.md +++ b/autogen_docs/schemas/metadata-discovery-schema.md @@ -1,6 +1,6 @@ -# Data Discovery Schema +# Metadata Discovery Schema -*Metadata collected during data discovery* +*This data specitification provides a standard list of metadata values for data collected from different source systems.* ## Properties diff --git a/schemas/definitions/core-permit-schema.json b/schemas/definitions/core-permit-schema.json index 6a6601c..81763c6 100644 --- a/schemas/definitions/core-permit-schema.json +++ b/schemas/definitions/core-permit-schema.json @@ -2,7 +2,7 @@ "$id": "https://github.com/bcgov/nr-data-hub/tree/main/schemas/mvd.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Core Permitting Schema", - "description": "Standardisation of the attributes collected from all permitting systems.", + "description": "This data specification provides a standard list of values for Natural Resource Sector core permitting data.", "type": "object", "properties": { "id": { diff --git a/schemas/definitions/housing-permit-schema.json b/schemas/definitions/housing-permit-schema.json index 8dec856..2204f09 100644 --- a/schemas/definitions/housing-permit-schema.json +++ b/schemas/definitions/housing-permit-schema.json @@ -1,8 +1,8 @@ { "$id": "https://github.com/bcgov/nr-permitting-data-spec/tree/main", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "housing-permit-schema", - "description": "Standardisation of the supplementary housing permit schema.", + "title": "Housing Permitting Schema", + "description": "This data specification provides a standard list of values for Natural Resource Sector permitting data realted to housing attributes to supplement the core permit schema.", "type": "object", "properties": { "housing_dwelling_type": { diff --git a/schemas/definitions/metadata-discovery-schema.json b/schemas/definitions/metadata-discovery-schema.json index 1218c43..44c1cd1 100644 --- a/schemas/definitions/metadata-discovery-schema.json +++ b/schemas/definitions/metadata-discovery-schema.json @@ -1,8 +1,8 @@ { "$id": "https://github.com/bcgov/nr-data-hub/tree/main/schemas/definitions/data_discovery.schema.json", "$schema": "https://json-schema.org/draft/2020-12/schema", - "title": "Metadata Data Discovery Schema", - "description": "Metadata collected during data discovery", + "title": "Metadata Discovery Schema", + "description": "This data specitification provides a standard list of metadata values for data collected from different source systems.", "type": "object", "$defs": { "users": {