revapi.json

[
  {
    "extension": "revapi.filter",
    "id": "filter",
    "configuration": {
      "archives": {
        "justification": "Ignore everything not included in the module itself",
        "include": [
          "io\\.camunda:zeebe-bpmn-model:.*"
        ]
      }
    }
  },
  {
    "extension": "revapi.differences",
    "id": "differences",
    "configuration": {
      "differences": [
        {
          "justification": "Ignore new methods for Zeebe extensions, as these are not meant to be implemented but simply consumed; as such, new methods are perfectly fine to add",
          "code": "java.method.addedToInterface",
          "new": {
            "matcher": "java-package",
            "match": "/io\\.camunda\\.zeebe\\.model\\.bpmn\\.instance\\.zeebe(\\..*)?/"
          }
        },
        {
          "justification": "The abstract builders are usually not used outside of this project; a caller uses the concrete builder that inherits from the abstract builder.",
          "code": "java.class.nonFinalClassInheritsFromNewClass",
          "new": {
            "matcher": "java-package",
            "match": "io.camunda.zeebe.model.bpmn.builder"
          }
        },
        {
          "justification": "Validators are used only internally; they should not used or referenced from outside of the module",
          "code": "java.class.removed",
          "old": {
            "matcher": "java-package",
            "match": "io.camunda.zeebe.model.bpmn.validation.zeebe"
          }
        },
        {
          "ignore": true,
          "code": "java.method.addedToInterface",
          "new": "method B io.camunda.zeebe.model.bpmn.builder.ZeebeUserTaskPropertiesBuilder<B extends io.camunda.zeebe.model.bpmn.builder.ZeebeUserTaskPropertiesBuilder<B>>::zeebeCandidateUsers(java.lang.String)",
          "justification": "Ignore new methods for user task properties builder."
        },
        {
          "ignore": true,
          "code": "java.method.addedToInterface",
          "new": "method B io.camunda.zeebe.model.bpmn.builder.ZeebeUserTaskPropertiesBuilder<B extends io.camunda.zeebe.model.bpmn.builder.ZeebeUserTaskPropertiesBuilder<B>>::zeebeCandidateUsersExpression(java.lang.String)",
          "justification": "Ignore new methods for user task properties builder."
        }
      ]
    }
  }
]