@wix/bex-utils 1.28.0

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/annotations.proto

@@ -0,0 +1,335 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.wix.api";
+
+extend google.protobuf.ServiceOptions {
+    optional Maturity service_maturity = 50104;
+    optional Exposure service_exposure = 50105;
+    optional Deprecated service_deprecated = 50140; // mark a service as deprecated, optionally place replacing asset
+    repeated ServiceAppendix appendix_files = 50150; // declare external configuration info
+}
+
+extend google.protobuf.MethodOptions {
+    optional Exposure exposure = 50101;
+    optional Maturity maturity = 50102;
+    optional CacheSettings cacheable = 50103; // mark a method as cacheable, optionally pass max cache age
+    optional Deprecated deprecated = 50141; // mark a method as deprecated, optionally place replacing asset
+    optional Crud crud = 50146; // mark crud method type and describe related information about this method
+    optional Hookable hookable = 50147;
+    optional bool accepts_linguist = 50148; // marks that this method accepts `x-wix-linguist` header, MAY return translated/localized responses. without this option, requests that assign this header will get an error. CRUD annotated methods assumed to have this enabled for read ops and disabled for write ops.
+}
+
+extend google.protobuf.MessageOptions {
+    optional string decomposite_of = 50120; // mark it a shard of a message to remove fields
+    repeated FieldSet decomposition_minimum_fields = 50121; // constrain that sharding at the definition
+    optional bool unwrap_array_value = 50122; // mark message as wrapper for arrays
+    optional Deprecated message_deprecated = 50142; // mark a message as deprecated, optionally place replacing asset
+    repeated Unique unique = 50145; // mark unique identifiers for this message
+}
+
+extend google.protobuf.FieldOptions {
+    optional Exposure field_exposure = 50106;
+    optional Maturity field_maturity = 50107;
+    optional bool pii = 50110; // Mark specific field as PII so clients that store the data know it should be encrypted
+    optional string referenced_entity = 50111; // FQDN of foreign keys. For example, an Order message that points to Product message can use it like this: `string product_id = 10 [(wix.api.referenced_entity) = "wix.stores.catalog.product"];`
+    optional Deprecated field_deprecated = 50143; // Mark a field as deprecated, optionally place replacing asset
+    optional Translatable translatable = 50144; // Mark this field as translatable using MultiLingual services
+    optional string sample_data = 50149; // Example of data that may be assigned as a value of this field
+    optional Conditional conditional = 50151; // Configure the conditions required for this field to be returned
+}
+
+extend google.protobuf.EnumValueOptions {
+    optional Maturity enum_maturity = 50130;
+    optional Exposure enum_exposure = 50131;
+}
+
+message CacheSettings {
+    optional int32 max_age_seconds = 1; // default is 604800 seconds = 1 week
+}
+
+message FieldSet {
+    repeated string field = 1;
+}
+
+message Deprecated {
+    optional string replaced_by = 1; // use relative proto FQN as absolute identifier. e.g. "wix.common.Query"
+    optional string target_removal_date = 2; // a human readable sunset date of the deprecated resource YYYY-MM-DD
+}
+
+message Unique {
+    repeated string field = 1;
+}
+
+message Crud {
+    enum Method {
+        UNKNOWN_METHOD = 0;
+        CREATE = 1;
+        GET_ITEM = 2;
+        UPDATE = 3;
+        DELETE = 4;
+        UPSERT = 12;
+        LIST = 5;
+        QUERY = 6;
+        SEARCH = 18;
+        BULK_CREATE = 7;
+        BULK_UPDATE = 8;
+        BULK_UPDATE_BY_FILTER = 9;
+        BULK_DELETE = 10;
+        BULK_DELETE_BY_FILTER = 11;
+        BULK_UPSERT = 13;
+        LIST_DELETED = 14;
+        GET_DELETED = 15;
+        RESTORE_FROM_TRASHBIN = 16;
+        REMOVE_FROM_TRASHBIN = 17;
+        COUNT = 19;
+    }
+    required Method method = 1; // method type
+    oneof method_options {
+        CreateMethodOptions create_options = 3;
+        GetItemMethodOptions get_options = 4;
+        UpdateMethodOptions update_options = 5;
+        DeleteMethodOptions delete_options = 6;
+        ListMethodOptions list_options = 7;
+        QueryMethodOptions query_options = 8;
+        SearchMethodOptions search_options = 20;
+        BulkCreateMethodOptions bulk_create_options = 9;
+        BulkUpdateMethodOptions bulk_update_options = 10;
+        BulkUpdateByFilterMethodOptions bulk_update_by_filter_options = 11;
+        BulkDeleteMethodOptions bulk_delete_options = 12;
+        BulkDeleteByFilterMethodOptions bulk_delete_by_filter_options = 13;
+        UpsertMethodOptions upsert_options = 14;
+        BulkUpsertMethodOptions bulk_upsert_options = 15;
+        ListDeletedMethodOptions list_deleted_options = 16;
+        GetDeletedMethodOptions get_deleted_options = 17;
+        RestoreFromTrashbinMethodOptions restore_from_trashbin_options = 18;
+        RemoveFromTrashbinMethodOptions remove_from_trashbin_options = 19;
+        CountOptions count_options = 21;
+    }
+}
+
+message Paging {
+    enum Type {
+        UNKNOWN_TYPE = 0;
+        OFFSET = 1;
+        CURSOR = 2;
+    }
+    optional Type type = 1; // paging type
+    optional string paging_metadata_field = 2; // paging field name in response object. default is `metadata`
+}
+
+message CreateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+}
+
+message GetItemMethodOptions {
+    optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message UpdateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message UpsertMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message DeleteMethodOptions {
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message ListMethodOptions {
+    optional string ids_field = 1; // ids field name in request object if such exists. recommended field-name: `<entity-name>_ids`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    repeated string me_aliasable_field = 4; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message QueryMethodOptions {
+    optional string query_field = 1; // query field name in request object. default is `query`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    required Wql wql = 4; // mark fields that are available for filtering and sorting via WixQueryLanguage
+    repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message SearchMethodOptions {
+    optional string search_field = 1; // search field name in request object. default is `search`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    required Wql wql = 4; // mark fields that are available for filtering and sorting via WixQueryLanguage
+    repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message BulkCreateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+}
+
+message BulkUpdateMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message BulkUpdateByFilterMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+    optional string filter_field = 3; // filter field name in request object. default is `filter`
+}
+
+message BulkUpsertMethodOptions {
+    optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
+    optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
+}
+
+message BulkDeleteMethodOptions {
+    optional string ids_field = 1; // ids field name in request object. default is `<entity-name>_ids`
+}
+
+message BulkDeleteByFilterMethodOptions {
+    optional string filter_field = 1; // filter field name in request object. default is `filter`
+}
+
+message ListDeletedMethodOptions {
+    optional string ids_field = 1; // ids field name in request object if such exists. recommended field-name: `<entity-name>_ids`
+    required string items_field = 3; // items field name in response object.
+    optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
+    repeated string me_aliasable_field = 4; // collection of FQNs of fields that MAY be aliased with the const `"me"`
+}
+
+message GetDeletedMethodOptions {
+    optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message RestoreFromTrashbinMethodOptions {
+    optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message RemoveFromTrashbinMethodOptions {
+    optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
+}
+
+message CountOptions {
+    // The name of the endpoint that the count "copy" the WQL settings from - e.g inherit_wql_from: 'QueryProducts'
+    // Usually, that will be the query endpoint since you want the same filter capbilities for query and count
+    optional string inherit_wql_from = 1; 
+}
+
+message Wql {
+    enum Operator {
+        option allow_alias = true;
+        ALL_APPLICABLE_OPERATORS = 0; // Applicable by type. i.e. if we allow LT/GT for **, it means for numeric fields only.
+        EQ = 1; // [Comparison] Matches values that are equal to a specified value.
+        GT = 2; // [Comparison] Matches values that are greater than a specified value.
+        GTE = 3; // [Comparison] Matches values that are greater than or equal to a specified value.
+        IN = 4; // [Comparison] Matches any of the values specified in an array.
+        LT = 5; // [Comparison] Matches values that are less than a specified value.
+        LTE = 6; // [Comparison] Matches values that are less than or equal to a specified value.
+        NE = 7; // [Comparison] Matches all values that are not equal to a specified value.
+        NIN = 8; // [Comparison] Matches none of the values specified in an array.
+        BEGINS = 9; // [Comparison] Matches strings that begin with a specified value (NOT case sensitive).
+        EXISTS = 10; // [Element] Matches documents that have the specified field.
+        ALL = 11 [deprecated = true]; // [Array] Matches arrays that contain all elements specified in the query.
+        HAS_ALL = 11; // [Array] Matches arrays that contain all elements specified in the query.
+        ANY = 12 [deprecated = true]; // [Array] Matches arrays that contain at least one element specified in the query.
+        HAS_SOME = 12; // [Array] Matches arrays that contain at least one element specified in the query.
+        EMPTY = 13; // [Array] Matches arrays that contain no elements.
+    }
+    enum Sort {
+        NONE = 0; // no sorting enabled
+        ASC = 1; // ascending sort is supported
+        DESC = 2; // descending sort is supported
+        BOTH = 3; // sort is supported in both directions
+    }
+    message RequiredFields {
+        // this field is deprecated because we need sort direction alongside to field path
+        repeated string field = 1[(.wix.api.field_deprecated) = {
+            replaced_by: "required_field"
+            target_removal_date: "2023-03-31"
+        }];
+        message RequiredField {
+            required string path = 1; // a field path that that accepts this operator
+            optional Sort sort = 2; // sort type enabled for this glob
+        }
+        repeated RequiredField required_field = 2; // all required field configurations to satisfy composite index
+    }
+    message OperatorFieldSupport {
+        repeated Operator operator = 1; // Operators supported for fields that match the glob
+        // this field is deprecated because glob is hard to read. moved to a direct field config approach
+        optional string glob = 2 [(.wix.api.field_deprecated) = {
+            replaced_by: "field"
+            target_removal_date: "2023-03-31"
+        }];
+        repeated string field = 5; // a collection of field paths that that accepts this operator
+        optional Sort sort = 3; // sort type enabled for this glob
+        repeated RequiredFields required_fields = 4; // fields that match this glob, can be used only if the query is also filtered by required_fields
+    }
+    // this field is deprecated due to a better and shorter naming
+    repeated OperatorFieldSupport operator_field_support = 3 [(.wix.api.field_deprecated) = {
+        replaced_by: "pattern"
+        target_removal_date: "2023-03-31"
+    }];
+    repeated OperatorFieldSupport pattern = 4; // supported operators for subject query method
+}
+
+message Hookable {
+}
+
+message Translatable {
+    enum Type {
+        UNDEFINED_TYPE = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+        SHORT_TEXT = 1;
+        LONG_TEXT = 2;
+        RICH_TEXT = 3;
+        RICH_CONTENT_EDITOR = 4;
+        SELECTION = 5;
+        MULTI_SELECTION = 6;
+        DOCUMENT = 7;
+        IMAGE = 8;
+        VIDEO = 9;
+        IMAGE_LINK = 10; // Image URI without metadata
+    }
+    optional string name = 1; // a human friendly field name
+    optional bool hidden = 2; // is this translatable field hidden in Multilingual
+    optional string grouping = 3; // fields in schema may be grouped under meaningful topic or category of the source entity
+    required Type type = 4; // translation input component type e.g. "freetext", "dropdown", etc..
+    optional bool display_only = 5; // is this field for preview and not translatable
+}
+
+message Conditional {
+    optional string permission = 1; // field will not be returned by the server, unless the client has this permission. If `requested_field` is also set, and a client explicitly requests this field but does not have permission, server will return 403-Forbidden error
+    optional string requested_field = 2; // field will not be returned by the server, unless the client explicitly requested it using `fields` parameter in the request, with the enum value specified by this annotation
+}
+
+message ServiceAppendix {
+    enum Type {
+        UNKNOWN_APPENDIX_TYPE = 0;
+        NILE = 1; // Nile(tm) FW configuration
+        MESSAGE_BUS = 2; // wix message bus / pub-sub configuration
+    }
+    required Type type = 1; // appendix type
+    required string path = 2; // absolute from module root
+}
+
+enum Exposure {
+    PRIVATE = 0;
+    INTERNAL = 1;
+    PUBLIC = 2;
+}
+
+enum Maturity {
+    ALPHA = 0;
+    BETA = 1;
+    IA = 2 [deprecated=true];
+    GA = 3;
+    NOT_IMPLEMENTED = 4;
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/api_errors.proto

@@ -0,0 +1,117 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+import "wix/api/annotations.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ApiErrorsProto";
+option java_package = "com.wix.api";
+
+/**
+* Annotation for method returned errors
+* example usage:
+* import "wix/api/api_errors.proto";
+* service FooService {
+*   rpc CreateFoo (CreateFooRequest) returns (CreateFooResponse) {
+*     // Description of the error. Accepts `markdown`
+*     // and multiline
+*     option (wix.api.error) = {
+*       http_code: FAILED_PRECONDITION
+*       application_code: "NO_FOO_SUPPLY"
+*       data: "com.wixpress.foo.v1.NoFooSupplyError"
+*     }
+*     //and you can specify multiple errors
+*     option (wix.api.custom_validation_error) = {
+*       rule_name: "INVALID_NOTE"
+*       data: "com.wixpress.foo.v1.MyRuleViolationError"
+*     }
+*     // this method MAY throw standard crud errors of BULK_UPDATE method type
+*     option (wix.api.inherit_crud_errors) = {
+*       method: BULK_UPDATE
+*     }
+*   }
+* }
+**/
+extend google.protobuf.MethodOptions {
+  repeated Error error = 50801;
+  repeated CustomValidationError custom_validation_error = 50802;
+  repeated InheritCrudErrors inherit_crud_errors = 50803;
+}
+
+/**
+  ApplicationError: named Error for backwards compatibility
+**/
+message Error {
+  required StatusCodes.HttpStatusCode http_code = 1;
+  optional string application_code = 2;
+  optional string data = 3; // FQN path to the message that will be sent as payload for this error
+}
+
+/**
+  CustomValidationError: field level validation, only declare when you have specific validation in your service that is not coming from infra
+**/
+message CustomValidationError {
+  required string rule_name = 1;
+  optional string data = 2; // FQN path to the message that will be sent as payload for this error
+}
+
+/**
+  InheritCrudErrors: does this method throw standard crud errors?
+**/
+message InheritCrudErrors {
+  required Crud.Method method = 1; // types of crud methods to inherit default errors from
+}
+
+message StatusCodes {
+  enum HttpStatusCode {
+    OK = 0; // 200
+
+    //Default error codes (applicable to all endpoints)
+
+    // 401 - Identity missing (missing, invalid or expired oAuth token,
+    // signed instance or cookies)
+    UNAUTHENTICATED = 1;
+
+    // 403 - Identity does not have the permission needed for this method / resource
+    PERMISSION_DENIED = 2;
+
+    // 400 - Bad Request. The client sent malformed body
+    // or one of the arguments was invalid
+    INVALID_ARGUMENT = 3;
+
+    // 404 - Resource does not exist
+    NOT_FOUND = 4;
+
+    // 500 - Internal Server Error
+    INTERNAL = 5;
+
+    // 503 - Come back later, server is currently unavailable
+    UNAVAILABLE = 6;
+
+    // 429 - The client has sent too many requests
+    // in a given amount of time (rate limit)
+    RESOURCE_EXHAUSTED = 7;
+
+    //Custom error codes - need to be documented
+
+    // 499 - Request cancelled by the client
+    CANCELED = 8;
+
+    // 409 - Can't recreate same resource or concurrency conflict
+    ALREADY_EXISTS = 9; //409
+
+    // 428 - request cannot be executed in current system state
+    // such as deleting a non-empty folder or paying with no funds
+    FAILED_PRECONDITION = 10;
+
+    //DO NOT USE IN WIX
+    // ABORTED = 11; // 409
+    // OUT_OF_RANGE = 12; // 400
+    // DEADLINE_EXEEDED = 13; // 504
+    // DATA_LOSS = 14; // 500
+    // UNIMPLEMENTED = 15; // 501
+  }
+}
+

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/callback.proto

@@ -0,0 +1,134 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+import "wix/api/annotations.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "CallbackProto";
+option java_package = "com.wix.api";
+
+/*
+callback option is used to denote two separate concepts:
+1. DomainEvents- these are events your service sends on all activities in your entity. Emitted as a result of this method.
+service BlooperService {
+   option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+   rpc CreateBlooper (CreateBlooperRequest) returns (CreateBlooperResponse) {
+       option (wix.api.callback) = {
+           event_type: CREATED
+       };
+   };
+   rpc MissedBlooper (MissedBlooperRequest) returns (MissedBlooperResponse) {
+       option (wix.api.callback) = {
+           event_type: Action
+           payload: "com.wixpress.examples.BlooperWasMissed"
+       };
+   };
+}
+message Blooper {
+   option (wix.api.entity) = {
+       fqdn: "wix.examples.Blooper"
+   };
+}
+message BlooperWasMissed {
+    int32 how_funny_it_could_have_been = 1;
+}
+
+
+2. Kafka events that are internal to your domain and that are not related to a specific entity. Emitted as a result of this method.
+service BlooperService {
+   rpc Update (Request) returns (Response) {
+       option (wix.api.callback) = {
+           segment: USERS
+           topic: "Blooper.Update"
+           payload: "BlooperUpdateNotification" //name of the Message that is sent as event
+           permission: "Some.Permission" //permission required to consume this event as a webhook
+       };
+   };
+}
+*/
+extend google.protobuf.MethodOptions {
+    repeated Callback callback = 50000;
+    repeated Emits emits = 50001;
+}
+
+/*
+event option is used to denote two separate concepts:
+1. DomainEvents- these are events your service sends on all activities in your entity (see examples above)
+2. Kafka events that are internal to your domain and that are not related to a specific entity
+Both are emitted by the service, not necessarily as a result of a method call (some internal process of the service)
+Internal to domain event example:
+service BlooperService {
+   option (wix.api.event) = {
+       segment: PUBLIC
+       topic: "Blooper.Update"
+       payload: "BlooperUpdateNotification" //name of the Message that is sent as event
+       permission: "Some.Permission" //permission required to consume this event as a webhook
+   };
+   rpc Update (Request) returns (Response) {
+       //...
+   };
+}
+*/
+extend google.protobuf.ServiceOptions {
+    repeated Callback event = 50000;
+    repeated CallbackDeprecation event_deprecated = 50001;
+    repeated DomainEvent domain_event = 50002;
+}
+
+message Callback {
+    enum EventType {
+        UNKNOWN = 0;
+        CREATED = 1;
+        UPDATED = 2;
+        DELETED = 3;
+        ACTION = 4;
+    }
+
+    optional string topic = 1;
+    optional Segment.Segment segment = 8; // currently defaults to "legacy", will be `required` when legacy cluster is removed
+    optional string payload = 2;
+    optional string permission = 3;  
+    optional EventType event_type = 4;
+    optional Exposure exposure = 6;
+    optional Maturity maturity = 7;
+}
+
+message DomainEvent {
+    enum EventType {
+        UNKNOWN = 0;
+        CREATED = 1;
+        UPDATED = 2;
+        DELETED = 3;
+        ACTION = 4;
+    }
+    optional string action_message_fqn = 2; // Required when event_type == ACTION, otherwise must not be set
+    optional string webhook_permission_override = 3;
+    optional EventType event_type = 4;
+    optional Exposure exposure = 6;
+    optional Maturity maturity = 7;
+}
+
+message Emits {
+    required DomainEvent.EventType event_type = 1;
+    optional string action_message_fqn = 2; // Required when event_type == ACTION, otherwise must not be set
+}
+
+message CallbackDeprecation {
+    optional string replaced_by = 1;
+    optional string target_removal_date = 2;
+    optional Callback.EventType event_type = 3;
+    optional string custom_slug = 4; // required when event_type=action
+    optional string payload = 5;
+}
+
+message Segment {
+    enum Segment {
+        UNSPECIFIED = 0; // currently means "auto-resolved for old topics", will be forbidden when legacy cluster is removed
+        USERS = 1;
+        PUBLIC = 2;
+        OTHERS = 3;
+    }
+}
+

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/context.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package wix.api;
+
+option java_multiple_files = true;
+option java_outer_classname = "ContextProto";
+option java_package = "com.wix.api";
+
+message RequestContext {
+    map<string, string> aspects = 1;
+}
+
+message ResponseContext {
+    repeated ResponseContextEntry aspects = 1;
+}
+
+message ResponseContextEntry {
+    map<string, string> aspectEntry = 1;
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/entity.proto

@@ -0,0 +1,75 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+import "wix/api/annotations.proto";
+import "wix/api/callback.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "EntityProto";
+option java_package = "com.wix.api";
+
+/*
+Marks that message X is the "main" entity of service Y
+Key requirement for DomainEvents used in callback/event
+
+package com.wixpress.examples;
+
+service BlooperService {
+    option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+    rpc Update (BlooperRequest) returns (BlooperResponse) {
+        //...
+    };
+}
+
+message Blooper {
+   option (wix.api.entity) = {
+       fqdn: "wix.examples.Blooper" // A fully qualified domain name for this entity. Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+       exposure: PUBLIC //Optional exposure field. Will be used by systems like corvid and webhooks to decide if to expose events related to this entity to external parties
+
+   };
+}
+*/
+
+extend google.protobuf.ServiceOptions {
+    optional ServiceEntity service_entity = 50500;
+}
+
+message ServiceEntity {
+    required string message = 1;
+    optional string namespace = 50501; // use to avoid naming collisions between functions listed under the same fqdn/entity. Business Schema service shall use it using this hierarchy: [Entity > namespace > action]
+}
+
+extend google.protobuf.MessageOptions {
+    optional Entity entity = 50500;
+}
+
+message Entity {
+    required string fqdn = 1;
+    optional Exposure exposure = 2 [deprecated=true];
+    repeated MessageAppendix appendix_files = 3; // declare external configuration info
+    optional string old_fqdn_for_backwards_compatibility = 4; // Topic name for domain events will be based on this attribute if present (only for known legacy FQDNs)
+    optional Segment.Segment segment = 5; // the cluster to which domain events will be produced
+    repeated string implements = 6; // FQDNs of interfaces (i.e. SPIs) that this entity implements. Must begin with `wix.interfaces.`
+    optional Extensible extensible = 7; // Indicates that this entity can be extended by apps using data-extension mechanism.
+    optional bool trashbin = 8; // Indicates whether trash-bin is exposed on this entity.
+    optional string plural = 9; // plural form of this entity. e.g. singular: `entity`; plural: `entities`;
+    optional string domain_events_read_permission = 10; // permission to consume all event types of this entity from topic. affects internal/external consumers. For external webhook subscribers - MAY be overridden by event/callback `permission` field.
+    optional string app_def_id = 11; // the app in devcenter that owns this entity
+}
+
+message Extensible {
+    optional string nested_extension_field_path = 1;
+}
+
+message MessageAppendix {
+    enum Type {
+        UNKNOWN_APPENDIX_TYPE = 0;
+        AUTO_VELO = 1; // auto velo configuration
+        DOCS_CONF = 2; // wix docs configuration: `documentation.yaml`
+        MULTILINGUAL = 3; // wix multilingual configuration
+    }
+    required Type type = 1; // appendix type
+    required string path = 2; // absolute from module root
+}