Ongoing discussions within the SWIM communities of interest

Page tree

Ongoing discussions within the SWIM communities of interest

Skip to end of metadata
Go to start of metadata

Requirements taken on board for producing service descriptions using the JSON Schema.

Sources of requirements

As identified in Schema context, the sources for requirements are the Service Description spec, the Service Overview requirements, and the Registry requirements.

List of requirements

SD spec 

 SD spec requirements [+]

Requirement (link)

Identifier

Title

Level of Implementation

General Requirements

 

General Requirements


SWIM-SERV-001 Description coverage

SWIM-SERV-001

Service description coverage

Mandatory

SWIM-SERV-002 Description language

SWIM-SERV-002

Service description language

Mandatory

SWIM-SERV-003 Define abbreviations

SWIM-SERV-003

Define abbreviations and acronyms

Mandatory

SWIM-SERV-004 Use standard abbreviations

SWIM-SERV-004

Use standard abbreviations and acronyms

Recommended

SWIM-SERV-005 Description identification

SWIM-SERV-005

Service description identification

Mandatory

SWIM-SERV-006 Service identification

SWIM-SERV-006

Service identification

Mandatory

SWIM-SERV-007 Service abstract

SWIM-SERV-007

Service abstract

Mandatory

SWIM-SERV-008 Service provider

SWIM-SERV-008

Service provider

Mandatory

SWIM-SERV-009 Service categories

SWIM-SERV-009

Service categories

Mandatory

SWIM-SERV-010 Service standard reference

SWIM-SERV-010

Service standard reference

Mandatory

SWIM-SERV-011 Operational needs

SWIM-SERV-011

Operational needs

Mandatory

SWIM-SERV-012 Service functionality

SWIM-SERV-012

Service functionality

Mandatory

SWIM-SERV-013 Access and use conditions

SWIM-SERV-013

Service access and use conditions

Mandatory

SWIM-SERV-014 Quality of service

SWIM-SERV-014

Quality of service

Mandatory

SWIM-SERV-015 Technical constraint

SWIM-SERV-015

Technical constraint

Mandatory Conditional

Service Interface Requirements

 

Service Interface Requirements


SWIM-SERV-016 Service interfaces

SWIM-SERV-016

Service interfaces

Mandatory

SWIM-SERV-017 Message exchange pattern

SWIM-SERV-017

Message exchange pattern

Mandatory

SWIM-SERV-018 TI Profile and bindings

SWIM-SERV-018

SWIM TI Profile and interface bindings

Mandatory

SWIM-SERV-019 Protocols and data format

SWIM-SERV-019

Service interface protocols and data format

Mandatory

SWIM-SERV-020 Machine-readable interface

SWIM-SERV-020

Machine-readable service interface definition

Mandatory Conditional

SWIM-SERV-021 Service operations

SWIM-SERV-021

Service operations

Mandatory

SWIM-SERV-022 Information definition

SWIM-SERV-022

Information definition

Mandatory

SWIM-SERV-023 AIRM conformance

SWIM-SERV-023

AIRM conformance

Mandatory

SWIM-SERV-024 Filter capabilities

SWIM-SERV-024

Filter capabilities

Mandatory

SWIM-SERV-025 Service behaviour

SWIM-SERV-025

Service behaviour

Mandatory

SWIM-SERV-026 Model view

SWIM-SERV-026

Model view

Recommended

Other Requirements

 

Other Requirements


SWIM-SERV-027 Service validation

SWIM-SERV-027

Service validation

Mandatory

SWIM-SERV-028 Service monitoring

SWIM-SERV-028

Service monitoring

Mandatory Conditional

SWIM-SERV-029 Examples of code

SWIM-SERV-029

Examples of code

Recommended

Not a requirement
Not a requirement
SWIM-SERV-ADD Additional infoSWIM-SERV-ADDAdditional optional informationOptional

Service Overview 

  • Source = the draft ICAO Service Overview (see Service Overview from "Get into SWIM" session for a summary)

 Service Overview requirements [+]

Identifier

Title

Level of Implementation


Mandatory Requirements
SERV-OVW-001Field NameMandatory
SERV-OVW-002Service NameMandatory
SERV-OVW-003Service VersionMandatory
SERV-OVW-004Provider OrganizationMandatory
SERV-OVW-005Provider Point of ContactMandatory
SERV-OVW-006Brief Description of the ServiceMandatory
SERV-OVW-007Lifecycle InformationMandatory
SERV-OVW-008Geographical Extent of InformationMandatory
SERV-OVW-009Quality of ServiceMandatory
SERV-OVW-010Access RestrictionsMandatory
SERV-OVW-011Message Exchange PatternMandatory
SERV-OVW-012Information Exchange ModelsMandatory
SERV-OVW-013Service ValidationMandatory

Optional Requirements
SERV-OVW-014Additional Service InformationOptional
SERV-OVW-015Service FunctionsOptional
SERV-OVW-016Filtering AvailableOptional
SERV-OVW-017Sources of InformationOptional
SERV-OVW-018Support AvailabilityOptional

Registry 

  • Source = The SWIM EUR Registry User Requirements Document (URD)
  • Schema context indicates why this is a source of schema requirements.
 Registry requirements [+]

Identifier

Title

Statement

Clarification
SWIM-REG-0001Registration of servicesThe registry shall be able to store the different attributes that describe a service instance and service definition. The complete list of attributes is listed in the Registry Information Model in Annex AThis is applicable to both service instances as well as service definitions.
SWIM-REG-0004Service categorizationThe Registry shall enable the classification of services based on a common Service taxonomy [Annex B] that facilitates the discovery and comparability of resources.This is applicable to both service instances as well as service definitions
SWIM-REG-0005Import and Export of service 

The Registry shall enable the import and export of services based on a predefined service schema.

The import process will require the user to indicate the target object based on service name, version and provider. The import process will create a new service in the registry (if the target object didn’t exist), or replace an existing service (if the target object existed already) incrementing its service revision number.

The imported service will be stored as draft. The organization editor will be able to initiate the registration workflow after the import.

The export process creates an export file downloadable for the user based on the predefined service schema.

The predefined service schema is available in Annex B.
This is applicable to both service instances as well as service definitions.




Documenting requirements

Each requirement taken on board is expected to

  • be referenceable with an id
  • be referenceable on a web page
  • include the requirement text and rationale
  • include guidance for satisfying the requirement
  • includes JSON Guidance 

Linking the schema to requirements

Each element of the Service Description Schema is expected to trace to one or several service description requirements.

These requirements justify the presence of that element within the schema.

Schema assessments

The schema should be assessed for conformance to the requirements.

The assessments are grouped by requirement source

sourceassessmentstatus
SD specAssessment Schema 0.0.3 for Service Descriptiondone
Service OverviewAssessment Schema 0.0.3 for Service Overviewnot started
Registry

Question: Is an assessment needed?
As the schema is in use in operational registry.

-







  • No labels