From 5b6b23188a386bfcdced8294f0d11bb29d9dc244 Mon Sep 17 00:00:00 2001 From: pstlouis Date: Sun, 4 Feb 2024 15:28:11 -0500 Subject: [PATCH 1/9] BC Gov mines act permit Signed-off-by: pstlouis --- .../schemas/common/MinesActPermit.yml | 177 ++++++++++++++++++ .../credentials/MinesActPermitCredential.yml | 166 ++++++++++++++++ 2 files changed, 343 insertions(+) create mode 100644 docs/openapi/components/schemas/common/MinesActPermit.yml create mode 100644 docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/MinesActPermit.yml new file mode 100644 index 000000000..2efd47632 --- /dev/null +++ b/docs/openapi/components/schemas/common/MinesActPermit.yml @@ -0,0 +1,177 @@ +--- +$linkedData: + term: MinesActPermit + '@id': https://w3id.org/traceability#MinesActPermit +title: Mines Act Permit +description: The Mines Act regulates mining activities in British Columbia (B.C.) - from early exploration to development, production, reclamation, closure, and post-closure. A permit must be in place before any work in, on, or about a mine can occur. A B.C. Mines Act Permit credential issued according to this Governance Framework (GF) provides evidence the credential holder has been issued a B.C. Mines Act Permit. +type: object +properties: + type: + type: array + readOnly: true + const: + - MinesActPermit + default: + - MinesActPermit + items: + type: string + enum: + - MinesActPermit + permit_no: + title: Permit Number + description: >- + (3-digit) Alpha-numeric identifier: M-##- or C-##- Permit Numbers are assigned to a specific mining operation or activity that has been granted permission or authorization. Mines Act Section 10 (1). + type: string + $linkedData: + term: permit_no + '@id': https://w3id.org/traceability#permit_no + permit_status: + title: Permit Status + description: >- + Defined as either "open" or "closed". + type: string + $linkedData: + term: + '@id': https://w3id.org/traceability#permit_status + permittee_name: + title: Permittee + description: >- + Name of the mining company that holds the permit. + type: string + $linkedData: + term: permittee_name + '@id': https://w3id.org/traceability#permittee_name + mine_operation_status: + title: Mine Operation Status + description: >- + Layer one in the hierarchy of identifying mine status. Mines status can be (1) Abandoned (2) Closed (3) Not Started (4) Operating. + type: string + $linkedData: + term: mine_operation_status + '@id': https://w3id.org/traceability#mine_operation_status + mine_operation_status_reason: + title: Mine Operation Status Reason + description: >- + Layer two in the hierarchy for identifying mine status. Reasons for Closed Mines (1) Closed for Care and Maintenance, (2) Closed for Reclamation and (3) Closed for Unknown. Reasons for Operating (1) Operating Seasonal, or (2) Operating Year Round + type: string + $linkedData: + term: mine_operation_status_reason + '@id': https://w3id.org/traceability#mine_operation_status_reason + mine_operation_status_sub_reason: + title: Mine Operation Status Sub Reason + description: >- + Layer three in the hierarchy for identifying mine status. Mine Operation Reasons for "Closed for Reclamation" (1) Long-Term Maintenance (2) Long-Term Maintenance and Water Treatment or (3) Permit Release Pending. + type: string + $linkedData: + term: mine_operation_status_sub_reason + '@id': https://w3id.org/traceability#mine_operation_status_sub_reason + mine_commodity: + title: Mine Commodity + description: >- + Lists the name(s) of the commodities being mined. + type: string + $linkedData: + term: mine_commodity + '@id': https://w3id.org/traceability#mine_commodity + mine_disturbance: + title: Mine Disturbance + description: >- + Specifies if mine is above ground (surface) or below ground (sub-surface). + type: string + $linkedData: + term: mine_disturbance + '@id': https://w3id.org/traceability#mine_disturbance + mine_no: + title: Mine Number + description: >- + (7-digit) Unique identifier assigned to a specific mine or mining operation to differentiate and track individual mines within a jurisdiction. + type: string + $linkedData: + term: mine_no + '@id': https://w3id.org/traceability#mine_no + issue_date: + title: Permit Start Date + description: >- + (YYYY-MM-DD) The original issue date of the permit. + type: string + $linkedData: + term: issue_date + '@id': https://w3id.org/traceability#issue_date + latitude: + title: Latitude + description: >- + (00.0000000) The geographic coordinate representing the north-south position of a specific location related to the administrative building at the mining operation or mine site. + type: string + $linkedData: + term: latitude + '@id': https://w3id.org/traceability#latitude + longitude: + title: Longitude + description: >- + (-000.0000000) The geographic coordinate that represents the east-west position of a specific location related to the administrative building at the mining operation or mine site. + type: string + $linkedData: + term: longitude + '@id': https://w3id.org/traceability#longitude + bond_total: + title: Bond Total + description: >- + (0.00) Lists the total bond value of the permit. A permittee is required to provide monetary security to cover reclamation costs, and to provide for the protection of, and mitigation of damage to, watercourses and cultural heritage resources affected by the mine. + type: string + $linkedData: + term: bond_total + '@id': https://w3id.org/traceability#bond_total + tsf_operating_count: + title: TSF Operating Count + description: >- + Numerical value for the total number of tailing storage facilities that are in Operating status. + type: string + $linkedData: + term: tsf_operating_count + '@id': https://w3id.org/traceability#tsf_operating_count + tsf_care_and_maintenance_count: + title: TSF Maintenance Count + description: >- + Numerical value for the total number of tailing storage facilities that are in Care and Maintenance status. + type: string + $linkedData: + term: tsf_care_and_maintenance_count + '@id': https://w3id.org/traceability#tsf_care_and_maintenance_count +additionalProperties: false +required: + - permit_no + - permit_status + - permittee_name + - mine_operation_status + - mine_operation_status_reason + - mine_operation_status_sub_reason + - mine_commodity + - mine_disturbance + - mine_no + - issue_date + - latitude + - longitude + - bond_total + - tsf_operating_count + - tsf_care_and_maintenance_count +example: |- + { + "type": [ + "MinesActPermit" + ], + "permit_no": "", + "permit_status": "", + "permittee_name": "", + "mine_operation_status": "", + "mine_operation_status_reason": "", + "mine_operation_status_sub_reason": "", + "mine_commodity": "", + "mine_disturbance": "", + "mine_no": "", + "issue_date": "", + "latitude": "", + "longitude": "", + "bond_total": "", + "tsf_operating_count": "", + "tsf_care_and_maintenance_count": "" + } diff --git a/docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml b/docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml new file mode 100644 index 000000000..4de006e89 --- /dev/null +++ b/docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml @@ -0,0 +1,166 @@ +$linkedData: + term: MinesActPermitCredential + '@id': https://w3id.org/traceability#MinesActPermitCredential +title: Mines Act Permit Credential +tags: + - Other +description: | + The Mines Act regulates mining activities in British Columbia (B.C.) - from early exploration to development, production, reclamation, closure, and post-closure. A permit must be in place before any work in, on, or about a mine can occur. A B.C. Mines Act Permit credential issued according to this Governance Framework (GF) provides evidence the credential holder has been issued a B.C. Mines Act Permit. +type: object +required: + - '@context' + - id + - type + - issuanceDate + - issuer + - credentialSubject +properties: + '@context': + type: array + readOnly: true + default: + - https://www.w3.org/2018/credentials/v1 + - https://w3id.org/traceability/v1 + items: + - type: string + const: https://www.w3.org/2018/credentials/v1 + additionalItems: + type: string + enum: + - https://w3id.org/traceability/v1 + type: + type: array + readOnly: true + default: + - VerifiableCredential + - MinesActPermitCredential + const: + - VerifiableCredential + - MinesActPermitCredential + items: + type: string + enum: + - VerifiableCredential + - MinesActPermitCredential + id: + type: string + format: uri + issuanceDate: + type: string + format: date-time + issuer: + type: object + properties: + id: + type: string + format: uri + credentialSubject: + type: object + properties: + type: + type: array + items: + type: string + enum: + - MinesActPermit + permit_no: + title: Permit Number + type: string + permit_status: + title: Permit Status + type: string + permittee_name: + title: Permittee + type: string + mine_operation_status: + title: Mine Operation Status + type: string + mine_operation_status_reason: + title: Mine Operation Status Reason + type: string + mine_operation_status_sub_reason: + title: Mine Operation Status Sub Reason + type: string + mine_commodity: + title: Mine Commodity + type: string + mine_disturbance: + title: Mine Disturbance + type: string + mine_no: + title: Mine Number + type: string + issue_date: + title: Permit Start Date + type: string + latitude: + title: Latitude + type: string + longitude: + title: Longitude + type: string + bond_total: + title: Bond Total + type: string + tsf_operating_count: + title: TSF Operating Count + type: string + tsf_care_and_maintenance_count: + title: TSF Maintenance Count + type: string + additionalProperties: false + required: + - permit_no + - permit_status + - permittee_name + - mine_operation_status + - mine_operation_status_reason + - mine_operation_status_sub_reason + - mine_commodity + - mine_disturbance + - mine_no + - issue_date + - latitude + - longitude + - bond_total + - tsf_operating_count + - tsf_care_and_maintenance_count + proof: + type: object +additionalProperties: false +example: |- + { + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://w3id.org/traceability/v1" + ], + "id": "", + "type": [ + "VerifiableCredential", + "MinesActPermitCredential" + ], + "issuanceDate": "", + "issuer": { + "id": "" + }, + "credentialSubject": { + "type": [ + "MinesActPermit" + ], + "permit_no": "", + "permit_status": "", + "permittee_name": "", + "mine_operation_status": "", + "mine_operation_status_reason": "", + "mine_operation_status_sub_reason": "", + "mine_commodity": "", + "mine_disturbance": "", + "mine_no": "", + "issue_date": "", + "latitude": "", + "longitude": "", + "bond_total": "", + "tsf_operating_count": "", + "tsf_care_and_maintenance_count": "" + } + } \ No newline at end of file From 8d1abc7a484ffbd9d38fcb133aa8c4dec3e55f55 Mon Sep 17 00:00:00 2001 From: pstlouis Date: Sun, 4 Feb 2024 15:44:51 -0500 Subject: [PATCH 2/9] add missing linkedData term Signed-off-by: pstlouis --- docs/openapi/components/schemas/common/MinesActPermit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/MinesActPermit.yml index 2efd47632..51dce3b92 100644 --- a/docs/openapi/components/schemas/common/MinesActPermit.yml +++ b/docs/openapi/components/schemas/common/MinesActPermit.yml @@ -31,7 +31,7 @@ properties: Defined as either "open" or "closed". type: string $linkedData: - term: + term: permit_status '@id': https://w3id.org/traceability#permit_status permittee_name: title: Permittee From 16c01127feedd3194629043f87e23ee476d756d9 Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Tue, 6 Feb 2024 13:59:10 -0500 Subject: [PATCH 3/9] Update docs/openapi/components/schemas/common/MinesActPermit.yml Co-authored-by: Ted Thibodeau Jr --- docs/openapi/components/schemas/common/MinesActPermit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/MinesActPermit.yml index 51dce3b92..00e452b05 100644 --- a/docs/openapi/components/schemas/common/MinesActPermit.yml +++ b/docs/openapi/components/schemas/common/MinesActPermit.yml @@ -44,7 +44,7 @@ properties: mine_operation_status: title: Mine Operation Status description: >- - Layer one in the hierarchy of identifying mine status. Mines status can be (1) Abandoned (2) Closed (3) Not Started (4) Operating. + Layer one in the hierarchy of identifying mine status. Mine status can be (1) Abandoned (2) Closed (3) Not Started (4) Operating. type: string $linkedData: term: mine_operation_status From 18f30b6bf0f502ac73684774d414827ce3bd07fb Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:00:06 -0500 Subject: [PATCH 4/9] Update docs/openapi/components/schemas/common/MinesActPermit.yml Co-authored-by: Ted Thibodeau Jr --- docs/openapi/components/schemas/common/MinesActPermit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/MinesActPermit.yml index 00e452b05..2875e000c 100644 --- a/docs/openapi/components/schemas/common/MinesActPermit.yml +++ b/docs/openapi/components/schemas/common/MinesActPermit.yml @@ -108,7 +108,7 @@ properties: longitude: title: Longitude description: >- - (-000.0000000) The geographic coordinate that represents the east-west position of a specific location related to the administrative building at the mining operation or mine site. + (-000.0000000) The geographic coordinate representing the east-west position of a specific location related to the administrative building at the mining operation or mine site. type: string $linkedData: term: longitude From 39678d54c25216a42e7214383ca5765fdeb5283d Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:01:13 -0500 Subject: [PATCH 5/9] Update docs/openapi/components/schemas/common/MinesActPermit.yml Co-authored-by: Ted Thibodeau Jr --- docs/openapi/components/schemas/common/MinesActPermit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/MinesActPermit.yml index 2875e000c..d7dbb8ce2 100644 --- a/docs/openapi/components/schemas/common/MinesActPermit.yml +++ b/docs/openapi/components/schemas/common/MinesActPermit.yml @@ -124,7 +124,7 @@ properties: tsf_operating_count: title: TSF Operating Count description: >- - Numerical value for the total number of tailing storage facilities that are in Operating status. + Numeric value for the total number of tailing storage facilities that are in Operating status. type: string $linkedData: term: tsf_operating_count From e70b4550bf9b85eced594c036f4ff2a99db034bd Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:01:20 -0500 Subject: [PATCH 6/9] Update docs/openapi/components/schemas/common/MinesActPermit.yml Co-authored-by: Ted Thibodeau Jr --- docs/openapi/components/schemas/common/MinesActPermit.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/MinesActPermit.yml index d7dbb8ce2..d701276f5 100644 --- a/docs/openapi/components/schemas/common/MinesActPermit.yml +++ b/docs/openapi/components/schemas/common/MinesActPermit.yml @@ -132,7 +132,7 @@ properties: tsf_care_and_maintenance_count: title: TSF Maintenance Count description: >- - Numerical value for the total number of tailing storage facilities that are in Care and Maintenance status. + Numeric value for the total number of tailing storage facilities that are in Care and Maintenance status. type: string $linkedData: term: tsf_care_and_maintenance_count From 0d916cfbc70f9051deb9e977b559517fe6f28487 Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Thu, 28 Mar 2024 00:46:27 -0400 Subject: [PATCH 7/9] Update and rename MinesActPermitCredential.yml to BcMinesActPermitCredential.yml --- ...ial.yml => BcMinesActPermitCredential.yml} | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) rename docs/openapi/components/schemas/credentials/{MinesActPermitCredential.yml => BcMinesActPermitCredential.yml} (77%) diff --git a/docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml b/docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml similarity index 77% rename from docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml rename to docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml index 4de006e89..8ba8a205d 100644 --- a/docs/openapi/components/schemas/credentials/MinesActPermitCredential.yml +++ b/docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml @@ -1,6 +1,6 @@ $linkedData: - term: MinesActPermitCredential - '@id': https://w3id.org/traceability#MinesActPermitCredential + term: BcMinesActPermitCredential + '@id': https://w3id.org/traceability#BcMinesActPermitCredential title: Mines Act Permit Credential tags: - Other @@ -33,15 +33,15 @@ properties: readOnly: true default: - VerifiableCredential - - MinesActPermitCredential + - BcMinesActPermitCredential const: - VerifiableCredential - - MinesActPermitCredential + - BcMinesActPermitCredential items: type: string enum: - VerifiableCredential - - MinesActPermitCredential + - BcMinesActPermitCredential id: type: string format: uri @@ -134,33 +134,33 @@ example: |- "https://www.w3.org/2018/credentials/v1", "https://w3id.org/traceability/v1" ], - "id": "", + "id": "urn:uuid:be25073a-bc22-4877-aa2d-c46e2f168f6d", "type": [ "VerifiableCredential", - "MinesActPermitCredential" + "BcMinesActPermitCredential" ], - "issuanceDate": "", + "issuanceDate": "2020-07-02T00:00:00Z", "issuer": { - "id": "" + "id": "did:web:traceability.interop.vonx.io" }, "credentialSubject": { "type": [ - "MinesActPermit" + "BcMinesActPermit" ], - "permit_no": "", - "permit_status": "", - "permittee_name": "", - "mine_operation_status": "", - "mine_operation_status_reason": "", - "mine_operation_status_sub_reason": "", - "mine_commodity": "", - "mine_disturbance": "", - "mine_no": "", - "issue_date": "", - "latitude": "", - "longitude": "", - "bond_total": "", - "tsf_operating_count": "", - "tsf_care_and_maintenance_count": "" + "permit_no": "MX-1-842", + "permit_status": "Open", + "permittee_name": "Pretium Resources Inc.", + "mine_operation_status": "Operating", + "mine_operation_status_reason": "Year-Round", + "mine_operation_status_sub_reason": "None", + "mine_commodity": "None", + "mine_disturbance": "None", + "mine_no": "0100270", + "issue_date": "2020-07-02", + "latitude": "56.4653316", + "longitude": "longitude", + "bond_total": "100000.00", + "tsf_operating_count": "2", + "tsf_care_and_maintenance_count": "0" } - } \ No newline at end of file + } From 794a79816b5ae27e0a0fd2c3953c7fe9764c9cc6 Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Thu, 28 Mar 2024 00:47:04 -0400 Subject: [PATCH 8/9] Update BcMinesActPermitCredential.yml --- .../schemas/credentials/BcMinesActPermitCredential.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml b/docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml index 8ba8a205d..641593c76 100644 --- a/docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml +++ b/docs/openapi/components/schemas/credentials/BcMinesActPermitCredential.yml @@ -1,7 +1,7 @@ $linkedData: term: BcMinesActPermitCredential '@id': https://w3id.org/traceability#BcMinesActPermitCredential -title: Mines Act Permit Credential +title: BC Mines Act Permit Credential tags: - Other description: | @@ -62,7 +62,7 @@ properties: items: type: string enum: - - MinesActPermit + - BcMinesActPermit permit_no: title: Permit Number type: string From b7748726aad163df978b7bc13039845c8ae9f857 Mon Sep 17 00:00:00 2001 From: Patrick St-Louis <43082425+PatStLouis@users.noreply.github.com> Date: Thu, 28 Mar 2024 00:48:46 -0400 Subject: [PATCH 9/9] Update and rename MinesActPermit.yml to BcMinesActPermit.yml --- ...inesActPermit.yml => BcMinesActPermit.yml} | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) rename docs/openapi/components/schemas/common/{MinesActPermit.yml => BcMinesActPermit.yml} (89%) diff --git a/docs/openapi/components/schemas/common/MinesActPermit.yml b/docs/openapi/components/schemas/common/BcMinesActPermit.yml similarity index 89% rename from docs/openapi/components/schemas/common/MinesActPermit.yml rename to docs/openapi/components/schemas/common/BcMinesActPermit.yml index d701276f5..16fe15cef 100644 --- a/docs/openapi/components/schemas/common/MinesActPermit.yml +++ b/docs/openapi/components/schemas/common/BcMinesActPermit.yml @@ -1,7 +1,7 @@ --- $linkedData: - term: MinesActPermit - '@id': https://w3id.org/traceability#MinesActPermit + term: BcMinesActPermit + '@id': https://w3id.org/traceability#BcMinesActPermit title: Mines Act Permit description: The Mines Act regulates mining activities in British Columbia (B.C.) - from early exploration to development, production, reclamation, closure, and post-closure. A permit must be in place before any work in, on, or about a mine can occur. A B.C. Mines Act Permit credential issued according to this Governance Framework (GF) provides evidence the credential holder has been issued a B.C. Mines Act Permit. type: object @@ -10,13 +10,13 @@ properties: type: array readOnly: true const: - - MinesActPermit + - BcMinesActPermit default: - - MinesActPermit + - BcMinesActPermit items: type: string enum: - - MinesActPermit + - BcMinesActPermit permit_no: title: Permit Number description: >- @@ -157,21 +157,21 @@ required: example: |- { "type": [ - "MinesActPermit" + "BcMinesActPermit" ], - "permit_no": "", - "permit_status": "", - "permittee_name": "", - "mine_operation_status": "", - "mine_operation_status_reason": "", - "mine_operation_status_sub_reason": "", - "mine_commodity": "", - "mine_disturbance": "", - "mine_no": "", - "issue_date": "", - "latitude": "", - "longitude": "", - "bond_total": "", - "tsf_operating_count": "", - "tsf_care_and_maintenance_count": "" + "permit_no": "MX-1-842", + "permit_status": "Open", + "permittee_name": "Pretium Resources Inc.", + "mine_operation_status": "Operating", + "mine_operation_status_reason": "Year-Round", + "mine_operation_status_sub_reason": "None", + "mine_commodity": "None", + "mine_disturbance": "None", + "mine_no": "0100270", + "issue_date": "2020-07-02", + "latitude": "56.4653316", + "longitude": "longitude", + "bond_total": "100000.00", + "tsf_operating_count": "2", + "tsf_care_and_maintenance_count": "0" }