SWIM-SERV-006 Service identification

Last updated:  JUNE 13th, 2019


Requirement

Title

Service identification

Identifier

SWIM-SERV-006

Requirement

A service description shall include:

  • the name of the service; and
  • the version of the service.

Rationale

This requirement makes clear what the subject of the service description is. It supports the identification and citation of the service being described.

Verification

Completeness: Verify that the 2 elements are included

Consistency: Not Applicable.

Correctness: Not Applicable. 

Examples/Notes

Example service identifications:

  • “TargetOffBlockTimeSetting service, version 1.3.0”;
  • “FlightManagement service, version 20.0”.

Note: To improve readability across service descriptions, it is best practice to apply following conventions for a service name:

  • include the operational concept supported or the information being exchanged;
  • be a maximum of five words in length;
  • be represented using UpperCamelCase, and not use snake_case; and
  • not end with the ‘service’ suffix.

Level of Implementation

Mandatory

Guidance

Examples

See the Service Identification section within the Donlon TOBT Setting Service Description.