Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
tip
Guidance is for producing JSON service descriptions is available at Guidance for JSON service descriptions
Why JSON service descriptions
The European SWIM Registry has developed a JSON Schema for the import/export of service descriptions.
That JSON Schema is a practical answer to the need for a template / schema as expressed by stakeholders in support of the production of service descriptions.
Such a schema
- benefits service providers in facilitating the production of service descriptions, including importing in registry and conformance to the SW specifications
- benefits service consumers with enhanced harmonisation of service descriptions
- allows service descriptions to be processed by systems this includes upload into a system, exchange between systems, and transformation (eg to service overview).
Constraints on JSON service descriptions
The JSON service descriptions are constrained by
- requirements. The service description spec requirements, but also some additional requirements (see below)
- the JSON schema (see Schema releases)
- validation rules (within the Registry application)
Schema
Documentation within the schema
Each schema element is documented with a "documentation" annotation.
This "documentation" annotation includes
- a small description for the element
- a trace to the requirement(s) justifying the presence of this element
Validation rules
Service description requirements
The following sources for service descriptions requirements have been identified:
- the Service Description specification,
- the ICAO Service Overview requirements,
- the Registry requirements.
Service Description specification
- Source = EUROCONTROL specifications for SWIM Service Description
- Rationale =
See SWIM Service Description Handbook and in particular Guidance on individual requirements
ICAO Service Overview
- Source = the draft ICAO Service Overview (see Service Overview from "Get into SWIM" session for a summary)
- Rationale = by satisfying these additional requirements, a service description contains all elements to produce a service overview. The intention is that service description authors would write a single document the burden to produce to write a single document
SWIM EUR Registry
- Source = The SWIM EUR Registry User Requirements Document (URD)
- Rationale = by satisfying these additional requirements, a service description can be imported in the SWIM EUR Registry and become discoverable.