Revised PR to publish PROMCODE machine readable files by tomkamimura · Pull Request #306 · oslc-op/website

tomkamimura · 2022-01-21T02:35:34Z

The stage of each file has been corrected.

berezovskyi · 2022-01-27T16:31:27Z

Thank you @tomkamimura. May I ask if you ran ShapeChecker and if it produced any output? What flags did you use so that I can reproduce?

berezovskyi · 2022-01-27T16:31:48Z

CC @jamsden so that he gets notifications for this PR.

berezovskyi · 2022-02-03T18:00:58Z

ShapeCheck report:

Report

Results from ShapeChecker run on Thu Feb 03 18:55:44 CET 2022

Command line arguments:
   -t Warning -C -q undefinedShape -q unusedVocabulary -x http://open-services.net/ns/core -x
   http://open-services.net/ns/core#.* -x http://open-services.net/ns/promcode# -x
   http://open-services.net/ns/promcode##.* -v
   /Users/ezandbe/git/a/oslc/op/open-services/website/content/ns/promcode/promcode-vocab.ttl -s
   /Users/ezandbe/git/a/oslc/op/open-services/website/content/ns/promcode/promcode-shapes.ttl

A total of 55 issues were found (0 info, 48 warnings, 7 errors)

Checked vocabulary http://open-services.net/ns/promcode# from file:/Users/ezandbe/git/a/oslc/op/open-services/website/content/ns/promcode/promcode-vocab.ttl, with 33 issues (0 info, 33 warnings, 0 errors)
   While examining vocabulary term http://open-services.net/ns/promcode#raisedBy:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value raisedBy is a relation between an Issue resource and ManagedItem resources.
An Issue may be raised by one or more ManagedItem resources.)
   While examining vocabulary term http://open-services.net/ns/promcode#stateOfIssue:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value stateOfIssue is a relation between an Issue resource and a State resource.
The State resource defines a set of values which represent the state of an issue resource.)
   While examining vocabulary term http://open-services.net/ns/promcode#unitOfScopeItemSize:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value unitOfScopeItemSize is a relation between a Project resource and a Unit resource.
It defines a unit of size which all the ScopeItem resources refer to in the project. )
   While examining vocabulary term http://open-services.net/ns/promcode#representedBy:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value representedBy is a relation between a WorkItem resource and a person in charge.
A work item may be represented by a person who acts as the contact for the work item.
This person is responsible for the progress of the work described by the WorkItem resource.
This person may or may not actually do the required work.)
   While examining vocabulary term http://open-services.net/ns/promcode#metricOfMeasure:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value metricOfMeasure is a relation between a Measure resource and a Metric resource.
It defines a metric of Measure. )
   While examining vocabulary term http://open-services.net/ns/promcode#Risk:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value Risk is a subclass of ManagedItem. A Risk resource represents a potential problem that must be controlled in order to meet the objectives of a project. Shared risks between an acquirer and a supplier must be managed.
Internal risks which must be resolved by a supplier alone may not be shared.
Failure to control the potential problem may result in negative
consequences for the project, such as a schedule delay.)
   While examining vocabulary term http://open-services.net/ns/promcode#identifiedDate:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value identifiedDate is an optional property of a Risk resource.
It is the identified date of the Risk resource.
Its value is a dateTime.)
   While examining vocabulary term http://open-services.net/ns/promcode#plannedEndDate:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value plannedEndDate is either a property of a WorkItem resource or a Project resource.
It is the planned end date of the work described by the WorkItem resource or of the project described by the Project resource.
Its value is a dateTime.)
   While examining vocabulary term http://open-services.net/ns/promcode#collects:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value collects is a relation between a ManagedItemCollection resource and ManagedItem resources.
A Plan resource and a Report resource collect any combination of resources of ScopeItem, WorkItem and Artifact.
An IssueCollection resource collects only Issue resources and a RiskCollection collects only Risk resources.)
   While examining vocabulary term http://open-services.net/ns/promcode#ManagedItemCollection:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value A ManagedItemCollection resource is a collection of ManagedItem resources of a specific interest.
