Skip to content

oslc-op/oslc-specs

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

OSLC Open Project specifications

CircleCI Discourse status

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.

Quick links

Spec table

Title Description Responsible
Query 3.0 Defines a simple, implementation independent selection and projection query capability. David
Quality Management v2.1 This specification defines the OSLC Quality Management domain, a RESTful web services interface for the management of product, service or software quality artefacts, activities, tasks and relationships between those and related resources such as requirements, defects, change requests or architectural resources. To support these scenarios, this specification defines a set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, content type handling and resource formats. Andrew
Change Management v3.0 This specification defines the OSLC Change Management domain, a RESTful web services interface for the management of product change requests, activities, tasks and relationships between those and related resources such as requirements, test cases, or architectural resources. To support these scenarios, this specification defines a set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, content type handling and resource formats. Jim
Requirements Management v2.1 This specification defines the OSLC Requirements Management domain. The specification supports key RESTful web service interfaces for the management of Requirements, Requirements Collections and supporting resources defined in the OSLC Core specification. To support these scenarios, this specification defines a set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, content type handling and resource formats. Jad
Core 3.0 A collection of specifications that defines the basic patterns, protocols and capabilities of OSLC clients and servers. Jim
Configuration Management 1.0 Domain spec for managing versions and configurations of linked data resources from multiple domains. PSD WIP Nick
Tracked Resource Set 3.0 Allows servers to expose a set of resources whose state can be tracked by clients. WD WIP Nick
AM 2.1 PSD WIP Jim
Automation 2.1 Domain spec for automation of sequences of actions on OSLC resources. Jim
Actions 2.0 TBD. Ian

Project Notes

Title Description Responsible
Summary of changes in OSLC Core 3.0 This note will serve as a guide for existing OSLC 2.0 users to learn what’s new and navigate around the changes in the specifications. David
OSLC Configuration Management Primer This primer serves as a guide to the concepts in the specification, and through the use of simple examples, explains how versioning and configurations are represented, how and when local configurations and global configurations are used, and lists the elements that an implementation should consider. The specification remains the definitive source, and where this primer differs from the specification, the specification should be taken as the authoritative reference. David
TRS 3.0 Primer This primer serves as a guide to the concepts in the TRS specification, and through the use of simple examples, explains how a data provider might expose resources in a TRS and how a TRS client might consume a data provider's TRS. David
TRS Guidance This document contains material for a TRS tutorial - it is fragmented, contains repetition, and is not yet ready for publication. Nick
OSLC Core 3.0 Link Guidance In this informative note we offer advice to OSLC Technical Committees on modeling links and relationships between OSLC resources. Jim

Old specs

Specs that are not actively developed (help needed!):

Title Description Responsible
Asset Management 2.1 WD TBD NA
Performance Monitoring 2.1 WD TBD NA
Estimation and Measurement Service 1.0 WD TBD NA
Reconcilliation 2.0 TBD NA

Getting started

In order to preview the specifications in your local workspace, you should run a local webserver (it is inadvisable to disable the security protections against running AJAX requests on local filesystem). With Python 3 installed:

cd specs/
# if you have JDK 18+ installed
jwebserver
# or, if you have Python 3 installed
python3 -m http.server 8000 --bind 127.0.0.1

Now you can browse all specs via http://localhost:8000/. For an even better experience, install Browsersync (npm i -g browser-sync) and run it the following way:

browser-sync start --config bs-config.js

Now you can browse all specs via http://localhost:8000/. Anytime you save a spec file, every browser tab where this file is opened will be reloaded automatically.

Contributions

Read how to contribute to the OSLC Open Project.

See the call details for instructions how to join our weekly calls.

For this repository particularly, please ensure that your editor respects the Editorconfig settings either by installing a plugin or copying the settings manually. Make sure your lines are wrapped!

Pro tip: Atom editor does all of this automatically when you install an Editorconfig for it. Highly recommended. It works even better in a setup with Browsersync described in the section above.

Warning! Eclipse, VS Code do not support the wrapping configuration setting from Editorconfig. You should manually configure your editor and ensure the lines are wrapped.

Licensing

Please see the LICENSE file for description of the license terms and OASIS policies applicable to the OSLC Open Project work items.