From 2c857a9838161c4acba231002b75eccce0eab1a6 Mon Sep 17 00:00:00 2001 From: Andrew Berezovskyi Date: Thu, 19 Sep 2019 15:58:29 +0200 Subject: [PATCH 1/3] Normative changes to the intro for QM Signed-off-by: Andrew Berezovskyi --- specs/qm/quality-management-spec.html | 114 +++++++++++++++---------- specs/qm/quality-management-vocab.html | 11 +-- 2 files changed, 74 insertions(+), 51 deletions(-) diff --git a/specs/qm/quality-management-spec.html b/specs/qm/quality-management-spec.html index 9ab785e1..285a7f80 100644 --- a/specs/qm/quality-management-spec.html +++ b/specs/qm/quality-management-spec.html @@ -229,14 +229,16 @@
-
-

Introduction

-

This section is non-normative.

+
+

Introduction

+
+

Overview

This specification builds on the OSLC Core Specification to define the resources and operations supported by an Open Services for Lifecycle Collaboration (OSLC) Quality Management (QM) provider.

Quality Management resources define the test plans, test cases, and test results of the software delivery lifecycle. They represent individual resources along with their relationships to other shared resource types such change requests and requirements. The intent of this specification is to define the set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, mime type handling and resource formats. The capabilities of the interface definitions are driven by key integration scenarios and therefore don't represent a complete setup of operations on resources or resource types. The resource formats and operations may not match exactly the native models supported by quality management service providers but are intended to be compatible with them.

A key approach to supporting these scenarios is to delegate operations, as driven by service provider contributed user interfaces, as much as possible and not require a service provider to expose its complete data model and application logic.

+
-
+

Terminology

Terminology is based on OSLC Core Overview [[!OSLCCore3]], W3C Linked Data Platform [[LDP]], @@ -758,10 +760,24 @@

Observations in migration from Version 2.0

Acknowledgements

-

This section is non-normative.

-

The following individuals have participated in the creation of the V2.0 specification and are gratefully acknowledged:

-

Participants:

+

The following individuals have participated in the creation of this specification and are gratefully acknowledged:

+ +

Project Governing Board:

+James Amsden, IBM (co-chair)
+Andrii Berezovskyi, KTH (co-chair)
+Bill Chown, Mentor
+Wesley Coelho, Tasktop
+Axel Reichwein, Koneksys
+

+ +

Techical Steering Committee:

+James Amsden, IBM
+Andrii Berezovskyi, KTH
+Axel Reichwein, Koneksys
+

+ +

OSLC QM 2.0 contributors:

Gray Bachelor (IBM - Editor)
Dave Johnson (IBM)
Ingrid Jorgensen (Tieto)
@@ -774,49 +790,55 @@

Acknowledgements

-

Change History

-

This section is non-normative.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /tr> - - - - - - -
RevisionDateEditorChanges Made
0106/10/2017Gray BachelorInitial migration version.
0226/12/2017Gray BachelorNext edits towards migration version.
0328/06/2018Gray BachelorAlign with released CM 3.0.
0427/07/2018Gray BachelorAlign with RM and Asset 2.1.
0508/08/2018Gray BachelorCheck and fix some V2.1 labelling
+ + + 01 + 06/10/2017 + Gray Bachelor + Initial migration version. + + + 02 + 26/12/2017 + Gray Bachelor + Next edits towards migration version. + + 03 + 28/06/2018 + Gray Bachelor + Align with released CM 3.0. + + + 04 + 27/07/2018 + Gray Bachelor + Align with RM and Asset 2.1. + /tr> + + 05 + 08/08/2018 + Gray Bachelor + Check and fix some V2.1 labelling + + + 06 + 2019-09-19 + Andrew Berezovskyi + Prepare the QM 2.0 PSD 02 for publication + +
diff --git a/specs/qm/quality-management-vocab.html b/specs/qm/quality-management-vocab.html index ec12b948..7f74792c 100644 --- a/specs/qm/quality-management-vocab.html +++ b/specs/qm/quality-management-vocab.html @@ -137,9 +137,11 @@
-
-

Introduction

+
+

Introduction

+
+

Overview

This specification defines a vocabulary and resource shapes for OSLC Quality Management resources. The intent is to define resources needed to support common integration scenarios and not to provide a comprehensive @@ -154,11 +156,10 @@

Introduction

OSLC Quality Management 2.1 resource relationship overview
- - +
-

Terminology

+

Terminology

Terminology is based on OSLC Core Overview [[!OSLCCore3]], W3C Linked Data Platform [[!LDP]], W3C's Architecture of the World Wide Web [[WEBARCH]], Hyper-text Transfer Protocol [[!HTTP11]].

