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

feat/creation of a permit name registry schema #15

Merged
merged 3 commits into from
Jun 27, 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
14 changes: 14 additions & 0 deletions autogen_docs/schemas/permit-name-registry-schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Permit Name Registry Schema

*This data specification enables the creation of a standard list of permit names for the Natural Resource Sector permitting systems.*

## Properties

- **`permit-name-registry-id`** *(string, format: uuid)*: A unique key of registered permit names.
- **`source_system_acronym`** *(string)*: Acronym for the source system providing the permit tracking.
- **`permit_name`** *(string)*: The business domain permit name type.
- **`permit_application_type`** *(['string', 'null'])*: The form types for a permit or licence application. Must be one of: `["Amendment", "Cancel", "Change Ownership", "New"]`.
- **`create_timestamp`** *(date-time)*: The date and time the record was created.
- **`create_user`** *(string)*: The user or proxy account that created the record.
- **`update_timestamp`** *(date-time)*: The date and time the record was created or last updated.
- **`update_user`** *(string)*: The user or proxy account that created or last updated the record.
60 changes: 60 additions & 0 deletions schemas/definitions/permit-name-registry-schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"$id":"https://github.com/bcgov/nr-data-hub/tree/main/schemas/mvd.schema.json",
"$schema":"https://json-schema.org/draft/2020-12/schema",
"title":"Permit Name Registry Schema",
"description":"This data specification enables the creation of a standard list of permit names for the Natural Resource Sector permitting systems.",
"type":"object",
"properties":{
"permit-name-registry-id":{
"type":"string",
"description":"A unique key of registered permit names.",
"format":"uuid"
},
"source_system_acronym":{
"type":"string",
"description":"Acronym for the source system providing the permit tracking."
},
"permit_name":{
"type":"string",
"description":"The business domain permit name type"
},
"permit_application_type":{
"type":[
"string",
"null"
],
"description":"The form types for a permit or licence application",
"enum":[
"Amendment",
"Cancel",
"Change Ownership",
"New"
]
},
"create_timestamp":{
"type":"date-time",
"description":"The date and time the record was created."
},
"create_user":{
"type":"string",
"description":"The user or proxy account that created the record."
},
"update_timestamp":{
"type":"date-time",
"description":"The date and time the record was created or last updated."
},
"update_user":{
"type":"string",
"description":"The user or proxy account that created or last updated the record."
}
},
"required":[
"permit-name-id",
"source_system_acronym",
"permit_name",
"create_timestamp",
"create_user",
"update_timestamp",
"update_user"
]
}
Loading