A resource in the collection can be a resource of any subclass of ManagedItems, that is, ScopeItem, WorkItem, Artifact, Issue, or Risk.
ManagedItemCollection has four concrete subclasses which are Plan, Report, IssueCollection, and RiskCollection.
A ManagedItemCollection resource is linked to a Project resource it belongs to. )
   While examining vocabulary term http://open-services.net/ns/promcode#observes:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value observes is a relation between a Measurement resource and a Measure resource.
One Measurement observes zero or many Measures.)
   While examining vocabulary term http://open-services.net/ns/promcode#Report:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value A Report resource represents a project status information reported by a supplier to an acquirer at agreed timing as a project report.
It is a ManagedItemCollection resource that collects ScopeItem resources, WorkItem resources, and Artifact resources whose properties are reported in the report.
It is also linked to Measurement resources that represent the quality data of the Artifact resources collected in the ManagedItemCollection resource. )
   While examining vocabulary term http://open-services.net/ns/promcode#identifiedBy:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value identifiedBy is a relation between a Risk resource and ManagedItem resources.
A Risk may be identified by one or more ManagedItem resources.)
   While examining vocabulary term http://open-services.net/ns/promcode#Plan:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value A Plan resource is a collection of ScopeItem resources, WorkItem resources and Artifact resources with associated Measure resources. A Plan resource represents a project plan that is agreed on between an acquirer and a supplier at project initiation.
	Plan is a subclass of ManagedItemCollection. )
   While examining vocabulary term http://open-services.net/ns/promcode#plannedStartDate:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value plannedStartDate is either a property of a WorkItem resource or of a Project resource.
It is the planned start date of the work described by the WorkItem resource or of the project described by the Project resource.
Its value is a dateTime.)
   While examining vocabulary term http://open-services.net/ns/promcode#raisedDate:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value raisedDate is an optional property of an Issue resource.
It is the raised date of the Issue resource.
Its value is a dateTime.)
   While examining vocabulary term http://open-services.net/ns/promcode#unitOfMeasure:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value unitOfMeasure is a relation between a Measure resource and a Unit resource.
It is a unit of volume.
If an acquirer sums up the same type of measures in a report, the value should be converted according to the unit.)
   While examining vocabulary term http://open-services.net/ns/promcode#RiskCollection:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value RiskCollection is a subclass of ManagedItemCollection. A RiskCollection resource is a collection, or a snapshot of shared risks.
Shared risks of resolved status continue to be included in the collection.
Only Risk resources can be collected in a RiskCollection resource.
Examples are a collection of all Risk resources of the project on a specific date, a collection of Risk resources of some category, such as certain status, certain priority, related ScopeItem, and so on.)
   While examining vocabulary term http://open-services.net/ns/promcode#isPartOf:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value isPartOf is a relation between a resource of type Artifact, ScopeItem or WorkItem and other resources of the same type.
It represents the parent and child relationship of ManagedItem resources of the same type.)
   While examining vocabulary term http://open-services.net/ns/promcode#IssueCollection:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value IssueCollection is a subclass of ManagedItemCollection. An IssueCollection resource is a collection of Issue resources. Once an Issue resource is collected, it continues to be included in the collection regardless of its state value.
Depending on the situation, a collection may collect all Issues resources to be shared in the project on a specific date, or it may collect only certain Issues resources of some categories, such as certain status, priority, those related to a ScopeItem resource, and so on.)
   While examining vocabulary term http://open-services.net/ns/promcode#Measure:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value A Measure resource represents an observation of some measurable aspect of an Artifact. )
   While examining vocabulary term http://open-services.net/ns/promcode#measures:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value measures is a relation between a Measurement resource and an Artifact resource.
A Measurement measures an Artifact.)
   While examining vocabulary term http://open-services.net/ns/promcode#actualStartDate:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value actualStartDate is  either a property of a WorkItem resource or a Project resource.
