Protocol reference

Grovedock speaks gRPC (HTTP/2, and gRPC-Web for browsers). The pando.v1 package is stable: it changes only by adding. Generate a client for any language from the files below; the SDKs wrap the read calls for Python, TypeScript and Go.

Calls to a server that hosts many repositories name one with the x-pando-repo: OWNER/NAME header. Every call takes a bearer token in authorization when the server requires one.

`pando.proto`

Source

Objects

Tier-agnostic object service. Served identically by server, cache and daemon.

Call	Request	Response	What it does
`Get`	`IdList`	`stream ObjectPayload`
`Put`	`stream ObjectPayload`	`PutObjectsResponse`
`Missing`	`IdList`	`IdList`	Returns the subset of ids the tier cannot serve.

Changesets

Call	Request	Response	What it does
`Create`	`CreateChangesetRequest`	`ChangesetInfo`
`Get`	`ResolveRequest`	`ChangesetInfo`

Refs

Call	Request	Response
`Get`	`RefName`	`RefValue`
`CompareAndSwap`	`CasRequest`	`CasResponse`
`List`	`Empty`	`RefList`

Land

Server-side rebase + lock-free compare-and-swap of a ref.

Call	Request	Response	What it does
`Land`	`LandRequest`	`LandResponse`

History

Call	Request	Response	What it does
`Log`	`LogRequest`	`stream ChangesetInfo`
`Blame`	`BlameRequest`	`BlameResponse`

Diff

Call	Request	Response	What it does
`Diff`	`DiffRequest`	`DiffResponse`

MergeBase

Call	Request	Response	What it does
`MergeBase`	`MergeBaseRequest`	`MergeBaseResponse`

Browse

API-first file access: CI and tools read source without any checkout.

Call	Request	Response	What it does
`ListDir`	`BrowseRequest`	`ListDirResponse`
`ReadFile`	`BrowseRequest`	`ReadFileResponse`
`Find`	`FindRequest`	`FindResponse`
`Checkout`	`CheckoutRequest`	`stream CheckoutPiece`	Path-scoped checkout: only files the caller may read. Used by principals with restricted read access, who may not read objects by id.

Access

Call	Request	Response	What it does
`WhoAmI`	`Empty`	`WhoAmIResponse`

Locks

Call	Request	Response
`Lock`	`LockRequest`	`LockInfo`
`Unlock`	`UnlockRequest`	`Empty`
`List`	`ListLocksRequest`	`LockList`

`pando_platform.proto`

Source

Platform

