path: root/proto/commit.proto

syntax = "proto3";

package gitaly;

import "google/protobuf/timestamp.proto";
import "lint.proto";
import "shared.proto";

option go_package = "gitlab.com/gitlab-org/gitaly/v14/proto/go/gitalypb";

// CommitService is a service which provides RPCs that interact with Git
// commits.
service CommitService {

  // ListCommits lists all commits reachable via a set of references by doing a
  // graph walk. This deprecates FindAllCommits and FindCommits (except Follow
  // is not yet supported). Any unknown revisions will cause the RPC to fail.
  rpc ListCommits(ListCommitsRequest) returns (stream ListCommitsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // ListAllCommits lists all commits present in the repository, including
  // those not reachable by any reference.
  rpc ListAllCommits(ListAllCommitsRequest) returns (stream ListAllCommitsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc CommitIsAncestor(CommitIsAncestorRequest) returns (CommitIsAncestorResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc TreeEntry(TreeEntryRequest) returns (stream TreeEntryResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc CountCommits(CountCommitsRequest) returns (CountCommitsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc CountDivergingCommits(CountDivergingCommitsRequest) returns (CountDivergingCommitsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc GetTreeEntries(GetTreeEntriesRequest) returns (stream GetTreeEntriesResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc ListFiles(ListFilesRequest) returns (stream ListFilesResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc FindCommit(FindCommitRequest) returns (FindCommitResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc CommitStats(CommitStatsRequest) returns (CommitStatsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // Use a stream to paginate the result set
  rpc FindAllCommits(FindAllCommitsRequest) returns (stream FindAllCommitsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc FindCommits(FindCommitsRequest) returns (stream FindCommitsResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc CommitLanguages(CommitLanguagesRequest) returns (CommitLanguagesResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc RawBlame(RawBlameRequest) returns (stream RawBlameResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc LastCommitForPath(LastCommitForPathRequest) returns (LastCommitForPathResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc ListLastCommitsForTree(ListLastCommitsForTreeRequest) returns (stream ListLastCommitsForTreeResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc CommitsByMessage(CommitsByMessageRequest) returns (stream CommitsByMessageResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc ListCommitsByOid(ListCommitsByOidRequest) returns (stream ListCommitsByOidResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc ListCommitsByRefName(ListCommitsByRefNameRequest) returns (stream ListCommitsByRefNameResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc FilterShasWithSignatures(stream FilterShasWithSignaturesRequest) returns (stream FilterShasWithSignaturesResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc GetCommitSignatures(GetCommitSignaturesRequest) returns (stream GetCommitSignaturesResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // This comment is left unintentionally blank.
  rpc GetCommitMessages(GetCommitMessagesRequest) returns (stream GetCommitMessagesResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

  // CheckObjectsExist will check for the existence of revisions against a
  // repository. It returns two sets of data. An array containing the revisions
  // fromm the input that it found on the repository, and an array that contains all
  // revisions from the input it did not find on the repository.
  rpc CheckObjectsExist(stream CheckObjectsExistRequest) returns (stream CheckObjectsExistResponse) {
    option (op_type) = {
      op: ACCESSOR
    };
  }

}

// ListCommitsRequest is a request for the ListCommits RPC.
message ListCommitsRequest {
  // Order is the order in which commits shoud be traversed.
  enum Order {
    // NONE defaults to reverse chronological order.
    NONE = 0;
    // TOPO order will cause no parents to be shown before all of its children
    // are shown. Furthermore, multiple lines of history will not be
    // intermixed.
    TOPO = 1;
    // DATE order will cause no parents to be shown before all of its children
    // are shown. Otherwise, commits are shown in commit timestamp order. This
    // can cause history to be shown intermixed.
    DATE = 2;
  };

  // Repository is the repository in which commits should be searched for.
  Repository repository = 1 [(target_repository)=true];

  // Revisions is the set of revisions which should be walked to enumerate
  // commits. Accepts all notation as documented in gitrevisions(7) as well as
  // the pseudo-revisions `--not` and `--all` as documented in git-rev-list(1).
  // Must not be empty.
  repeated string revisions = 2;

  // PaginationParams allows implementation of pagination. The page token is
  // the last commit OID that was sent. It's expected to be the full object ID
  // to guard against ambigious OIDs.
  PaginationParameter pagination_params = 3;

  // Order is the order in which commits should be traversed. Please refer to
  // the enum's documentation for further information.
  Order order = 4;

  // Reverse will cause all commits to be listed in reverse.
  bool reverse = 11;

  // MaxParents will skip all commits which have more than the specified number
  // of parents. If set to `0`, no filtering by parents will happen. If set to
  // `1`, all merge commits will be omitted.
  uint32 max_parents = 5;

  // DisableWalk will disable walking the graph. As a result, only commits
  // which are immediately referenced by Revisions will be returned.
  bool disable_walk = 6;

  // FirstParent will cause the graph walk to only go down the first-parent
  // chain of commits. Merge commits will thus only cause the mainline to be
  // enumerated.
  bool first_parent = 7;

  // After will only list commits which are more recent than the specified date.
  google.protobuf.Timestamp after = 8;

  // After will only list commits which are older than the specified date.
  google.protobuf.Timestamp before = 9;

  // Author will only list commits whose author matches the given pattern,
  // which is a regular expression.
  bytes author = 10;
}

// ListCommitsResponse is a response for the ListCommits RPC.
message ListCommitsResponse {
  // Commits is the list of commits found.
  repeated GitCommit commits = 1;
}

// ListAllCommitsRequest is a request for the ListAllCommits RPC.
message ListAllCommitsRequest {
  // Repository is the repository in which commits should be searched for.
  Repository repository = 1 [(target_repository)=true];

  // PaginationParams allows implementation of pagination. The page token is
  // the last commit OID that was sent. It's expected to be the full object ID
  // to guard against ambigious OIDs.
  PaginationParameter pagination_params = 2;
}

// ListAllCommitsResponse is a response for the ListAllCommits RPC.
message ListAllCommitsResponse {
  // Commits is the list of commits found.
  repeated GitCommit commits = 1;
}

// This comment is left unintentionally blank.
message CommitStatsRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
}

// This comment is left unintentionally blank.
message CommitStatsResponse {
  // OID is the commit. Empty means not found
  string oid = 1;
  int32 additions = 2;
  int32 deletions = 3;
}

// This comment is left unintentionally blank.
message CommitIsAncestorRequest {
  Repository repository = 1 [(target_repository)=true];
  string ancestor_id = 2;
  string child_id = 3;
}

// This comment is left unintentionally blank.
message CommitIsAncestorResponse {
  bool value = 1;
}

// This comment is left unintentionally blank.
message TreeEntryRequest {
  Repository repository = 1 [(target_repository)=true];
  // commit ID or refname
  bytes revision = 2;
  // entry path relative to repository root
  bytes path = 3;
  // Limit is the maximum number of bytes to fetch. If object is bigger, remaining bytes are not sent
  // 0 means there is no limit.
  int64 limit = 4;
  // MaxSize is the maximum allowed object size. If bigger, a FailedPrecondition error is returned
  // 0 means there is no maximum size.
  int64 max_size = 5;
}

// This comment is left unintentionally blank.
message TreeEntryResponse {
  // TODO: Replace this enum with ObjectType in shared.proto
  enum ObjectType {
    COMMIT = 0;
    BLOB = 1;
    TREE = 2;
    TAG = 3;
  }
  ObjectType type = 1;
  // SHA1 object ID
  string oid = 2;
  int64 size = 3;
  // file mode
  int32 mode = 4;
  // raw object contents
  bytes data = 5;
}

// This comment is left unintentionally blank.
message CountCommitsRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  google.protobuf.Timestamp after = 3;
  google.protobuf.Timestamp before = 4;
  bytes path = 5;
  int32 max_count = 6;
  // all and revision are mutually exclusive
  bool all = 7;
  bool first_parent = 8;
  GlobalOptions global_options = 9;
}

// This comment is left unintentionally blank.
message CountCommitsResponse {
  int32 count = 1;
}

// This comment is left unintentionally blank.
message CountDivergingCommitsRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes from = 2;
  bytes to = 3;
  reserved 4;
  reserved 5;
  reserved 6;
  int32 max_count = 7;
}

// This comment is left unintentionally blank.
message CountDivergingCommitsResponse {
  int32 left_count = 1;
  int32 right_count = 2;
}

// This comment is left unintentionally blank.
message TreeEntry {
  // TODO: Replace this enum with ObjectType in shared.proto
  enum EntryType {
    BLOB = 0;
    TREE = 1;
    COMMIT = 3;
  }
  // OID of the object this tree entry points to
  string oid = 1;
  // OID of the tree attached to commit_oid
  string root_oid = 2;
  // Path relative to repository root
  bytes path = 3;
  EntryType type = 4;
  // File mode e.g. 0644
  int32 mode = 5;
  // The commit object via which this entry was retrieved
  string commit_oid = 6;
  // Relative path of the first subdir that doesn't have only one directory descendant
  bytes flat_path = 7;
}

// This comment is left unintentionally blank.
message GetTreeEntriesRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  bytes path = 3;
  bool recursive = 4;

  enum SortBy {
    DEFAULT = 0; // Preserve order of git ls-tree
    TREES_FIRST = 1; // trees, blobs, submodules
  }

  SortBy sort = 5;
  // The page token is the last commit OID that was sent. It's expected to be the
  // full object ID to guard against ambigious OIDs.
  PaginationParameter pagination_params = 6;
}

// This comment is left unintentionally blank.
message GetTreeEntriesResponse {
  repeated TreeEntry entries = 1;

  PaginationCursor pagination_cursor = 2;
}

// This comment is left unintentionally blank.
message ListFilesRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
}

// A single 'page' of the paginated response
message ListFilesResponse {
  // Remember to force encoding utf-8 on the client side
  repeated bytes paths = 1;
}

// This comment is left unintentionally blank.
message FindCommitRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  bool trailers = 3;
}

// This comment is left unintentionally blank.
message FindCommitResponse {
  // commit is nil when the commit was not found
  GitCommit commit = 1;
}

// This comment is left unintentionally blank.
message ListCommitsByOidRequest {
  Repository repository = 1 [(target_repository)=true];
  repeated string oid = 2; // protolint:disable:this REPEATED_FIELD_NAMES_PLURALIZED
}

// This comment is left unintentionally blank.
message ListCommitsByOidResponse {
  repeated GitCommit commits = 1;
}

// This comment is left unintentionally blank.
message ListCommitsByRefNameRequest {
  Repository repository = 1 [(target_repository)=true];
  repeated bytes ref_names = 2;
}

// This comment is left unintentionally blank.
message ListCommitsByRefNameResponse {
  reserved 1;

  // This comment is left unintentionally blank.
  message CommitForRef {
    GitCommit commit = 1;
    bytes ref_name = 2;
  }

  repeated CommitForRef commit_refs = 2;
}

// This comment is left unintentionally blank.
message FindAllCommitsRequest {
  Repository repository = 1 [(target_repository)=true];
  // When nil, return all commits reachable by any branch in the repo
  bytes revision = 2;
  int32 max_count = 3;
  int32 skip = 4;
  enum Order {
    NONE = 0;
    TOPO = 1;
    DATE = 2;
  }
  Order order = 5;
}

// A single 'page' of the result set
message FindAllCommitsResponse {
  repeated GitCommit commits = 1;
}

// This comment is left unintentionally blank.
message FindCommitsRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  int32 limit = 3;
  int32 offset = 4;
  repeated bytes paths = 5;
  bool follow = 6;
  bool skip_merges = 7;
  bool disable_walk = 8;
  google.protobuf.Timestamp after = 9;
  google.protobuf.Timestamp before = 10;
  // all and revision are mutually exclusive
  bool all = 11;
  bool first_parent = 12;
  bytes author = 13;
  enum Order {
    NONE = 0;
    TOPO = 1;
  }
  Order order = 14;
  GlobalOptions global_options = 15;
  bool trailers = 16;
}

// A single 'page' of the result set
message FindCommitsResponse {
  repeated GitCommit commits = 1;
}

// This comment is left unintentionally blank.
message CommitLanguagesRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
}

// This comment is left unintentionally blank.
message CommitLanguagesResponse {
  // This comment is left unintentionally blank.
  message Language {
    string name = 1;
    float share = 2;
    string color = 3;
    uint32 file_count = 4;
    uint64 bytes = 5;
  }
  repeated Language languages = 1;
}

// This comment is left unintentionally blank.
message RawBlameRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  bytes path = 3;
  // Comma-separated range of line numbers to perform the blame on: "1,1000".
  // Optional - if no range is provided, the whole file will be blamed.
  bytes range = 4;
}

// This comment is left unintentionally blank.
message RawBlameResponse {
  bytes data = 1;
}

// This comment is left unintentionally blank.
message LastCommitForPathRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  bytes path = 3;
  bool literal_pathspec = 4; // Deprecate after Rails stops using this
  GlobalOptions global_options = 5;
}

// This comment is left unintentionally blank.
message LastCommitForPathResponse {
  // commit is nil when the commit was not found
  GitCommit commit = 1;
}

// This comment is left unintentionally blank.
message ListLastCommitsForTreeRequest {
  Repository repository = 1 [(target_repository)=true];
  string revision = 2;
  bytes path = 3;
  int32 limit = 4;
  int32 offset = 5;
  bool literal_pathspec = 6 [deprecated = true];
  GlobalOptions global_options = 7;
}

// This comment is left unintentionally blank.
message ListLastCommitsForTreeResponse {
  // This comment is left unintentionally blank.
  message CommitForTree {
    reserved 1;

    GitCommit commit = 2;
    reserved 3;
    bytes path_bytes = 4;
  }
  repeated CommitForTree commits = 1;
}

// This comment is left unintentionally blank.
message CommitsByMessageRequest {
  Repository repository = 1 [(target_repository)=true];
  bytes revision = 2;
  int32 offset = 3;
  int32 limit = 4;
  bytes path = 5;
  string query = 6;
  GlobalOptions global_options = 7;
}

// One 'page' of the paginated response of CommitsByMessage
message CommitsByMessageResponse {
  repeated GitCommit commits = 1;
}

// This comment is left unintentionally blank.
message FilterShasWithSignaturesRequest {
  Repository repository = 1 [(target_repository)=true];
  repeated bytes shas = 2;
}

// This comment is left unintentionally blank.
message FilterShasWithSignaturesResponse {
  repeated bytes shas = 1;
}

// This comment is left unintentionally blank.
message ExtractCommitSignatureRequest {
  Repository repository = 1 [(target_repository)=true];
  string commit_id = 2;
}

// Either of the 'signature' and 'signed_text' fields may be present. It
// is up to the caller to stitch them together.
message ExtractCommitSignatureResponse {
  bytes signature = 1;
  bytes signed_text = 2;
}

// This comment is left unintentionally blank.
message GetCommitSignaturesRequest {
  Repository repository = 1 [(target_repository)=true];
  repeated string commit_ids = 2;
}

// This comment is left unintentionally blank.
message GetCommitSignaturesResponse {
  // Only present for a new commit signature data.
  string commit_id = 1;
  // See ExtractCommitSignatureResponse above for how these fields should be handled.
  bytes signature = 2;
  bytes signed_text = 3;
}

// This comment is left unintentionally blank.
message GetCommitMessagesRequest {
  Repository repository = 1 [(target_repository)=true];
  repeated string commit_ids = 2;
}

// This comment is left unintentionally blank.
message GetCommitMessagesResponse {
  // Only present for a new commit message
  string commit_id = 1;
  bytes message = 2;
}

// CheckObjectsExistRequest is a request for the CheckObjectsExist RPC. Only
// the initial request must contain a repository, the repository of all
// subsequent requests will be ignored.
message CheckObjectsExistRequest {
  // Repository is the repository in which existence of objects and refs
  // are checked.
  Repository repository = 1 [(target_repository)=true];
  // Revisions contains the revisions that shall be checked for existence. This accepts all revisions
  // as documented in gitrevisions(7)
  repeated bytes revisions = 2;
}

// This comment is left unintentionally blank.
message CheckObjectsExistResponse {
  // This comment is left unintentionally blank.
  message RevisionExistence {
    bytes name = 1;
    bool exists = 2;
  };

  repeated RevisionExistence revisions = 1;
}