custom-codec-schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "id": "https://github.com/hazelcast/hazelcast-client-protocol/blob/master/schema/custom-codec-schema.json",
  "title": "Hazelcast Client Protocol Custom Codec Definitions",
  "type": "object",
  "definitions": {
    "since": {
      "type": ["string", "number"],
      "minimum": 2.0,
      "exclusiveMaximum": 3.0,
      "pattern": "^2\\.\\d*\\.?\\d*$"
    },
    "param": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "enum": [
            "boolean",
            "byte",
            "int",
            "long",
            "float",
            "UUID",
            "byteArray",
            "longArray",
            "floatArray",
            "String",
            "Data",
            "EntryList_Integer_UUID",
            "EntryList_Integer_Long",
            "EntryList_Integer_Integer",
            "List_Integer",
            "List_Long",
            "List_UUID",
            "Address",
            "CacheEventData",
            "DistributedObjectInfo",
            "QueryCacheEventData",
            "RaftGroupId",
            "ScheduledTaskHandler",
            "SimpleEntryView",
            "WanReplicationRef",
            "Xid",
            "CacheConfigHolder",
            "CacheSimpleEntryListenerConfig",
            "EventJournalConfig",
            "EvictionConfigHolder",
            "HotRestartConfig",
            "ListenerConfigHolder",
            "AttributeConfig",
            "IndexConfig",
            "BitmapIndexOptions",
            "BTreeIndexConfig",
            "MapStoreConfigHolder",
            "MerkleTreeConfig",
            "NearCacheConfigHolder",
            "NearCachePreloaderConfig",
            "PredicateConfigHolder",
            "QueryCacheConfigHolder",
            "QueueStoreConfigHolder",
            "RingbufferStoreConfigHolder",
            "TimedExpiryPolicyFactoryConfig",
            "DurationConfig",
            "ClientBwListEntry",
            "EntryList_String_String",
            "EntryList_String_byteArray",
            "EntryList_Long_byteArray",
            "EntryList_String_EntryList_Integer_Long",
            "EntryList_UUID_Long",
            "EntryList_UUID_UUID",
            "EntryList_UUID_List_Integer",
            "EntryList_Data_Data",
            "EntryList_Data_List_Data",
            "List_byteArray",
            "List_CacheEventData",
            "List_CacheSimpleEntryListenerConfig",
            "List_Data",
            "List_List_Data",
            "ListCN_Data",
            "List_ListCN_Data",
            "List_DistributedObjectInfo",
            "List_ListenerConfigHolder",
            "List_AttributeConfig",
            "List_IndexConfig",
            "List_MemberInfo",
            "List_QueryCacheConfigHolder",
            "List_QueryCacheEventData",
            "List_ScheduledTaskHandler",
            "List_String",
            "List_Xid",
            "List_StackTraceElement",
            "List_ClientBwListEntry",
            "List_MCEvent",
            "List_SqlColumnMetadata",
            "List_JobAndSqlSummary",
            "Set_UUID",
            "Map_String_String",
            "Map_String_Data",
            "Map_EndpointQualifier_Address",
            "EndpointQualifier",
            "MergePolicyConfig",
            "MemberVersion",
            "Version",
            "MemberInfo",
            "MCEvent",
            "AnchorDataListHolder",
            "PagingPredicateHolder",
            "SqlQueryId",
            "SqlError",
            "SqlColumnMetadata",
            "JobAndSqlSummary",
            "SqlSummary",
            "CPMember",
            "List_CPMember",
            "List_RaftGroupId",
            "MigrationState",
            "FieldDescriptor",
            "List_FieldDescriptor",
            "Schema",
            "HazelcastJsonValue",
            "DataPersistenceConfig",
            "Capacity",
            "MemoryTierConfig",
            "DiskTierConfig",
            "TieredStoreConfig",
            "PartitioningAttributeConfig",
            "List_PartitioningAttributeConfig",
            "AwsConfig",
            "GcpConfig",
            "AzureConfig",
            "KubernetesConfig",
            "EurekaConfig",
            "List_DiscoveryStrategyConfig",
            "DiscoveryConfig",
            "WanSyncConfig",
            "List_VectorIndexConfig",
            "VectorDocument",
            "EntryList_Data_VectorDocument",
            "VectorPair",
            "List_VectorPair",
            "List_List_UUID"
          ]
        },
        "nullable": {
          "type": "boolean"
        },
        "since": {
          "$ref": "#/definitions/since"
        }
      },
      "required": [
        "name",
        "type",
        "nullable",
        "since"
      ]
    }
  },
  "additionalProperties": false,
  "properties": {
    "customTypes": {
      "type": "array",
      "items": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the custom type"
          },
          "since": {
            "$ref": "#/definitions/since"
          },
          "returnWithFactory": {
            "type": "boolean",
            "description": "True if the decode method should return with factory instead of the constructor"
          },
          "params": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/param"
            },
            "minItems": 0,
            "uniqueItems": false
          }
        },
        "required": [
          "name",
          "since",
          "params"
        ]
      }
    }
  },
  "required": [
    "customTypes"
  ]
}