Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Title

Machine-readable service interface definition

Identifier

SWIM-DEFN-320

Requirement

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.

Rationale

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

Verification

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.

Examples/Notes

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.

Level of
Implementation

Recommended - Conditional

Guidance

Note:  'include' means to embed the machine-readable format into the service definition. It is still a separate artefact.

Verification Support

Examples

...