From d8bd4ba1f7424eeb6fe838ef08bdd1ebecfa5eac Mon Sep 17 00:00:00 2001 From: Andrew Berezovskyi Date: Thu, 19 Sep 2019 17:25:08 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b089beb8..6aed8ec2 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,15 @@ This repository is for managing the development of OSLC Open Project specifications including Core 3.0, OSLC Query, Tracked Resource Sets, Configuration Management, and all the various OSLC domain specifications. -| Title | Description |Editor| +| Title | Description |Responsible| |-------|-------------|------| -| [Core 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/core/oslc-core.html) | A collection of specifications that defines the basic patterns, protocols and capabilities of OSLC clients and servers. **PSD WIP** | Jim Amsden | -| [Quality Management 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/qm/quality-management-spec.html) | **PSD WIP** | TBD | -| [Change Management 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/cm/change-mgt-spec.html) | **PSD 02 ready** | Jim Amsden | +| [Change Management 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/cm/change-mgt-spec.html) | **PSD 02 ready** | Andrew | +| [Core 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/core/oslc-core.html) | A collection of specifications that defines the basic patterns, protocols and capabilities of OSLC clients and servers. **PSD WIP** | Jim/Andrew | +| [Quality Management 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/qm/quality-management-spec.html) | **PSD WIP** | Andrew | +| [Requirements Management 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/rm/requirements-management-spec.html) | TBD | Jad/Andrew | +| [Tracked Resource Set 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/trs/tracked-resource-set.html) | Allows servers to expose a set of resources whose state can be tracked by clients. **WD WIP** | Nick | | [Query 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/query/oslc-query.html) | Defines a simple, implementation independent selection and projection query capability. | TBD | -| [Tracked Resource Set 3.0 WD](https://oslc-op.github.io/oslc-specs/specs/trs/tracked-resource-set.html) | Allows servers to expose a set of resources whose state can be tracked by clients. | Nick Crossley | -| [Requirements Management 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/rm/requirements-management-spec.html) | TBD | Jad El-khoury | -| [Configuration Management 1.0 WD](https://oslc-op.github.io/oslc-specs/specs/config/oslc-config-mgt.html) | Domain spec for managing versions and configurations of linked data resources from multiple domains. |Nick Crossley| +| [Configuration Management 1.0 WD](https://oslc-op.github.io/oslc-specs/specs/config/oslc-config-mgt.html) | Domain spec for managing versions and configurations of linked data resources from multiple domains. |Nick| | [Asset Management 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/asset/asset-management-spec.html) | TBD | NA | | [Automation 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/auto/automation-spec.html) | Domain spec for automation of sequences of actions on OSLC resources. | NA | | [Performance Monitoring 2.1 WD](https://oslc-op.github.io/oslc-specs/specs/perfmon/performance-monitoring-spec.html) | TBD | NA | From 11362f8d6835b2150fa54bc84b904810caded341 Mon Sep 17 00:00:00 2001 From: Andrew Berezovskyi Date: Thu, 19 Sep 2019 18:25:13 +0200 Subject: [PATCH 3/3] :hammer_and_wrench: Fix other conformance declarations (#248) quotes shall be straight Signed-off-by: Andrew Berezovskyi --- specs/asset/asset-management-spec.html | 6 +- specs/recon/recon-resource-def.txt | 12 +- specs/recon/reconciliation-spec.html | 220 +++++++++++----------- specs/recon/reconciliation-vocab-2-0.html | 28 +-- 4 files changed, 133 insertions(+), 133 deletions(-) diff --git a/specs/asset/asset-management-spec.html b/specs/asset/asset-management-spec.html index 72638d18..4429d41a 100644 --- a/specs/asset/asset-management-spec.html +++ b/specs/asset/asset-management-spec.html @@ -370,11 +370,11 @@

Base Requirements

Base Compliance

-

This specification is based on [[!OSLCCore3]]. OSLC Asset Management servers +

This specification is based on [[!OSLCCore3]]. OSLC Asset Management servers MUST be compliant with both the core specification, MUST follow all the mandatory requirements in the normative sections of this specification, and SHOULD follow all the guidelines and recommendations in both these specifications.

-

An OSLC Asset Management server MUST implement the domain vocabulary defined in OSLC Asset Management Version 2.1. Part 2: Vocabulary +

An OSLC Asset Management server MUST implement the domain vocabulary defined in OSLC Asset Management Version 2.1. Part 2: Vocabulary

The following table summarizes the requirements from OSLC Core Specification as well as some additional requirements specific to the Asset domain. Note that @@ -1006,4 +1006,4 @@

Change History

- \ No newline at end of file + diff --git a/specs/recon/recon-resource-def.txt b/specs/recon/recon-resource-def.txt index 0017cecb..8196ac0c 100644 --- a/specs/recon/recon-resource-def.txt +++ b/specs/recon/recon-resource-def.txt @@ -1,17 +1,17 @@

Resource Definitions

-

Resources defined by this specification can have properties other than those described here, in any namespace. It +

Resources defined by this specification can have properties other than those described here, in any namespace. It is RECOMMENDED that any additional properties exist in their own unique namespace and not use the namespaces defined in this specification.

-

A list of properties is defined for each type of resource. Most of these properties are identified in A list of properties is defined for each type of resource. Most of these properties are identified in OSLC Core Appendix A: Common Properties and in the Common IT Resource Type vocabulary. Any exceptions are noted. Relationship properties refer to other resources. These resources may be in any OSLC domain (including the Reconciliation domain).

-

For all resource types defined in this specification, all required properties (those defined +

For all resource types defined in this specification, all required properties (those defined with an occurrence of exactly-one or one-or-many) MUST exist for each resource and must be provided when requested. All other properties are optional, and might not exist on some or any resources; those that do not exist will not be present in the returned representation even if @@ -20,14 +20,14 @@ own namespaces for such properties, or use standard Dublin Core or RDF namespaces and properties where appropriate.

-

If no specific set of properties is requested, all properties MUST be returned +

If no specific set of properties is requested, all properties MUST be returned - both those defined in this specification as well as any provider-specific ones. See Selective Property Values in the OSLC Core Specification.

-

Consumers should note that some resources may have a very large number of related resources, and that some +

Consumers should note that some resources may have a very large number of related resources, and that some resources may be very large and/or expensive to compute. For this reason, consumers are strongly RECOMMENDED to use the oslc.properties parameter to limit the properties returned from a request to the subset required. See Selective Property Values - in the OSLC Core Specification.

\ No newline at end of file + in the OSLC Core Specification.

diff --git a/specs/recon/reconciliation-spec.html b/specs/recon/reconciliation-spec.html index e149a305..4d2090aa 100644 --- a/specs/recon/reconciliation-spec.html +++ b/specs/recon/reconciliation-spec.html @@ -264,7 +264,7 @@

Base Requirements

Compliance

-

+

This specification is based on [[!OSLCCore2]]. OSLC Reconciliation domain consumers and service providers MUST be compliant with both the Core specification and this specification, and SHOULD follow all the @@ -278,7 +278,7 @@

Compliance

noted in the Origin column of the compliance table. See further sections in this specification or the OSLC Core Specification to get further details on each of these requirements.

-

Any consumer or service provider behaviors are allowed unless explicitly prohibited by this +

Any consumer or service provider behaviors are allowed unless explicitly prohibited by this or dependent specifications; conditional permissive requirements, especially those qualified with MAY, are implicitly covered by the preceding clause. While technically redundant in light of that broad permission, OSLC @@ -299,10 +299,10 @@

Requirements on OSLC Consumers

Unknown properties and content - MUST + MUST [[!OSLCCore3]] - OSLC clients MUST preserve unknown content + OSLC clients MUST preserve unknown content @@ -321,215 +321,215 @@

Requirements on OSLC Service Pro Unknown properties and content - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY ignore unknown content + OSLC service providers MAY ignore unknown content Unknown properties and content - MUST + MUST [[!OSLCCore3]] - OSLC service providers MUST return an error code if recognized content is invalid. + OSLC service providers MUST return an error code if recognized content is invalid. Unknown properties and content - SHOULD + SHOULD [[!OSLCCore3]] - OSLC service providers SHOULD NOT return an error code for unrecognized content. + OSLC service providers SHOULD NOT return an error code for unrecognized content. Resource Operations - MUST + MUST [[!OSLCCore3]] - OSLC service providers MUST support resource operations via standard HTTP operations + OSLC service providers MUST support resource operations via standard HTTP operations Resource Paging - MAY + MAY [[!OSLCCore3]] - OSLC services MAY provide paging for resources + OSLC services MAY provide paging for resources Partial Resource Representations - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY support HTTP GET requests for retrieval of a subset of a + OSLC service providers MAY support HTTP GET requests for retrieval of a subset of a resource’s properties via the oslc.properties URL parameter Partial Resource Representations - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY support HTTP PUT requests for updating a subset of a + OSLC service providers MAY support HTTP PUT requests for updating a subset of a resource’s properties via the oslc.properties URL parameter Service Provider Resources - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY provide a Service Provider Catalog resource + OSLC service providers MAY provide a Service Provider Catalog resource Service Provider Resources - MUST + MUST [[!OSLCCore3]] - OSLC service providers MUST provide a Service Provider resource + OSLC service providers MUST provide a Service Provider resource Creation Factories - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY provide creation factories to enable resource creation + OSLC service providers MAY provide creation factories to enable resource creation via HTTP POST Query Capabilities - SHOULD1 + SHOULD1 Reconciliation, [[!OSLCCore3]] - OSLC service providers SHOULD provide query capabilities to enable clients to query + OSLC service providers SHOULD provide query capabilities to enable clients to query for resources Query Syntax - MUST2 + MUST2 Reconciliation, [[!OSLCCore3]] - If a service provider supports OSLC query capabilities, the query capabilities MUST + If a service provider supports OSLC query capabilities, the query capabilities MUST support the OSLC Core Query Syntax Query Syntax - MAY + MAY [[!OSLCCore3]] - OSLC query capabilities MAY support other query syntaxes + OSLC query capabilities MAY support other query syntaxes Delegated UI Dialogs - SHOULD + SHOULD [[!OSLCCore3]] - OSLC service providers SHOULD allow clients to discover, via their service provider + OSLC service providers SHOULD allow clients to discover, via their service provider resources, any Delegated UI Dialogs they offer. Delegated UI Dialogs - SHOULD + SHOULD [[!OSLCCore3]] - OSLC service providers SHOULD offer delegated UI dialogs for resource creation + OSLC service providers SHOULD offer delegated UI dialogs for resource creation Delegated UI Dialogs - SHOULD + SHOULD [[!OSLCCore3]] - OSLC service providers SHOULD offer delegated UI dialogs for resource selection + OSLC service providers SHOULD offer delegated UI dialogs for resource selection UI Preview - SHOULD + SHOULD [[!OSLCCore3]] - OSLC Services SHOULD offer UI previews for resources that may be referenced by other + OSLC Services SHOULD offer UI previews for resources that may be referenced by other resources HTTP Basic Authentication - MAY + MAY [[!OSLCCore3]] - OSLC Services MAY support Basic Auth + OSLC Services MAY support Basic Auth HTTP Basic Authentication - SHOULD + SHOULD [[!OSLCCore3]] - OSLC Services SHOULD support Basic Auth only over HTTPS + OSLC Services SHOULD support Basic Auth only over HTTPS OAuth Authentication - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY support OAuth + OSLC service providers MAY support OAuth OAuth Authentication - SHOULD + SHOULD [[!OSLCCore3]] - OSLC service providers that support OAuth SHOULD allow clients to discover the + OSLC service providers that support OAuth SHOULD allow clients to discover the required OAuth URLs via their service provider resource Error Responses - MAY + MAY [[!OSLCCore3]] - OSLC service providers MAY provide error responses using Core-defined error formats + OSLC service providers MAY provide error responses using Core-defined error formats RDF/XML Representations - MUST3 + MUST3 Reconciliation, [[!OSLCCore3]] - OSLC service providers MUST offer an RDF/XML representation for HTTP GET responses + OSLC service providers MUST offer an RDF/XML representation for HTTP GET responses RDF/XML Representations - MUST3 + MUST3 Reconciliation, [[!OSLCCore3]] - OSLC service providers MUST accept RDF/XML representations on PUT requests. + OSLC service providers MUST accept RDF/XML representations on PUT requests. RDF/XML Representations - MUST3 + MUST3 Reconciliation, [[!OSLCCore3]] - RDF/XML representations on POST requests whose semantic intent is to create a new + RDF/XML representations on POST requests whose semantic intent is to create a new resource instance. XML Representations - MAY3 + MAY3 Reconciliation, [[!OSLCCore3]] - OSLC service providers MAY provide a XML representation for HTTP GET, POST and PUT + OSLC service providers MAY provide a XML representation for HTTP GET, POST and PUT requests that conform to the Core Guidelines for XML. JSON Representations - MAY3 + MAY3 Reconciliation, [[!OSLCCore3]] - OSLC service providers MAY provide JSON representations for HTTP GET, POST and PUT + OSLC service providers MAY provide JSON representations for HTTP GET, POST and PUT requests that conform to the Core Guidelines for JSON HTML Representations - SHOULD3 + SHOULD3 Reconciliation, [[!OSLCCore3]] - OSLC service providers SHOULD provide HTML representations for HTTP GET requests + OSLC service providers SHOULD provide HTML representations for HTTP GET requests @@ -585,19 +585,19 @@

Resource Formats

For HTTP GET requests on all OSLC Reconciliation and OSLC Core defined resource types,

- \ No newline at end of file +