Call	Request	Response	What it does
`Viewer`	`Empty`	`ViewerResponse`
`GetAccount`	`OrgName`	`Account`
`ListOrganizations`	`Empty`	`ListOrganizationsResponse`
`GetOrganization`	`OrgName`	`Organization`
`CreateOrganization`	`CreateOrganizationRequest`	`Organization`
`ListMembers`	`OrgName`	`ListMembersResponse`
`SetMember`	`SetMemberRequest`	`Member`
`ListTeams`	`OrgName`	`ListTeamsResponse`
`SetTeam`	`Team`	`Team`	Creates the team, or replaces its name, description and members.
`DeleteTeam`	`TeamRef`	`Empty`
`ListRepositories`	`ListRepositoriesRequest`	`ListRepositoriesResponse`
`GetRepository`	`RepositoryRef`	`Repository`
`CreateRepository`	`CreateRepositoryRequest`	`Repository`
`UpdateRepository`	`UpdateRepositoryRequest`	`Repository`
`ListGrants`	`RepositoryRef`	`ListGrantsResponse`
`SetGrant`	`SetGrantRequest`	`Grant`
`ListTokens`	`Empty`	`ListTokensResponse`
`CreateToken`	`CreateTokenRequest`	`CreateTokenResponse`
`RevokeToken`	`RevokeTokenRequest`	`Empty`
`ListWebhooks`	`RepositoryRef`	`ListWebhooksResponse`
`CreateWebhook`	`CreateWebhookRequest`	`CreateWebhookResponse`
`DeleteWebhook`	`WebhookRef`	`Empty`
`ListWebhookDeliveries`	`WebhookRef`	`ListWebhookDeliveriesResponse`
`PingWebhook`	`WebhookRef`	`WebhookDelivery`	Sends a `ping` event now.
`ListSignupAllow`	`Empty`	`ListSignupAllowResponse`	Who may create an account by signing in when `--signup waitlist`: email addresses and `@domain` entries. Site administrators only.
`SetSignupAllow`	`SetSignupAllowRequest`	`Empty`
`LinkIdentity`	`LinkIdentityRequest`	`Empty`	Lets an identity sign in as an existing account, e.g. the first administrator’s email address. Site administrators only.
`CreateInvitation`	`CreateInvitationRequest`	`CreateInvitationResponse`	Invitations to an organisation: a single-use link, valid 7 days, emailed when the server sends mail. Whoever opens it and signs in joins with the role. Organisation administrators.
`ListInvitations`	`OrgName`	`ListInvitationsResponse`	Invitations not yet accepted, including expired ones.
`RevokeInvitation`	`InvitationRef`	`Empty`
`GetUsage`	`GetUsageRequest`	`Usage`	Plans and usage (ADR-035). An organisation’s active agents, people, storage and limits: its administrators and site administrators.
`SetLimits`	`SetLimitsRequest`	`OrgLimits`	Replaces an organisation’s limits (not its suspension). Site administrators only.
`SetSuspended`	`SetSuspendedRequest`	`OrgLimits`	A suspended organisation can read but not write. Site administrators only.
`GetCapabilities`	`Empty`	`Capabilities`	What this server offers: anyone may ask.
`GetLicense`	`Empty`	`License`	The support licence this server was started with. Site administrators only.

Issues

Call	Request	Response
`ListIssues`	`ListIssuesRequest`	`ListIssuesResponse`
`GetIssue`	`IssueRef`	`Issue`
`CreateIssue`	`CreateIssueRequest`	`Issue`
`UpdateIssue`	`UpdateIssueRequest`	`Issue`
`ListIssueComments`	`IssueRef`	`ListCommentsResponse`
`AddIssueComment`	`AddIssueCommentRequest`	`Comment`

Reviews

Call	Request	Response	What it does
`ListChangeRequests`	`ListChangeRequestsRequest`	`ListChangeRequestsResponse`
`GetChangeRequest`	`ChangeRequestRef`	`ChangeRequest`
`CreateChangeRequest`	`CreateChangeRequestRequest`	`ChangeRequest`
`UpdateChangeRequest`	`UpdateChangeRequestRequest`	`ChangeRequest`
`ListComments`	`ChangeRequestRef`	`ListCommentsResponse`
`AddComment`	`AddCommentRequest`	`Comment`
`ResolveThread`	`ResolveThreadRequest`	`Comment`
`SubmitReview`	`SubmitReviewRequest`	`ChangeRequest`
`Land`	`ChangeRequestRef`	`LandChangeRequestResponse`
`Rebase`	`ChangeRequestRef`	`ChangeRequest`	Re-applies the change on the target’s tip. Edits that do not overlap what landed since are carried over; otherwise it fails with FAILED_PRECONDITION naming the files that conflict. Approvals made on the old version stop counting when the protection says so.
`ListProtections`	`RepositoryRef`	`ListProtectionsResponse`
`SetProtection`	`Protection`	`Protection`
`DeleteProtection`	`ProtectionRef`	`Empty`
`ReportCheck`	`ReportCheckRequest`	`ChangeRequest`
`Inbox`	`InboxRequest`	`InboxResponse`
`ListEvents`	`ListEventsRequest`	`ListEventsResponse`

Keyboard shortcuts