ucoProject / UCO

This repository is for development of the Unified Cyber Ontology.
Apache License 2.0
79 stars 34 forks source link

observable:creationTime is ambiguous, possibly redundant, with observable:observableCreatedTime #508

Closed ajnelson-nist closed 1 year ago

ajnelson-nist commented 1 year ago

Bug description

The property observable:creationTime is used in the class observable:WindowsThreadFacet. This property has no relevant documentation rdfs:comment string.

Everywhere else a creation timestamp is mentioned, the property is observable:observableCreatedTime. This has been the case since UCO 0.6.0, when observable:createdTime was disambiguated from core:createdTime.

Should the property in use be deprecated and replaced with observable:observableCreatedTime? On assumption the answer is yes, this Issue proposes deprecating and removing the property.

Requirements

Requirement 1

Risk / Benefit analysis

Benefits

Risks

Competencies demonstrated

Competency 1

A user wishes to transcribe a creation timestamp from some observable object in their data model.

Competency Question 1.1

What is the creation timestamp to use within the observable namespace?

Result 1.1

The general observable:observableCreatedTime, defined in UCO 0.6.0.

Solution suggestion

observable:creationTime-deprecation-shape
    a sh:NodeShape ;
    sh:property [
        a sh:PropertyShape ;
        sh:maxCount 0 ;
        sh:message "observable:creationTime is deprecated, and will be an error to use in UCO 2.0.0.  observable:observableCreatedTime should be used instead."@en ;
        sh:severity sh:Warning ;
        sh:path observable:creationTime ;
    ] ;
    sh:targetSubjectsOf observable:creationTime ;
    .

Coordination

sbarnum commented 1 year ago

I support this CP. It does look like observable:creationTime slipped through the cracks when we normalized on observable:observableCreatedTime