Title

Service operations

Identifier

SWIM-SERV-021

Requirement

A service description shall include a technical description of the service operations of each of its interfaces, including:

• the name of the service operation;
• a description of the intent and the results of the service operation; and
• a description of the exchanged information by the service operation, including the input, output and error messages.

Rationale

The consumer needs to know which service operations are available to be called for the expected result.

Verification

Completeness: Verify that all service operations are described.

Consistency: Verify the service operations against the messaging technology needs.

Correctness: Not Applicable.

Examples/Notes

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

• include a verb and a noun; and
• be represented using lowerCamelCase.

Example service operation names: getAlerts; requestTrajectoryAnalysis; publishAirportMETInducedCapacity; setCoordinationAndTransferData; proposeARESDeActivation.

Note: For readability and understanding of services implemented using REST methods, it is best practice to define logical operations and to map these to the underlying REST methods being used.

Note: In case of subscription in a Publish / Subscribe message exchange pattern, the management of subscriptions must be specified, including the use and management of subscription id, the mechanism to unsubscribe, etc.

Note: When a service operation has several input parameters, it is best practice to indicate the role of each parameter.

Note: It may be considered to include information such as the expected number of elements to be exchanged and their frequencies.

Level of Implementation

Mandatory