Skip to content

Commit 7c47ccf

Browse files
jujagajujaga
committed
refactor: refine terminology 'record' to 'asset' across documentation
Signed-off-by: Jeremy Ho <jujaga@gmail.com>
1 parent 751db1a commit 7c47ccf

7 files changed

Lines changed: 37 additions & 29 deletions

File tree

‎docs/spec/code_system/asset_kind.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ Official URL: `https://bcgov.github.io/nr-pies/docs/spec/code_system/asset_kind`
1313

1414
This Code System is used or referenced by:
1515

16+
- Element Definition: [Anchor](/docs/spec/element/resource/anchor)
1617
- Element Definition: [Asset](/docs/spec/element/data/asset)
18+
- Element Definition: [Permit](/docs/spec/element/resource/permit)
19+
- Element Definition: [Project](/docs/spec/element/resource/project)
1720
- Value Set: [TBD](.)
1821

1922
## Definition
2023

21-
The purpose of Asset Kind is to declare the type of contents present in the asset.
24+
The purpose of Asset Kind is to declare the type of the asset.
2225

2326
## Content
2427

@@ -28,10 +31,10 @@ Not Applicable
2831

2932
### Concepts
3033

31-
| Code | Display | Description |
32-
| --------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
33-
| `ANCHOR` | Anchor | The record message represents a foundational reference point. |
34-
| `PERMIT` | Permit | The record message represents a permit resource, containing on hold period information and process event history. |
35-
| `PROJECT` | Project | The record message represents a grouping or collection of related records. |
34+
| Code | Display | Description |
35+
| --------- | ------- | ----------------------------------------------------------------------------------------------- |
36+
| `ANCHOR` | Anchor | The asset represents a foundational reference point. |
37+
| `PERMIT` | Permit | The asset represents a permit, containing on hold period information and process event history. |
38+
| `PROJECT` | Project | The asset represents a grouping or collection of related assets. |
3639

3740
## Errata

