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.

Sign up for GitHub

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/core added comments examples and subgroups #20

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Fix/core added comments examples and subgroups #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3691fa
Update core-permit-schema.json
annikaLiving Jul 3, 2024
424bc33
feat/added bundles and todo comments
annikaLiving Jul 4, 2024
2c31584
Merge branch 'main' into fix/core-add-comments-examples-and-subgroups
annikaLiving Jul 4, 2024
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
33 changes: 19 additions & 14 deletions autogen_docs/schemas/core-permit-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,28 @@

## Properties

- **`project_linking_id`** *(string, format: uuid)*: A unique key to track all permits related to a project or activity from all permitting systems.
- **`project_name`** *(['string', 'null'])*: Short name of the project, e.g., The Hudson, Capitol Hill.
- **`project_description`** *(['string', 'null'])*: Full description of the project. This field may contain information to better understand a project.
- **`project_location_description`** *(['string', 'null'])*: A short description for the geographical location or area of interest of the project.
- **`physical_address`** *(['string', 'null'])*: This is the physical address if provided for a project.
- **`region_name`** *(string)*: Natural Resource administrative boundary associated with the physical project location. Must be one of: `["Cariboo", "Kootenay-Boundary", "Northeast", "Omineca", "Skeena", "South Coast", "Thompson-Okanagan", "West Coast"]`.
- **`project_details`** *(object)*: Details for a project.
- **`project_linking_id`** *(string, format: uuid)*: A unique key to track all permits related to a project or activity from all permitting systems.
- **`project_name`** *(['string', 'null'])*: Short name of the project, e.g., The Hudson, Capitol Hill.
- **`project_description`** *(['string', 'null'])*: Full description of the project. This field may contain information to better understand a project.
- **`location_details`** *(object)*: Details for a location of a project or activity.
- **`project_location_description`** *(['string', 'null'])*: A short description for the geographical location or area of interest of the project.
- **`physical_address`** *(['string', 'null'])*: This is the physical address if provided for a project.
- **`parcel_name`** *(['string', 'null'])*: Is the the Parcel ID (PID), if there is one. If there is a PIN but no PID, then it is the PIN. If there is no PID nor PIN, then may be empty and another attribute populated with location details.
- **`region_name`** *(string)*: Natural Resource administrative boundary associated with the physical project location. Must be one of: `["Cariboo", "Kootenay-Boundary", "Northeast", "Omineca", "Skeena", "South Coast", "Thompson-Okanagan", "West Coast"]`.
- **`agency`** *(string)*: Acronym for the agency or ministry issuing the permit. Must be one of: `["AGRI", "ENV", "EMLI", "FOR", "MIRR", "MOTI", "WLRS", "BCER"]`.
- **`business_domain`** *(string)*: Business domain, office or area responsible for the permit. Must be one of: `["Archaeology", "Contaminated Sites", "Lands", "Riparian", "Transportation", "Water"]`.
- **`source_system_acronym`** *(string)*: Acronym for the source system providing the permit tracking. Must be one of: `["APTS", "CATS", "EPUPS; PPA", "FTA", "MOTI", "RARN", "RRS", "TANTALIS", "WILD", "WMA"]`.
- **`application_id`** *(string)*: Unique ID of the submitted application for a permit.
- **`application_name`** *(['string', 'null'])*: Name of the application for a permit.
- **`application_type`** *(string)*: The form type for a permit or licence application. Must be one of: `["Amendment", "Cancel", "Change Ownership", "New"]`.
- **`application_lifecycle_state`** *(string)*: Tracking state of an application in progress. Must be one of: `["Active", "Closed", "On hold"]`.
- **`application_status`** *(string)*: Status of the application during the process and final decision. Must be one of: `["Abandoned", "Approved", "Cancelled", "In Process", "In Referral", "Issued", "Offered", "Rejected", "Requested", "Suspended", "With client"]`.
- **`permit_id`** *(string, format: uuid)*: A permit specific ID used to identify the issued permit id. A meaningful number/code used by the business area to identify the permit.
- **`permit_name`** *(string)*: The business domain permit name type. Must be one of: `["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`** *(['string', 'null'])*: The form type for a permit or licence application. Must be one of: `["New", "Amendment", "Cancel", "Change Ownership"]`.
- **`application_details`** *(object)*: Details for a application for a permit.
- **`application_id`** *(string)*: Unique ID of the submitted application for a permit.
- **`application_name`** *(['string', 'null'])*: Name of the application for a permit.
- **`application_type`** *(string)*: The form type for a permit or licence application. Must be one of: `["Amendment", "Cancel", "Change Ownership", "New"]`.
- **`application_lifecycle_state`** *(string)*: Tracking state of an application in progress. Must be one of: `["Active", "Closed", "On hold"]`.
- **`application_status`** *(string)*: Status of the application during the process and final decision. Must be one of: `["Abandoned", "Approved", "Cancelled", "In Process", "In Referral", "Issued", "Offered", "Rejected", "Requested", "Suspended", "With client"]`.
- **`permit_details`** *(object)*: Details for a permit as these may be different than the application.
- **`permit_id`** *(string, format: uuid)*: A permit specific ID used to identify the issued permit id. A meaningful number/code used by the business area to identify the permit.
- **`permit_name`** *(string)*: The business domain permit name type. Must be one of: `["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`** *(['string', 'null'])*: The form type for a permit application. Must be one of: `["New", "Amendment", "Cancel", "Change Ownership"]`.
- **`received_date`** *(string, format: date-time)*: Date in which the application for permit was submitted.
- **`accepted_date`** *(['string', 'null'], format: date-time)*: Date in which the review of the initial application's completeness concludes.
- **`tech_review_completion_date`** *(['string', 'null'], format: date-time)*: Date in which the technical team concludes their review of the application.
Expand Down
Loading