Working towards the next version of the SWIM Supporting Material
Page History
Table of Contents |
---|
Requirement
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Guidance
No guidance provided.
Guidance for JSON service description
Excerpt | ||||||
---|---|---|---|---|---|---|
UNDERWORK
|
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Rules expressed for the cases as defined in Registry URD.
|
Guidance
Within field validation, itself within field serviceGeneralDescription, list one or more validation activities.
GuidanceRequirement: indicate whether a validation of the service has been performed; and if so, the method used; and the results achieved.In case no
Rationale: User needs to know how the information service was validated in order to have confidence in the service.
Within field validation, itself within field serviceGeneralDescription, list one or more validation activities.
2 cases can be distinguished, depending on whether validation has been performed , indicate so in the field description.or not.
- case 1 - validation activities have been performed
- case 2 - no validation activity
ValidationOfService - Mandatory (one or more)
An activity whereby a service is checked for conformance with the service objectives and requirements. Rationale: User needs to know how the information service was validated in order to have confidence in the service.
attribute name | description | type | guidance | rule | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type | The validation method used |
| Case 1: Select the validation method used for this validation activity. |
Note: Mandatory when validation activities have been performed. It is of no use other wise.
Case 2: do not use | Case 1: Mandatory Case 2 : No use | |
description | The description of the service validation | string |
Case 1: Include a brief statement on the validation results, and if/how the potential consumers may obtain the validation evidence. Example: This information service has undergone extensive testing prior to deployment by the information service provider “LMN”, infrastructure service provider “ABC”, and regulator “XYZ” to ensure that specific QoS standards are met. Operational monitoring by the information service provider is in place and the information service continues to meet all QoS requirements. For more information on this organization’s validation policies please see <URL>. Specific information regarding the validation by the regulator is available in a validation report upon request. |
Case 2: Make explicit that no validation has been performed, indicate so. | Mandatory |
Validation Report document (Optional)
A document Documents of type SERVICE_VALIDATION_REPORT may optionally be provided. See Guidance on serviceDocument.
Example
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceGeneralDescription": {
"validation": [
{
"type": "SELF_VALIDATION",
"description": "The service has been subject to intensive Verification and Validation, in alignment with our Quality Management System."
},
{
"type": "COLLABORATIVE_VALIDATION",
"description": "The service has been subject to two validation sessions with a few service consumers. The validation report is available upon request."
}
]
} |
Code Block | ||||
---|---|---|---|---|
| ||||
"serviceGeneralDescription": { "validation": [ { "description": "The service has not been validated yet." } ] } |
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.