‎docs/spec/code_system/message_kind.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ Official URL: `https://bcgov.github.io/nr-pies/docs/spec/code_system/message_kin
1313

1414
This Code System is used or referenced by:
1515

16+
- Element Definition: [Group](.)
1617
- Element Definition: [Header](/docs/spec/element/data/header)
18+
- Element Definition: [Linkage](.)
19+
- Element Definition: [Record](/docs/spec/element/message/record)
20+
- Value Set: [TBD](.)
1721

1822
## Definition
1923

‎docs/spec/code_system/relation_kind.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Not Applicable
2727

2828
### Concepts
2929

30-
| Code | Display | Description |
31-
| --------- | ------- | ------------------------------------------------------------------------------------ |
32-
| `MERGES` | Merges | The linkage relation represents the combination of two or more records into one. |
33-
| `RELATES` | Relates | The linkage relation represents a relationship between two records. |
34-
| `SELF` | Self | The linkage relation represents another aspect or facet of the record itself. |
35-
| `SPLITS` | Splits | The linkage relation represents the division of one record into two or more records. |
30+
| Code | Display | Description |
31+
| --------- | ------- | ---------------------------------------------------------------------------------- |
32+
| `MERGES` | Merges | The linkage relation represents the combination of two or more assets into one. |
33+
| `RELATES` | Relates | The linkage relation represents a relationship between two assets. |
34+
| `SELF` | Self | The linkage relation represents another aspect or facet of the asset itself. |
35+
| `SPLITS` | Splits | The linkage relation represents the division of one asset into two or more assets. |
3636

3737
## Errata

‎docs/spec/element/data/asset.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ This data structure is not intended for standalone use.
3131

3232
## Structure
3333

34-
| Name | Cardinality | Type | Description & Constraints |
35-
| ----------- | ----------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36-
| asset_id | 1..1 | `string` | The asset or primary key representing what the data this message is directly associated to. |
37-
| asset_kind | 1..1 | [Code](./code) | A valid [Asset Kind](/docs/spec/code_system/asset_kind) code that specifies the precise type of asset contained in this message. |
38-
| system_id | 1..1 | [Code](./code) | A valid [CSNR IT Service Management](https://apps.nrs.gov.bc.ca/int/jira/secure/ObjectSchema.jspa?id=1&typeId=5) code which identifies the source system, service or asset that the data originates from. |
39-
| record_id | 1..1 | `string` | The record or primary key representing what the data this message is directly associated to. |
40-
| record_kind | 1..1 | `string` | The kind of record the source system stores this record as (for example, Anchor or Permit). |
34+
| Name | Cardinality | Type | Description & Constraints |
35+
| ----------- | ----------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36+
| asset_id | 1..1 | `string` | The asset or primary key representing what the data this message is directly associated to. |
37+
| asset_kind | 1..1 | [Code](./code) | A valid [Asset Kind](/docs/spec/code_system/asset_kind) code that specifies the precise type of asset contained in this message. |
38+
| system_id | 1..1 | [Code](./code) | A valid [CSNR IT Service Management](https://apps.nrs.gov.bc.ca/int/jira/secure/ObjectSchema.jspa?id=1&typeId=5) code which identifies the source system or service that the data originates from. |
39+
| record_id | 1..1 | `string` | The record or primary key representing what the data this message is directly associated to. |
40+
| record_kind | 1..1 | `string` | The kind of record the source system stores this record as (for example, Anchor or Permit). |
4141

4242
## Specification
4343

‎docs/spec/element/data/asset.schema.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
},
1717
"system_id": {
1818
"type": "string",
19-
"description": "A valid CSNR IT Service Management code which identifies the source system, service or asset that the data originates from.",
19+
"description": "A valid CSNR IT Service Management code which identifies the source system or service that the data originates from.",
2020
"pattern": "^ITSM-\\d{4,5}$"
2121
},
2222
"record_id": {
@@ -25,7 +25,7 @@
2525
},
2626
"record_kind": {
2727
"type": "string",
28-
"description": "The kind of record the source system stores this record as (for example, Anchor, Permit or Project).",
28+
"description": "The kind of record the source system stores this record as (for example, Anchor or Permit).",
2929
"enum": ["Anchor", "Permit"]
3030
}
3131
},

‎docs/spec/element/message/record.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -132,21 +132,21 @@ message provides the full transactional state. Recipient systems should request
132132

133133
When generating a Record message, use `asset_kind` to select the appropriate resource type:
134134

135-
Use asset_kind `ANCHOR` when the message is a reference point without state:
135+
Use asset_kind `ANCHOR` when the message is a reference point without state, for instance:
136136

137137
- Establishing a baseline or foundational record
138138
- Registering a record for future association
139139
- Signaling record existence without process or hold context
140140

141-
Use asset_kind `PERMIT` when the message carries process or hold state:
141+
Use asset_kind `PERMIT` when the message carries a permit's state, for instance:
142142

143143
- Sharing a permit's journey through an application workflow
144144
- Conveying hold periods and reasons for review delays
145145
- Providing an auditable event history
146146

147-
Use asset_kind `PROJECT` when the message is describing a grouping of related records:
147+
Use asset_kind `PROJECT` when the message is describing a grouping of related assets, for instance:
148148

149-
- Defining a project that encompasses multiple related records
149+
- Defining a project that encompasses multiple related assets
150150

151151
## References
152152

‎docs/spec/element/resource/project.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,14 @@ Official URL: `https://bcgov.github.io/nr-pies/docs/spec/element/resource/projec
2121

2222
JSON Schema URL: https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/resource/project.schema.json
2323

24-
Represents a project. A project serves as a grouping of related records within the PIES system.
24+
Represents a project. A project serves as a grouping of related assets within the PIES system.
2525

2626
## Scope
2727

28-
This resource type is transmitted within a Record message by setting `asset_kind` to `PROJECT`. It is designed to
29-
describe the properties of the grouping of related records within the PIES system. This is typically framed from the
30-
perspective of the system that is transmitting the project record, and may not reflect the perspective of other systems.
28+
This resource type is transmitted within a [Record](/docs/spec/element/message/record) message by setting `asset_kind`
29+
to `PROJECT`. It is designed to describe the properties of the grouping of related assets within the PIES system. This
30+
is typically framed from the perspective of the system that is declaring the asset, and may not reflect the perspective
31+
of other systems.
3132

3233
Refer to [Record](/docs/spec/element/message/record) for details on the message envelope pattern and how resource types
3334
are selected.

0 commit comments

Comments
 (0)