It is the actual start date of the work described by the WorkItem resource or of the project described by the Project resource.
Its value is a dateTime.)
   While examining vocabulary term http://open-services.net/ns/promcode#ScopeItem:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value ScopeItem is a subclass of ManagedItem. A ScopeItem resource defines the scope of the work to be included in a project.
It defines the binding between an acquirer and a supplier for the project.)
   While examining vocabulary term http://open-services.net/ns/promcode#metricOfScopeItemSize:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value metricOfScopeItemSize is a relation between a Project resource and a Metric resource.
It defines a metric of the size which all the ScopeItem resources in the project refer to. )
   While examining vocabulary term http://open-services.net/ns/promcode#WorkItem:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value WorkItem is a subclass of ManagedItem. A WorkItem resource describes the work to be performed in a contract.
It defines the work to be performed to create a (part of) content described by a ScopeItem.
The work may typically include cost, schedule, and resource requirements.
The set of all WorkItem resources in a project might form a work breakdown structure.)
   While examining vocabulary term http://open-services.net/ns/promcode#Issue:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value Issue is a subclass of ManagedItem. An Issue resource represents a situation that must be resolved in order to meet the objectives
of a project. Issue resources shared between an acquirer and a supplier must be managed.
Internal issues which must be resolved by a supplier alone may not be shared.
Failure to resolve the situation may result in negative
consequences for the project, such as a schedule delay.)
   While examining vocabulary term http://open-services.net/ns/promcode#correspondsTo:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value correspondsTo is a relation between a Plan resource and a Report resource.
	A Report resource has at most one correspondsTo relation to a Plan resource.
If a new Plan resource is created, a Report resource may need to be related to the new Plan resource.)
   While examining vocabulary term http://open-services.net/ns/promcode#stateOfRisk:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value stateOfRisk is a relation between a Risk resource and a State resource.
The State resource defines a set of values which represent the state of a Risk resource.)
   While examining vocabulary term http://open-services.net/ns/promcode#belongsTo:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value belongsTo is a relation between ManagedItemCollections and a Project resource.
An acquirer and a supplier may operate multiple projects in parallel.
This relation is used to identify which collection belongs to which project.)
   While examining vocabulary term http://open-services.net/ns/promcode#Project:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: The description or comment should end with a period (full stop). (bad value A Project resource represents the information on the project including the name of the project, the descriptions of the project, and start and end dates, both planned and actual, of the project.
A Project resource also specifies the metric and the unit of size of ScopeItem resources, each of which is unique in the project. )
   While examining vocabulary term http://open-services.net/ns/promcode#producedFor:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value producedFor is a relation between an Artifact resource and a ScopeItem resource or a WorkItem resource.
Artifact resources are produced as deliverables of the scope defined by a ScopeItem resource or the result of implementing the work described by a WorkItem resource.)
   While examining vocabulary term http://open-services.net/ns/promcode#requiredBy:
      Warning on http://www.w3.org/2000/01/rdf-schema#comment: White space after embedded newline - misuse of triple quotes? (bad value requiredBy is a relation either between a WorkItem resource and an Artifact resource, or between a WorkItem resource and a ScopeItem resource.
A WorkItem resource, such as reviewing the design, is required for producing an Artifact resource such as a review record.
A WorkItem resource may also be required to implement the scope described by a ScopeItem resource.)

