API Lifecycle

The lifecycle status of the API

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
deprecated	`string`	Nee	The date from which the API is no longer supported or developed further. Until this date the status is `active`. Format: date
status	`string`	Ja	The lifecycle status of the API, derived from the `deprecated` and `sunset` dates: - `active`: the API is supported and may still be developed further. - `deprecated`: the `deprecated` date has passed. The API can still be used, but is no longer supported or developed further. Consumers should migrate. - `sunset`: the API is being phased out and will be taken offline on the `sunset` date, which lies in the future. - `retired`: the `sunset` date has passed. The API is offline and can no longer be used. Enum: active, deprecated, sunset, retired
sunset	`string`	Nee	The date from which the API is taken offline. Before this date the status is `sunset`, after it `retired`. Format: date
version	`string`	Ja	The version of the API

JSON Schema

{
  "$id": "https://schemas.developer.overheid.nl/schemas/don/apilifecycle",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "The lifecycle status of the API",
  "properties": {
    "deprecated": {
      "description": "The date from which the API is no longer supported or developed further. Until this date the status is `active`.",
      "examples": [
        "2025-10-10",
        "2026-03-01"
      ],
      "format": "date",
      "type": "string"
    },
    "status": {
      "description": "The lifecycle status of the API, derived from the `deprecated` and `sunset` dates:\n\n- `active`: the API is supported and may still be developed further.\n- `deprecated`: the `deprecated` date has passed. The API can still be used, but is no longer supported or developed further. Consumers should migrate.\n- `sunset`: the API is being phased out and will be taken offline on the `sunset` date, which lies in the future.\n- `retired`: the `sunset` date has passed. The API is offline and can no longer be used.",
      "enum": [
        "active",
        "deprecated",
        "sunset",
        "retired"
      ],
      "examples": [
        "active",
        "deprecated"
      ],
      "type": "string"
    },
    "sunset": {
      "description": "The date from which the API is taken offline. Before this date the status is `sunset`, after it `retired`.",
      "examples": [
        "2027-11-11",
        "2026-12-31"
      ],
      "format": "date",
      "type": "string"
    },
    "version": {
      "description": "The version of the API",
      "examples": [
        "1.0.0",
        "3.2.1"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "version"
  ],
  "title": "API Lifecycle",
  "type": "object"
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt gebruikt door
Schema	Locatie
API	`/properties/lifecycle/$ref`

Health issues

Health issues
Message	Pointer
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/deprecated/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/status/enum – /properties/status/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/status/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/sunset/description`

Schema-register: API Lifecycle

Details van JSON Schema: API Lifecycle

Details van JSON Schema: API Lifecycle

Beschrijving