SWIM Supporting Material

SWIM-DEFN-240 Service interfaces

Owned by WILSON Scott
Last updated: 2024 Jul 11
1 min read

Requirement

Title

Service interfaces

Identifier

SWIM-DEFN-240

Requirement

A service definition shall include or refer to information about the expected exposed service 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.

Rationale

This information facilitates the unambiguous identification of the interface and the understanding of its purpose.

Verification

Completeness: Verify that the list of interfaces is included; verify that the name, description and indication are included for each interface.

Consistency: Not Applicable.

Correctness: Not Applicable.

Examples/Notes

Example:

  • name: SearchAndRetrieve

  • description: The interface allows querying metadata and retrieving files.

  • interface provision side: PROVIDER_SIDE_INTERFACE

Level of
Implementation

Mandatory

Guidance

If no service interfaces are expected, the implemented service can group operations and messages as fit.

Verification Support

Completeness

Check that:

[  ] The service definition includes or refers to information about the exposed service interfaces.

[  ] The  information about the exposed service interfaces includes the name of the service interface.

[  ] The  information about the exposed service interfaces includes a textual description of the service interface including its purpose.

[  ] The  information about the exposed service interfaces includes an indication that the interface is a provider side interface or a consumer side interface.

Examples

Links to example service definitions can be found in the example service definitions page. 

Status: Living Material