Skip to content

Service Operations & Lifecycle

Release Management

The API uses semantic versioning to indicate backwards incompatibility or compatible changes. See semver.org for a comprehensive guide on semantic versioning. In short it follows a MAJOR.MINOR.PATCH style of versioning which increment if:

  1. MAJOR when incompatible API changes are made
  2. MINOR when functionality is added in a backward compatible manner
  3. PATCH when backward compatible bug fixes are made

A pre-release version may also be indicated by appending a pre-release tag, e.g., -alpha to the version (see semver #9 for more details).

The registered customers will be notified in due course about upcoming releases.

Principles

DWD offers data services in a pre-operational (swimt.dwd.de) and operational phase (swim.dwd.de), which follow the following principles:

  • DWD will announce draft implementations of the services on the pre-operational platform some time before the services become operational.
  • DWD will inform about new service releases and discontinuation of service releases in due course.
  • Customers will have access to the test services on the pre-operational platform to test their client applications before accessing the operational services.
  • Customers can consume all public subscriptions (i.e, with prefix de-dwd.) with their accounts on both platforms.
  • Customers may be set up with a subscription for each of their requested services on request. Multiple services may also be bundled in a single subscription. This is handled separately for the pre-operational and operational platforms.

Service Downtime

DWD maintains and monitors the service in order to ensure its availability and performance 24/7. However, there will be scheduled downtime of the service mainly due to maintenance reasons, as well as unintentional downtime due to errors or incidents. DWD will inform the service consumer about downtime in due time upfront to the occurrence, if possible. The targeted lead time for downtime maintenance is a week.

Scheduled downtime

In the case of intentional downtime, the service provider will inform the service consumer in due time upfront to the occurrence via AMQP. Additionally, a notification will be sent via AMQP to the service consumer. See the Scheduled Maintenance Message for details about the contents of such messages.

Non-intentional downtime and errors

For non-intentional downtime or others, the systems are setup to automatically inform the service consumer about the occurrence of such downtime or errors via AMQP. However, it might not always be possible to inform the service consumer in due time upfront to the occurrence of such downtime or errors due to the nature of the incident.

Additionally, DWD will inform the service consumer via automatic AMQP messages about the occurrence of internal data errors (e.g., data format errors, delays, etc.).

To receive technical AMQP messages, the service consumer needs to setup an AMQP receiver for the system messages (please refer to the List of Services for the AMQP address). The Data Error Message Schema contains details about the contents of such messages.

To ensure the availability of the service, DWD provides heartbeat messages to the service consumer every minute and will inform about the absence of data delivery in case of errors in the internal data delivery chain. To receive heartbeat messages refer to the List of Services for the address of the heartbeat messages.

In case of wider problems or incidents which affect the service availability, DWD proceeds along the lines of DWD's business continuity management and will inform the service consumer via E-Mail about the occurrence of such incidents.

Expiration of AMQP Messages

Info

This only applies to custom subscriptions, i.e., a subscription created specifically for a user. The subscription is then prefixed with the user name, e.g., swim_user.weather.aviation.metar.<uuid>. This does not apply to public subscriptions, i.e., subscriptions starting with de-dwd..

The AMQP messages sent by the service have a time-to-live (TTL) appropriate for the type of message. In case the TTL is exceeded, the message will be discarded by the AMQP broker. The consumer will be informed about the expiration of a message via an Expired Message.