Version
This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-010 Service standard reference
Requirement
Title | Service standard reference |
Identifier | SWIM-SERV-120 |
Requirement | If the service is based on a service standard the service description shall include:
|
Rationale | The reference to standards is essential information, fostering reuse. |
Verification | Completeness: Verify that the statement about adherence to a reference standard is included. Consistency: If the service adheres to a service standard, verify that the reference to the service standard is included. Correctness: Not Applicable. |
Examples/Notes | Note: The term ‘service standard’ includes service definitions. Example service standard references:
Note: this requirement concerns service standards. SWIM-SERV-260 concerns data formats such as "XML", SWIM-SERV-290 concerns information exchange standards such as "AIXM 5.1.1. |
Level of Implementation | Mandatory (Conditional) |
Guidance
Verification Support
| Completeness | Check that: [ ] The service description includes a reference to the service standard to which the service adheres. [ ] The service description includes a statement on any implemented options of the service standard. [ ] The service description includes a statement on any deviation from or addition to the service standard. |
| Consistency | Check that: [ ] If the service adheres to a service standard, verify that the reference to the service standard is included. |
Examples
The following example shows the content as a table.
service standard reference | reference |
|
|---|---|---|
| implemented options | ||
| deviations/additions | the original payload has been adapted in order to better fulfill the role of example. |
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.