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-005 Description identification

Requirement

Title

Service description identification

Identifier

SWIM-SERV-030

Requirement

A service description shall include:

  • a title by which the service description is known;
  • an edition; and
  • a reference date for use in citing the service description.

Rationale

This requirement supports the identification and citation of a service description.

Verification

Completeness: Verify that the 3 elements are included.

Consistency: Not Applicable.

Correctness: Not Applicable. 

Examples/Notes

Example service description identification:

  • “Flight Management service description, edition 20.0, 14 Mar 2016”.

Note: The edition of the service description is not to be confused with the version of the service. A service description can evolve to a new edition while still describing the same service version.

Level of Implementation

Mandatory

Guidance

The ability to provide an exact citation, a standardised reference to the service description, is very basic.

The edition of the service description is not to be confused with the version of the service. A service description can evolve to a new edition while still describing the same service version.

The ISO 8601 format can be used for the reference date i.e. "yyyy-mm-dd"

Verification Support

Completeness

Check that:

[  ] The service description has a title.

[  ] The service description has an edition.

[  ] The service description has a reference date.

Examples

The following example shows the content as a table.

service description identification

title

Donlon TOBT Setting Service Description

edition

0.93i

reference date

2020-06-02


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

Example of SWIM-SERV-030 using Service Metadata Schema
"descriptionIdentification": {
 "title": "Donlon TOBT Setting Service Description",
 "edition": "0.93i",
 "referenceDate": "2020-06-02"
}

Complete examples are available at Example service description.

  • No labels