revapi.json

[
  {
    "extension": "revapi.java",
    "configuration": {
      "filter": {
        "classes": {
          "exclude": [
            "com.azure.core.util.Configuration"
          ]
        },
        "packages": {
          "regex": true,
          "exclude": [
            "com\\.azure\\..+\\.(implementation|samples)(\\..+)?",
            "com\\.fasterxml\\.jackson(\\..+)?",
            "com\\.google\\.gson(\\..+)?",
            "reactor\\.(core|netty|util)(\\..+)?",
            "io\\.netty(\\..+)?",
            "(kotlin|okhttp3|okio)(\\..+)?",
            "com\\.nimbusds(\\..+)?",
            "com\\.microsoft\\.azure(\\..+)?",
            "javax\\.(jms|servlet)(\\..+)?",
            "io\\.micrometer(\\..+)?",
            "com\\.azure\\.data\\.cosmos(\\..+)?",
            "com\\.azure\\.spring(\\..+)?",
            "org\\.apache\\.avro(\\..+)?"
          ]
        }
      }
    }
  },
  {
    "extension": "revapi.semver.ignore",
    "configuration": {
      "enabled": true,
      "versionIncreaseAllows": {
        "major": "breaking",
        "minor": "nonBreaking",
        "patch": "equivalent"
      },
      "passThroughDifferences": [
        "java.class.nonPublicPartOfAPI"
      ]
    }
  },
  {
    "extension": "revapi.ignore",
    "configuration": [
      {
        "regex": true,
        "code": "java\\.missing\\.(oldClass|newClass)",
        "new": "missing\\-class com\\.fasterxml\\.jackson\\.databind\\.ObjectMapper",
        "exampleUseChainInNewApi": ".*com\\.azure\\.core\\.util\\.serializer\\.JacksonAdapter.*",
        "justification": "We allow this in com.azure.core.util.serializer.JacksonAdapter."
      },
      {
        "regex": true,
        "code": "java\\.missing\\.(oldClass|newClass)",
        "new": "missing\\-class javax\\.servlet\\.ServletContextEvent",
        "exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl.*",
        "justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.ServletContextCleaner"
      },
      {
        "regex": true,
        "code": "java\\.missing\\.(oldClass|newClass)",
        "new": "missing\\-class org\\.apache\\.avalon\\.framework\\.logger\\.Logger",
        "exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl\\.AvalonLogger.*",
        "justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.AvalonLogger"
      },
      {
        "regex": true,
        "code": "java\\.missing\\.(oldClass|newClass)",
        "new": "missing\\-class org\\.apache\\.log\\.Logger",
        "exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl\\.LogKitLogger.*",
        "justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.LogKitLogger"
      },
      {
        "regex": true,
        "code": "java\\.missing\\.(oldClass|newClass)",
        "new": "missing\\-class org\\.apache\\.log4j\\.Logger",
        "exampleUseChainInNewApi": ".*com\\.azure\\.keyvault\\.jca\\.org\\.apache\\.commons\\.logging\\.impl\\.Log4JLogger.*",
        "justification": "We allow this in com.azure.keyvault.jca.org.apache.commons.logging.impl.Log4JLogger"
      },
      {
        "regex": true,
        "code": "java.class.nonPublicPartOfAPI",
        "new": "class org.apache.http.impl.client.HttpRequestTaskCallable<V extends java.lang.Object>",
        "justification": "We allow this in org.apache.http.impl.client.HttpRequestFutureTask<V>"
      },
      {
        "regex": true,
        "code": "java.class.nonPublicPartOfAPI",
        "new": "(class|interface) org\\.apache\\.http\\.impl\\.conn\\.CPoolEntry",
        "exampleUseChainInNewApi": ".*org\\.apache\\.http\\.HttpClientConnection.*",
        "justification": "We allow this in org.apache.http.HttpClientConnection>"
      },
      {
        "regex": true,
        "code": "java.class.nonPublicPartOfAPI",
        "new": "(class|interface) com\\.azure\\.keyvault\\.jca\\.(com|org)\\..*",
        "justification": "skip check for third party files."
      },
      {
        "regex": true,
        "code": "java.class.nonPublicPartOfAPI",
        "new": "(class|enum|interface) org\\.conscrypt\\..*",
        "justification": "skip check for third party files."
      },
      {
        "regex": true,
        "code": "java\\.class\\.(noLongerInheritsFromClass|nonFinalClassInheritsFromNewClass)",
        "class": "com.azure.identity.SharedTokenCacheCredentialBuilder",
        "justification": "SharedTokenCacheCredentialBuilder now inherits AadCredentialBuilderBase instead of CredentialBuilderBase thus being reported. However, AadCredentialBuilderBase also extends CredentialBuilderBase so it's not a breaking change."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(interface|enum|class) reactor\\..*",
        "justification": "We allow reactor classes in our external APIs. This also occurs because we check transitive dependencies, so it checks reactor jars."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(class|interface|enum) com\\.azure\\.communication\\.common\\..*",
        "justification": "azure-communication-common classes are allowed to be exposed."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(interface|class|enum) com\\.azure\\.core.*",
        "justification": "azure-core classes are allowed to be exposed by dependencies using them."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "interface org\\.reactivestreams\\.(Publisher|Subscriber|Subscription).*",
        "justification": "These classes exposed are publisher, subscriber, and Subscription."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(class|interface|enum) com\\.azure\\.storage\\..*",
        "justification": "azure-storage-common and storage blob classes are allowed to be exposed."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(class|interface|enum) com\\.azure\\.resourcemanager\\..*",
        "justification": "resourcemanager classes are allowed to be exposed."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(class|interface|enum) com\\.azure\\.security\\.keyvault\\..*",
        "justification": "keyvault classes are allowed to be exposed."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(class|interface|enum) com\\.azure\\.perf\\.test\\.core\\..*",
        "justification": "perf-test classes are allowed to be exposed."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(interface|class|enum) com\\.azure\\.cosmos.*",
        "justification": "azure-cosmos classes are allowed to be exposed by dependencies using them."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(class|enum) com\\.azure\\.data\\.schemaregistry\\..+",
        "justification": "azure-data-schemaregistry-avro depends on the schema registry classes."
      },
      {
        "regex": true,
        "code": "java\\.class\\.externalClassExposedInAPI",
        "new": "(interface|class|enum) io\\.opentelemetry.*",
        "justification": "Azure Monitor Exporter is allowed to use OpenTelemetry types in public APIs as it implements interfaces defined by OpenTelemetry"
      },
      {
        "code": "java.field.constantValueChanged",
        "old": "field com.azure.messaging.eventgrid.SystemEventNames.COMMUNICATION_CHAT_MESSAGE_REMOVED_FROM_THREAD",
        "new": "field com.azure.messaging.eventgrid.SystemEventNames.COMMUNICATION_CHAT_MESSAGE_REMOVED_FROM_THREAD",
        "justification": "Correct the event type defined in swagger file"
      },
      {
        "code": "java.field.constantValueChanged",
        "old": "field com.azure.messaging.eventgrid.SystemEventNames.COMMUNICATION_CHAT_PARTICIPANT_ADDED_TO_THREAD",
        "new": "field com.azure.messaging.eventgrid.SystemEventNames.COMMUNICATION_CHAT_PARTICIPANT_ADDED_TO_THREAD",
        "justification": "Correct the event type defined in swagger file"
      },
      {
        "regex": true,
        "code": "java\\.annotation\\.attributeValueChanged",
        "new": "method byte\\[\\] com\\.azure\\.security\\.keyvault\\.keys\\.models\\.JsonWebKey::(g|s)et(D|Dp|Dq|E|K|N|P|Q|Qi|T|X|Y)\\(\\)",
        "justification": "The class used by the serialization/deserialization annotations is package private and moving it is not a breaking change."
      },
      {
        "code": "java.method.visibilityReduced",
        "new": "method com.azure.core.http.rest.RequestOptions com.azure.core.http.rest.RequestOptions::setErrorOptions(java.util.EnumSet<com.azure.core.http.rest.ErrorOptions>)",
        "justification": "The use case for ErrorOptions is not yet clear. It will be added later if there are enough data points to suggest this is needed."
      },
      {
        "code": "java.class.visibilityReduced",
        "new": "enum com.azure.core.http.rest.ErrorOptions",
        "justification": "The use case for ErrorOptions is not yet clear. It will be added later if there are enough data points to suggest this is needed."
      },
      {
        "regex": true,
        "code": "java\\.annotation\\.(added|attributeValueChanged|attributeAdded)",
        "new": "(class|method void|parameter void) com\\.azure\\.search\\.documents\\.indexes\\.models\\..*",
        "justification": "Generated classes were moved into public API, these annotations were already being used in implementation used during serialization and deserialization."
      },
      {
        "regex": true,
        "code": "java\\.annotation\\.added",
        "old": ".*",
        "annotationType": "com\\.azure\\.core\\.annotation\\.Service(Method|Client)",
        "justification": "These are SDK metadata annotations and don't affect runtime behavior."
      }
    ]
  }
]