Machine-readable service interface definition

SWIM-DEFN-320

If the service interface binding specifies the use of machine-readable formats, a service definition should include or refer to a service interface definition in a machine-readable format using a standard service definition formalism/language.

The machine-readable format enables consumer software components to be created.

Completeness: If the service interface binding supports it, verify that the required elements are included.

Consistency: Verify that provided elements are consistent with the selected binding.

Correctness: Not Applicable.

Example:

• title: Interface WSDL

• description: Machine processable description of the service
  interface

• reference: public:/2019-09/TOBT_Interface.wsdl

Other examples include the use of the OpenAPI Specification that standardises how HTTP APIs are described.

Recommended - Conditional

Completeness

Check that:

[  ] The service definition includes or refers to a service interface definition in a machine-readable format if the service interface binding supports it.

Consistency

Check that:

[  ] The provided elements are consistent with the selected binding.