zitadel/proto/zitadel/change.proto

syntax = "proto3";

import "google/protobuf/timestamp.proto";
import "zitadel/message.proto";
import "protoc-gen-openapiv2/options/annotations.proto";

package zitadel.change.v1;

option go_package ="github.com/caos/zitadel/pkg/grpc/change";

message Change {
    google.protobuf.Timestamp change_date = 1 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "the creation date of an event";
            example: "\"2019-04-01T08:45:00.000000Z\"";
        }
    ];
    zitadel.v1.LocalizedMessage event_type = 2;
    uint64 sequence = 3 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            example: "\"2\"";
        }
    ];
    string editor_id = 4 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "the id of the user who created the event";
            example: "\"69629023906488334\"";
        }
    ];
    string editor_display_name = 5 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "the display name of the editor";
            example: "\"Gigi Giraffe\"";
        }
    ];
    string resource_owner_id = 6 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "the organisation the event belongs to";
            example: "\"69629023906488334\"";
        }
    ];
    string editor_preferred_login_name = 7 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "the preferred login name of the editor";
            example: "\"gigi@acme.zitadel.ch\"";
        }
    ];
    string editor_avatar_url = 8 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "avatar url of the editor";
            example: "\"https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32\"";
        }
    ];
}

message ChangeQuery {
    //sequence represents the order of events. It's always upcounting
    uint64 sequence = 1 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            example: "\"2\"";
        }
    ];
    uint32 limit = 2 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            example: "20";
            description: "Maximum amount of events returned. Default is set to 1000 in https://github.com/caos/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If no limit is set or the limit exeeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.";
        }
    ];
    bool asc = 3 [
        (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
            description: "default is descending"
        }
    ];
}