caps.json5

// FIT capabilities, as reported by each performer over the performerCapsFetch RPC.
//
// This is fit-cli's source of truth for what each capability *is*: performers report
// bare enum numbers, and this file maps those to names, to the Jira ticket tracking the
// capability, and to a description.
//
// The three groups are separate enums and all number from 0 — a number is only
// meaningful within its own group.
//   sdk           - sdk.Caps           (gRPC/sdk.caps.proto):            SDK features under test.
//   transactions  - transactions.Caps  (gRPC/transactions.extensions.proto): transactions features under test.
//   performer     - performer.Caps     (gRPC/performer.caps.proto):      what the performer harness itself supports.
//
// "number" is generated from the protos — do not hand-edit it.
// "jira", "description" and "notes" are yours: 'fit caps sync' will never overwrite them.
//
// To pick up capabilities newly added to the protos:
//   fit caps sync <path-to-transactions-fit-performer>
//
// See it all in action with:
//   fit caps table

{
  sdk: {
    SDK_PRESERVE_EXPIRY: {
      number: 0,
      jira: "",
      description: "",
    },
    SDK_KV_RANGE_SCAN: {
      number: 1,
      jira: "CBD-5161",
      description: "KV range scan support. See CBD-5161 for requirements.",
    },
    SDK_QUERY_INDEX_MANAGEMENT: {
      number: 2,
      jira: "",
      description: "Query index management support - All APIs available to the Cluster level QueryIndexManager: cluster.queryIndexes()",
    },
    SDK_COLLECTION_QUERY_INDEX_MANAGEMENT: {
      number: 3,
      jira: "",
      description: "All APIs available to the Collection level CollectionQueryIndexManager: collection.queryIndexes()",
    },
    SDK_SEARCH: {
      number: 4,
      jira: "",
      description: "Can execute cluster.search() with all SearchOptions. This is everything under sdk.search.proto, except VectorQuery.",
    },
    SDK_SEARCH_INDEX_MANAGEMENT: {
      number: 5,
      jira: "",
      description: "Can execute all APIs under cluster.searchIndexes(), with all options. This is everything under sdk.management.search.proto.",
    },
    SDK_SCOPE_SEARCH: {
      number: 6,
      jira: "",
      description: "Can execute scope.search() with all SearchOptions. Support for SDK_SEARCH is a prerequisite.",
    },
    SDK_SCOPE_SEARCH_INDEX_MANAGEMENT: {
      number: 7,
      jira: "",
      description: "Can execute all APIs under scope.searchIndexes(), with all options. This is everything under sdk.management.scope.search.proto.",
    },
    WAIT_UNTIL_READY: {
      number: 8,
      jira: "",
      description: "The performer supports WaitUntilReady with options, at cluster and bucket level",
    },
    PROTOSTELLAR: {
      number: 9,
      jira: "",
      description: "The SDK supports couchbase2:// connection strings",
    },
    SDK_BUCKET_MANAGEMENT: {
      number: 10,
      jira: "",
      description: "The performer supports the BucketManager API. This is everything under sdk.cluster.bucket_manager",
    },
    SDK_EVENTING_FUNCTION_MANAGER: {
      number: 11,
      jira: "",
      description: "The performer supports the EventingFunctionManager API. This is everything under sdk.cluster.eventing_function_manager",
    },
    SDK_QUERY: {
      number: 12,
      jira: "",
      description: "The performer supports ClusterLevelCommand.query, ScopeLevelCommand.query, and everything needed by sdk.query.Command it supports sending results back with sdk.query.QueryResult Does not include the use_replica Query option",
    },
    SDK_LOOKUP_IN: {
      number: 13,
      jira: "",
      description: "Implements base LookupIn functionality from sdk.collection.lookup_in.proto",
    },
    SDK_LOOKUP_IN_REPLICAS: {
      number: 14,
      jira: "",
      description: "Implements LookupInAllReplicas and LookupInAnyReplica messages from sdk.collection.lookup_in.proto",
    },
    SDK_QUERY_READ_FROM_REPLICA: {
      number: 15,
      jira: "",
      description: "",
    },
    SDK_OBSERVABILITY_RFC_REV_24: {
      number: 16,
      jira: "",
      description: "Supports Extended SDK Observability SDK-RFC 67 revision 24. E.g. the SDK is sending additional metric tags. Support for performer cap OBSERVABILITY_1 is a pre-requisite.",
    },
    SDK_KV: {
      number: 17,
      jira: "",
      description: "The performer implements everything under sdk.kv.commands and sdk.kv.mutate_in, and is able to support all forms of shared.Content for Get and MutateIn commands The performer cap KV_SUPPORT_1 is a prerequisite",
    },
    SDK_MANAGEMENT_HISTORY_RETENTION: {
      number: 18,
      jira: "",
      description: "Implements history retention settings for bucket and collection management.",
    },
    SDK_COLLECTION_MANAGEMENT: {
      number: 19,
      jira: "",
      description: "The performer supports the CollectionManager API. This is everything under sdk.bucket.collection_manager",
    },
    SDK_DOCUMENT_NOT_LOCKED: {
      number: 20,
      jira: "",
      description: "SDK can report the SDK_DOCUMENT_NOT_LOCKED_EXCEPTION error. The SDK_KV cap is a pre-requisite.",
    },
    SDK_CIRCUIT_BREAKERS: {
      number: 21,
      jira: "",
      description: "",
    },
    SDK_VECTOR_SEARCH: {
      number: 22,
      jira: "",
      description: "Supports sdk.search.VectorQuery. Support for SDK_SEARCH is a prerequisite.",
    },
    SDK_VECTOR_SEARCH_BASE64: {
      number: 23,
      jira: "",
      description: "Support for SDK_VECTOR_SEARCH is a prerequisite.",
    },
    SDK_SEARCH_RFC_REVISION_11: {
      number: 24,
      jira: "",
      description: "The SDK implements support for search SDK-RFC 52 revision 11. (Improved FeatureNotAvailable handling against older clusters for scoped and vector indexes)",
    },
    SDK_INDEX_MANAGEMENT_RFC_REVISION_25: {
      number: 25,
      jira: "",
      description: "The SDK implements support for index management SDK-RFC 54 revision 25. (Improved FeatureNotAvailable handling against older clusters for scoped and vector indexes)",
    },
    SDK_COUCHBASE2_OBSERVABILITY: {
      number: 26,
      jira: "",
      description: "The SDK implements support for observability with couchbase2, as specified in SDK-RFC 77.",
    },
    SDK_ZONE_AWARE_READ_FROM_REPLICA: {
      number: 27,
      jira: "",
      description: "The SDK implements support for Zone aware read from replica in Lookupin and Get operations The options requiring support are SELECTED_SERVER_GROUP Add SDK_ZONE_AWARE_READ_FROM_REPLICA_SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE if your performer also supports the optional SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE mode.",
    },
    SDK_OBSERVABILITY_CLUSTER_LABELS: {
      number: 28,
      jira: "",
      description: "The SDK will send cluster name and uuid labels in spans and metrics. OBSERVABILITY_1 is a prerequisite. (But not SDK_OBSERVABILITY_RFC_REV_24)",
    },
    SDK_ZONE_AWARE_READ_FROM_REPLICA_SELECTED_SERVER_GROUP_OR_ALL_AVAILABLE: {
      number: 29,
      jira: "",
      description: "",
    },
    SDK_APP_TELEMETRY: {
      number: 30,
      jira: "",
      description: "The SDK implements support for the Application Telemetry feature, as detailed in SDK-RFC 84.",
    },
    SDK_BUCKET_SETTINGS_NUM_VBUCKETS: {
      number: 31,
      jira: "",
      description: "The SDK implements the num_vbuckets attribute of BucketSettings",
    },
    SDK_PREFILTER_VECTOR_SEARCH: {
      number: 32,
      jira: "",
      description: "The SDK implements support for Vector Search prefiltering.",
    },
    SDK_QUERY_BOTH_POSITIONAL_AND_NAMED_PARAMETERS: {
      number: 33,
      jira: "",
      description: "The SDK supports setting both positional and named parameters for query and analytics_query. SDK3 Query RFC Revision #9 SDK3 Analytics RFC Revision #3",
    },
    SUPPORTS_AUTHENTICATOR: {
      number: 34,
      jira: "",
      description: "The SDK supports the Authenticator type.",
    },
    SDK_SET_AUTHENTICATOR: {
      number: 35,
      jira: "",
      description: "The SDK supports setting a new Authenticator.",
    },
    SDK_JWT: {
      number: 36,
      jira: "",
      description: "The SDK supports JwtAuthenticator.",
    },
    SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS: {
      number: 37,
      jira: "",
      description: "The SDK supports the stable OpenTelemetry semantic conventions (ExtendedObservability RFC Rev 26)",
    },
    SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS_EMITTED_BY_DEFAULT: {
      number: 38,
      jira: "",
      description: "The SDK emits the stable OpenTelemetry semantic conventions by default. SDK_STABLE_OTEL_SEMANTIC_CONVENTIONS is a pre-requisite. This should only be declared by SDKs that do not support the legacy semantic conventions (C++ & wrappers, Rust).",
    },
    SDK_GET_OR_NULL: {
      number: 39,
      jira: "",
      description: "The SDK supports the collection.getOrNull() API.",
    },
    SDK_EVENTING_RESUMING_FUNCTION_STATUS: {
      number: 40,
      jira: "",
      description: "The SDK supports the RESUMING status in the result of functions_status() of the eventing management API.",
    }
  },
  transactions: {
    EXT_TRANSACTION_ID: {
      number: 0,
      jira: "",
      description: "This is mandatory if PROTOCOL_VERSION_2_0 or higher is sent.",
    },
    EXT_DEFERRED_COMMIT: {
      number: 1,
      jira: "",
      description: "",
    },
    EXT_MEMORY_OPT_UNSTAGING: {
      number: 2,
      jira: "",
      description: "At least one of EXT_MEMORY_OPT_UNSTAGING and EXT_TIME_OPT_UNSTAGING must be supported",
    },
    EXT_TIME_OPT_UNSTAGING: {
      number: 3,
      jira: "",
      description: "",
    },
    EXT_CUSTOM_METADATA_COLLECTION: {
      number: 4,
      jira: "",
      description: "",
    },
    EXT_BINARY_METADATA: {
      number: 5,
      jira: "",
      description: "",
    },
    EXT_QUERY: {
      number: 6,
      jira: "",
      description: "",
    },
    EXT_STORE_DURABILITY: {
      number: 7,
      jira: "",
      description: "",
    },
    BF_CBD_3787: {
      number: 8,
      jira: "",
      description: "",
    },
    BF_CBD_3794: {
      number: 9,
      jira: "",
      description: "",
    },
    BF_CBD_3705: {
      number: 10,
      jira: "",
      description: "",
    },
    BF_CBD_3838: {
      number: 11,
      jira: "",
      description: "",
    },
    EXT_REMOVE_COMPLETED: {
      number: 12,
      jira: "",
      description: "",
    },
    EXT_ALL_KV_COMBINATIONS: {
      number: 13,
      jira: "",
      description: "",
    },
    EXT_UNKNOWN_ATR_STATES: {
      number: 14,
      jira: "",
      description: "",
    },
    BF_CBD_3791: {
      number: 15,
      jira: "",
      description: "",
    },
    EXT_SINGLE_QUERY: {
      number: 16,
      jira: "",
      description: "",
    },
    EXT_REPLACE_BODY_WITH_XATTR: {
      number: 17,
      jira: "",
      description: "",
    },
    EXT_THREAD_SAFE: {
      number: 18,
      jira: "",
      description: "",
    },
    EXT_SERIALIZATION: {
      number: 19,
      jira: "",
      description: "",
    },
    EXT_SDK_INTEGRATION: {
      number: 20,
      jira: "",
      description: "",
    },
    EXT_MOBILE_INTEROP: {
      number: 21,
      jira: "",
      description: "",
    },
    EXT_INSERT_EXISTING: {
      number: 22,
      jira: "",
      description: "",
    },
    EXT_OBSERVABILITY: {
      number: 23,
      jira: "",
      description: "",
    },
    EXT_QUERY_CONTEXT: {
      number: 24,
      jira: "",
      description: "",
    },
    EXT_PARALLEL_UNSTAGING: {
      number: 25,
      jira: "",
      description: "",
    },
    EXT_BINARY_SUPPORT: {
      number: 26,
      jira: "",
      description: "Support for Caps.CONTENT_AS_PERFORMER_VALIDATION is a pre-requisite for all following extensions.",
    },
    EXT_REPLICA_FROM_PREFERRED_GROUP: {
      number: 27,
      jira: "",
      description: "",
    },
    EXT_GET_MULTI: {
      number: 28,
      jira: "",
      description: "",
    },
    EXT_REPLICA_FROM_PREFERRED_GROUP_PATCH1: {
      number: 29,
      jira: "",
      description: "",
    },
    EXT_TTL: {
      number: 30,
      jira: "",
      description: "",
    }
  },
  performer: {
    GRPC_TESTING: {
      number: 0,
      jira: "",
      description: "The performer supports GRPC workloads. It's optional, but allows various GRPC streaming approaches to be tested with the performer, which can help find one that reliably lets results be streamed back.",
    },
    KV_SUPPORT_1: {
      number: 1,
      jira: "",
      description: "Level 1 KV support: the initial KV commands (get, insert, replace, remove, upsert) together with options.",
    },
    TRANSACTIONS_SUPPORT_1: {
      number: 2,
      jira: "",
      description: "Whether this performer has level 1 transactions support, e.g. it has implemented protocol 1.0+. It includes the top-level transactions rpcs: transactionCreate, closeTransactions, transactionStream, transactionCleanup transactionCleanupATR, cleanupSetFetch, clientRecordProcess. It does not include transactions.Workload - that is covered by TRANSACTIONS_WORKLOAD_1.",
    },
    CLUSTER_CONFIG_1: {
      number: 3,
      jira: "",
      description: "The performer supports all parameters in ClusterConfig up to idleHttpConnectionTimeoutSecs, 23.",
    },
    TRANSACTIONS_WORKLOAD_1: {
      number: 4,
      jira: "",
      description: "Whether this performer supports transactions.Workload, allowing it to do performance testing of transactions. All GRPC messages transitively required by this workload must also be supported. The exception here is TransactionOptions.hooks: these can be significant work for an implementation, and are not (initially at least) required for transactions performance testing. The performer also needs to support the new commands: transactions.Insert,Replace,Remove,Get. CLUSTER_CONFIG_1 must be supported.",
    },
    OBSERVABILITY_1: {
      number: 6,
      jira: "",
      description: "Support for requesting the performer output observability (OpenTelemetry) data. The performer must support: ClusterConfig.observabilityConfig and everything under it. SpanCreateRequest and SpanFinishRequest, and everywhere they are used. parentSpanId on all messages the performer also supports. This is a UUID corresponding to a previous SpanCreateRequest. The performer can assume it is a bug if it does not know about this span or it has been previously finished, and throw an error. spanCreate and spanFinish RPCs. The SDK must support everything in the observability SDK-RFC revision #24, including: RequestSpan.recordException Counter support",
    },
    CLUSTER_CONFIG_CERT: {
      number: 7,
      jira: "",
      description: "Support `ClusterConfig.cert`.",
    },
    CLUSTER_CONFIG_INSECURE: {
      number: 8,
      jira: "",
      description: "Support `ClusterConfig.insecure`.",
    },
    TIMING_ON_FAILED_OPS: {
      number: 9,
      jira: "",
      description: "The performer will set `elapsedNanos` for failed operations as well as successful ones.",
    },
    LARGE_VALUES: {
      number: 10,
      jira: "",
      description: "The performer supports sending and receiving values of up to 25MiB.",
    },
    CONTENT_AS_PERFORMER_VALIDATION: {
      number: 11,
      jira: "",
      description: "If the performer supports ContentAsPerformerValidation.",
    },
    CUSTOM_SERIALIZATION_SUPPORT_FOR_SEARCH: {
      number: 12,
      jira: "",
      description: "",
    },
    AS_NULL_CONTENT_TYPE_SUPPORT: {
      number: 13,
      jira: "",
      description: "The performer supports content types as null value.",
    },
    TXN_CLIENT_CONTEXT_ID_SUPPORT: {
      number: 14,
      jira: "",
      description: "The performer supports client_context_id as Transaction Query Option.",
    }
  }
}