SWIM-SERV-020 Machine-readable interface

Last updated: JUNE 13th, 2019


Requirement

Title

Machine-readable service interface definition

Identifier

SWIM-SERV-020

Requirement

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

Rationale

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 machine-readable descriptions:

  • service descriptions:
    • WSDL (e.g. if a Web Service binding using SOAP is selected);
  • message descriptions:
    • XSD;
    • Schematron Rules.

Note: AMQP does not mandate a specific machine-readable format.

Note: REST may use WSDL 2.0 or WADL. However, WADL is not standardised.

Level of Implementation

Mandatory Conditional

Guidance

No guidance provided.