camunda / element-templates-json-schema

JSON Schema for (Camunda) Element Templates
10 stars 7 forks source link

Add `deprecated=true|{}` to schema #70

Closed nikku closed 1 year ago

nikku commented 2 years ago

What should we do?

Element templates may be marked as deprecated:

{
  "id": "my-template",
  "deprecated": true
}

But also by providing additional meta-data:

{
  "id": "my-template",
  "deprecated": {
    "message": "Optional message, please migrat to 'FOO BAR'",
    "documentationRef": "https://optional-link-to-migration-documentation"
  }
}

Why should we do it?

Ensure people use deprecated in accordance with our requirements.