Version
This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-020 Machine-readable interface
Requirement
Title | Machine-readable service interface definition |
Identifier | SWIM-SERV-320 |
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:
Note: AMQP does not mandate a specific machine-readable format. Note: REST may use OpenAPI, WSDL 2.0 or WADL. |
Level of Implementation | Mandatory (Conditional) |
Guidance
Verification Support
Completeness | Check that: [ ] The service description 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. |
Examples
The following example shows the content as a table.
machine-readable service interface definition | Service description in WSDL 1.1 <<add reference>> |
---|
The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema
tbd
Complete examples are available at Example service description.