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

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

Closed
13 tasks done
ajnelson-nist opened this issue Nov 28, 2022 · 1 comment · Fixed by #511, #512 or #518
Closed
13 tasks done

Comments

@ajnelson-nist
Copy link
Contributor

ajnelson-nist commented Nov 28, 2022

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

  • UCO should consolidate creation time properties that do not distinguish in purpose between one another.

Risk / Benefit analysis

Benefits

  • Removes ambiguity for UCO producers and consumers in how to represent observable creation times.

Risks

  • observable:creationTime would be deprecated, and removed in UCO 2.0.0. UCO has not yet, at the time of this writing, deprecated a property, though a plan has been laid out to do so in Issue 493.

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

  • Assign observable:creationTime the additional type owl:DeprecatedProperty.
  • Add a shape to warn against the property's usage, from UCO 1.2.0 to UCO 2.0.0:
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 ;
	.
  • Remove the sh:severity sh:Warning statement in UCO 2.0.0.
  • Add a shape duplicating the current observable:creationTime PropertyShape on observable:WindowsThreadFacet, except substituting observable:observableCreatedTime.
  • Retain the observable:creationTime PropertyShape on observable:WindowsThreadFacet, as-is, for now. Delete in 2.0.0.

Coordination

  • Tracking in Jira ticket OC-284
  • Administrative review completed, proposal announced to Ontology Committees (OCs) on 2022-11-29
  • Requirements to be discussed in OC meeting, 2022-12-08
  • Requirements Review vote occurred, passing, on 2022-02-08
  • Requirements development phase completed.
  • Solution announced to OCs on 2023-01-17
  • Solutions Approval to be discussed in OC meeting, 2023-01-26
  • Solutions Approval vote occurred, passing, on 2023-01-26
  • Solutions development phase completed.
  • Backwards-compatible implementation merged into develop for the next release
  • develop state with backwards-compatible implementation merged into develop-2.0.0
  • Backwards-incompatible implementation merged into develop-2.0.0
  • Milestone linked
  • Documentation logged in pending release pages
@sbarnum
Copy link
Contributor

sbarnum commented Dec 7, 2022

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

ajnelson-nist added a commit that referenced this issue Jan 6, 2023
A follow-on patch will regenerate Make-managed files.

References:
* #508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit that referenced this issue Jan 6, 2023
References:
* #508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit that referenced this issue Jan 6, 2023
A follow-on patch will regenerate Make-managed files.

References:
* #508

Signed-off-by: Alex Nelson <[email protected]>
@ajnelson-nist ajnelson-nist linked a pull request Jan 6, 2023 that will close this issue
11 tasks
ajnelson-nist added a commit that referenced this issue Jan 6, 2023
References:
* #508

Signed-off-by: Alex Nelson <[email protected]>
@ajnelson-nist ajnelson-nist modified the milestones: UCO 1.x.0, UCO 1.2.0 Jan 6, 2023
ajnelson-nist added a commit to casework/CASE-Archive that referenced this issue Jan 6, 2023
No effects were observed on Make-managed files.

References:
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/CASE-Examples that referenced this issue Jan 6, 2023
No effects were observed on Make-managed files.

References:
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/casework.github.io that referenced this issue Jan 6, 2023
A follow-on patch will regenerate Make-managed files.

References:
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/casework.github.io that referenced this issue Jan 6, 2023
References:
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/CASE-Archive that referenced this issue Jan 6, 2023
No effects were observed on Make-managed files.

References:
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/CASE-Examples that referenced this issue Jan 6, 2023
A follow-on patch will regenerate Make-managed files.

References:
* ucoProject/UCO#493
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/CASE-Examples that referenced this issue Jan 6, 2023
ajnelson-nist added a commit to casework/CASE-Examples that referenced this issue Jan 6, 2023
A follow-on patch will regenerate Make-managed files.

References:
* ucoProject/UCO#493
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/CASE-Examples that referenced this issue Jan 6, 2023
ajnelson-nist added a commit to casework/casework.github.io that referenced this issue Jan 6, 2023
A follow-on patch will regenerate Make-managed files.

References:
* ucoProject/UCO#493
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/casework.github.io that referenced this issue Jan 6, 2023
@ajnelson-nist ajnelson-nist linked a pull request Jan 27, 2023 that will close this issue
4 tasks
ajnelson-nist added a commit to casework/CASE-Utilities-Python that referenced this issue Mar 28, 2023
This patch, normally a brief edit of `version_info.py`, also makes path
updates to the virtual environments that were enacted as part of UCO
Issue 449.  Test updates made for UCO Issue 508 are also forward-ported.

A follow-on patch will regenerate Make-managed files.

References:
* ucoProject/UCO#449
* ucoProject/UCO#508

Signed-off-by: Alex Nelson <[email protected]>
ajnelson-nist added a commit to casework/CASE-Utilities-Python that referenced this issue Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment