json.schema.events.subscriptionResourceDescriptor.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/events/subscriptionResourceDescriptor.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SubscriptionResourceDescriptor",
  "description": "Subscription descriptor",
  "type": "object",
  "javaType": "org.openmetadata.schema.type.NotificationResourceDescriptor",
  "definitions": {
    "operation": {
      "javaType": "org.openmetadata.schema.type.NotificationFilterOperation",
      "description": "This schema defines all possible filter operations on metadata of entities in OpenMetadata.",
      "type": "string",
      "enum": [
        "filterBySource",
        "filterByEntityId",
        "filterByOwnerName",
        "filterByFqn",
        "filterByEventType",
        "filterByUpdaterName",
        "filterByFieldChange",
        "filterByDomain",
        "filterByMentionedName",
        "filterByGeneralMetadataEvents"
      ]
    }
  },
  "properties": {
    "name": {
      "description": "Name of the resource. For entity related resources, resource name is same as the entity name. Some resources such as lineage are not entities but are resources.",
      "type": "string"
    },
    "supportedFilters": {
      "description": "List of operations supported filters by the resource.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/operation"
      }
    }
  },
  "additionalProperties": false
}