Format of service descriptions

Last updated:  JUNE 28th, 2019

The SWIM Service Description specification prescribes the minimum set of elements to be contained in a service description. It doesn't prescribe any format for the service description. Whatever the format, it is important to be able to fulfill the requirements.

This section of the handbook provides a series of templates and schema that you can use to structure the content of service descriptions in various formats.

The Example service descriptions provides some example formats. It includes:

  • web page
  • Word document
  • XML file

The examples were based on the templates and schema available here.

Identified formats

These are currently being worked on.

Definitions

area

description

comment

templateThis is a structure that can be copied into documents such as Word documents and completed by the authors.

Benefits

  • efficiency (not re-inventing the wheel)
  • enhanced harmonisation between service description
schema

This is a structure that is used directly. An example could be an XML Schema. Authors create XML files that are validated against the XML Schema.

Additional benefit

  • processing by systems, such as upload into or exchange between repositories

Contents