Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Version
This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-015 Technical constraint
Requirement
Title | Additional technical information for the service consumer |
Identifier | SWIM-SERV-170 |
Requirement | If technical constraints to be taken into account by a service consumer when developing a consuming client are known, a service description shall include or refer to information about the technical constraints. |
Rationale | Knowing and satisfying the pre-requisite constraints of a service facilitate good use of the service, such as benefiting from the indicated quality of service statements. This requirement supports decision making in terms of assessing the implication, costs and feasibility, of using the service. |
Verification | Completeness: Not Applicable. Consistency: If provided, verify that the information corresponds to the described service. Correctness: Not Applicable. |
Examples/Notes | Note: technical constraints affect the consumer of the service. The consumer may have to implement certain software/hardware to be able to access the service. Example technical constraints: minimum bandwidth, receipt of a minimum message size. |
Level of Implementation | Mandatory (Conditional) |
Guidance
Technical constraints are a characteristic of the environment or larger system within which the service operates. There could, for example, be a constraint on the size of message that a service consumer is expected to receive. Some data set files can be quite large.
Verification Support
Consistency | Check that: [ ] The information about the technical constraints corresponds to the described service. |
Examples
The following example shows the content as a table.
additional technical information for the service consumer | There is a limit on the number of changes after TSAT has been issued. |
---|
The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema
"technicalDescription": { "technicalConstraint": [{ "name": "TSAT issued constraint", "description": "There is a limit on the number of changes after TSAT has been issued." }] }
Complete examples are available at Example service description.