Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-013 Access and use conditions

Requirement

Title

Service access and use conditions

Identifier

SWIM-SERV-150

Requirement

A service description shall include or refer to information about the conditions which apply to accessing and using the service, including:

  • legal constraints;
  • service policies; and
  • service consumption constraints.

Rationale

This requirement ensures that a service consumer is aware of any restrictions on the access and use of the service.

It is good practice to share business constraint information associated with the conditions of usage of the service.

Verification

Completeness: Verify that the elements included cover the required constraints and policies.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Example legal constraints:

  • Licenses to be bought;
  • Intellectual property rights to be respected.

Example services policies:

  • Contingency policy;
  • Business policy(s) in terms of business rule or objective i.e. how the business is conducted;
  • Operational policy(s) (i.e. constraints and requirements for how services operate and interoperate at runtime) in terms of rules and guidelines. Operational policies are utility centric (handling operational characteristics) covering mainly; logging, messaging protocol and versioning. Normally standardised for a defined collection of services;
  • Technical policy(s). Technical policies can (if available) be provided in machine-readable format;
  • Versioning scheme used (e.g. major.minor[.fix]) and the compatibility guaranteed between different versions (e.g. backwards compatibility is guaranteed between minor versions but not for major);
  • Lifecycle policy applied to the service (e.g. to allow consumers to know that he is not investing on a soon to be retired service).


Example service consumption constraints:

  • The maximum number of requests per time window allowed for a service consumer.

Note: Additional use conditions could be diplomatic, geographical reasons, safety criticality and fees to be paid, for instance.

Level of Implementation

Mandatory

Guidance

Verification Support

Completeness

Check that:

[  ] The service description includes or refers to information about the legal constraints which apply to accessing and using the service.

[  ] The service description includes or refers to information about the service policies which apply to accessing and using the service.

[  ] The service description includes or refers to information about the service consumption constraints which apply to accessing and using the service.

Examples

The following example shows the content as a table.

service access and use conditions



legal constraints


TBD

service policies

business policy

The access to the service is subject to the signature of a Service Level Agreement with the Donlon Airport Operator.

operational policy

TBD

technical policy

TBD

service consumption constraints


TBD

The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-150 using Service Metadata Schema
"generalDescription": {
 "accessAndUseConditions": [{
  "name": "TBD",
  "type": "LEGAL_CONSTRAINT",
  "description": "tbd."
 }, {
  "name": "Need for SLA",
  "type": "SERVICE_POLICY",
  "description": "The access to the service is subject to the signature of a Service Level Agreement with the Donlon Airport Operator."
 }, {
  "name": "TBD",
  "type": "SERVICE_CONSUMPTION_CONSTRAINT",
  "description": "tbd."
 }]
}

Complete examples are available at Example service description.

  • No labels