Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix/title and description for schemas and regenerated autodocs #13

Merged
merged 6 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions autogen_docs/schemas/core-permit-schema.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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"]`.
Expand Down
4 changes: 2 additions & 2 deletions autogen_docs/schemas/housing-permit-schema.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions autogen_docs/schemas/metadata-discovery-schema.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion schemas/definitions/core-permit-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
4 changes: 2 additions & 2 deletions schemas/definitions/housing-permit-schema.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
4 changes: 2 additions & 2 deletions schemas/definitions/metadata-discovery-schema.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
Loading