A service description shall list the service interfaces (provider side and consumer side interfaces), including for each service interface,
- the name of the service interface;
- a textual description of the service interface including its purpose;
- an indication that the interface is a provider side interface or a consumer side interface; and
- for a provider side interface, the fully qualified network address at which the interface can be accessed.
Completeness: Verify that the list of interfaces is included; verify that the name, description and indication are included for each interface.
Consistency: For each provider side interface, verify that the network address is provided.
Correctness: Not Applicable.
Note: To improve readability across service descriptions, it is best practice to apply following conventions for a service interface name (the appendix B “ISRM naming conventions” of the SESAR 1 Modelling Guidelines [RD 6] is a good source for naming conventions):
- be represented using UpperCamelCase; and
- use the <noun> <role> pattern where <noun> is a topic related to the service and <role> describes the roles in a composition/interaction sequence, based on the Message Exchange Pattern that is used.
Example service interface names: FlightPlanCoordinator, FlightPlanSubmitter, ForecastProvider, ForecastConsumer, ClearanceRequester, ClearanceManager, PreDepartureSequencer, FlightInformationPublisher, AlertListener.
Note: It is best practice to provide, in addition, the network address(es) for accessing the service instance(s) that can be used for testing and development purposes.