Protocol Maturity

This message specifies the maturity of a protocol for customer- & production-facing APIs.

Table 1. Available fields in blickfeld.base.ProtocolMaturity
Field Type Default Unit

level

Level

-

-

Simple level which describes maturity

Level

This enumeration describes the maturity of a protocol. Please refer to the individual values.

APIs marked with the EXPERIMENTAL & DEPRECATED flags have to be handled with care. Please read through the definition.

Please report if the protocol maturity of a service, method, and field does not fit e.g. if an EXPERIMENTAL field is required in an application & production use case.

Table 2. Available values for blickfeld.base.ProtocolMaturity.Level enum
Name Value Description

LEVEL_UNSPECIFIED

0

Level is not set. Default level for services is EXPERIMENTAL. Default level for methods & fields is INHERITED.

LEVEL_EXPERIMENTAL

1

APIs marked with this flag should be handled with care. They might not function as expected. Additionally it is not ensure that the APIs will ever be moved to the MAINTAINED level. They might be altered or removed in any upcoming release without further notice.

LEVEL_MAINTAINED

2

APIs marked with this flag are actively maintained and released. They will not change their behaviour without notices in the changelog. Breaking changes in a maintained APIs have to result in a major update of the module.

LEVEL_DEPRECATED

3

APIs marked with this flag are no longer actively maintained. They will be removed in upcoming releases.

LEVEL_INHERITED

4

The protocol maturity is inherited from the parent