Checked shapes from file:/Users/ezandbe/git/a/oslc/op/open-services/website/content/ns/promcode/promcode-shapes.ttl, with 22 issues (0 info, 15 warnings, 7 errors)
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#ManagedItemCollection:
      While examining property definition belongsTo:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>belongsTo</code> is a relation between the <code>ManagedItemCollection</code> resource and a <code>Project</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Risk:
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for a <code>Risk</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#IssueCollection:
      While examining property definition belongsTo:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>belongsTo</code> is a relation between the <code>IssueCollection</code> resource and a <code>Project</code> resource. An acquirer and a supplier may have multiple projects in operation. The Project resource linked is used to identify the project this <code>IssueCollection</code> resource belongs to. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Measure:
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for the <code>Measure</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Measurement:
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for the <code>Measurement</code> resource. )
      While examining property definition date:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>date</code> is a property of a <code>Measurement</code> resource. It is the date on which the measurement was made.  )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#ScopeItem:
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for a <code>ScopeItem</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Artifact:
      While examining property definition isPartOf:
         Error on http://purl.org/dc/terms/isPartOf: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotException: [line: 3, col: 12] Triples not terminated by DOT)
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Project:
      Error on http://open-services.net/ns/promcode#Project: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotNotFoundException: Not found: http://open-services.net/ns/promcode)
      While examining property definition description:
         Error on http://purl.org/dc/terms/description: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotException: [line: 3, col: 12] Triples not terminated by DOT)
      While examining property definition unitOfScopeItemSize:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>unitOfScopeItemSize</code> is a property that describes a unit of size of properties of <code>plannedSize.</code> and <code>actualSize</code> of <code>ScopeItem</code>.  The value can be any resource, but it is expected to have information on the desired unit of size, describing whether the metric is a rate, a ratio, a quantity, a time, and so on for all the <code>ScopeItem</code> resources in the project. )
      While examining property definition identifier:
         Error on http://purl.org/dc/terms/identifier: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotException: [line: 3, col: 12] Triples not terminated by DOT)
      While examining property definition source:
         Error on http://purl.org/dc/terms/source: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotException: [line: 3, col: 12] Triples not terminated by DOT)
      While examining property definition title:
         Error on http://purl.org/dc/terms/title: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotException: [line: 3, col: 12] Triples not terminated by DOT)
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Issue:
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for the <code>Issue</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#WorkItem:
      Warning on http://open-services.net/ns/core#name: This property is unexpected. (bad value WorkItem)
      While examining property definition representedBy:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>representedBy</code> is a relation between the <code>WorkItem</code> resource and a resource that represents a person responsible for the progress of the work described by this resource. The value is any resource, but is expected to describe a person such as a <code>foaf:Person</code> resource. )
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for the <code>WorkItem</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#ManagedItem:
      While examining property definition identifier:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value A unique identifier for a <code>ManagedItem</code> resource. )
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Report:
      While examining property definition belongsTo:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>belongsTo</code> is a relation between this <code>Report</code> resource and a <code>Project</code> resources. )
      While examining property definition date:
         Error on http://purl.org/dc/terms/date: The target resource cannot be fetched or parsed as RDF. (bad value org.apache.jena.riot.RiotException: [line: 3, col: 12] Triples not terminated by DOT)
   While examining resource shape http://open-services.net/ns/promcode/shapes/1.0#Plan:
      While examining property definition belongsTo:
         Warning on http://purl.org/dc/terms/description: The description or comment should end with a period (full stop). (bad value <code>belongsTo</code> is a relation between a <code>Plan</code> resource and a <code>Project</code> resource. )

berezovskyi · 2022-02-03T19:22:32Z

@tomkamimura thank you for the PR. All looks good from my side with the validity of the RDF, please see comments about the metadata inside.

@jamsden I think we can go ahead with the PR. ShapeChecker produces warnings on multiline strings, but those are not errors. Errors are raised on http://purl.org/dc/terms/, which is the correct namespace but does not provide RDF via conneg.

@ndjc Nick, if you could refresh my memory on how we dealt with incorrect dcterms namespace redirects, I would be very thankful!

berezovskyi · 2022-02-03T19:23:45Z

+	dcterms:source <https://tools.oasis-open.org/version-control/browse/wsvn/oslc-promcode/shape/trunk/promcode-vocab.ttl> ;
+	dcterms:hasVersion "CS02" ;
+	dcterms:issued "2021-03-23"^^<http://www.w3.org/2001/XMLSchema#date> ;
+	dcterms:isPartOf <https://tools.oasis-open.org/version-control/browse/wsvn/oslc-promcode/shape/trunk/spec.html> ;


Should it be https://docs.oasis-open.org/oslc-promcode/promcode/v1.0/cs02/promcode-spec.html?