package com.mintter.groups.v1alpha
Get desktop application:
View/edit binary Protocol Buffers messages
service Groups
groups.proto:12Groups service exposes the functionality for managing group entities. This API uses fully-qualified EID as group IDs in all the requests.
rpc CreateGroup (, )
groups.proto:14Creates a new group.
message
groups.proto:45Request to create a group.
string title = 1
Required. Title of the new group.
string description = 2
Optional. Description of the new group.
map<string, Role> members = 3
Optional. List of initial members for the new group. Members can also be managed with separate requests after group is already created.
string site_setup_url = 4
Optional. Secret setup URL that is provided during site server deployment. I.e. a place on the Web where this group has to be published.
rpc GetGroup (, )
groups.proto:17Gets a group by ID.
message
groups.proto:62Request to get a group.
string id = 1
Required. ID of the group to get. Must be a fully-qualified EID.
string version = 2
Optional. Version of the group to get information about. If empty, latest_version is assumed.
rpc UpdateGroup (, )
groups.proto:20Updates a group.
message
groups.proto:76Request to update a group. Some fields are required, even if unchanged, to distinguish between setting the value to an empty string, from an unchanged value. Read the comments!
string id = 1
ID of the group to update.
string title = 2
Optional. Title of the Group. Can be omitted if unchanged. Cannot be cleared. Groups without title make no sense.
optional description = 3
Optional. Description of the Group. Using value wrapper to distinguish between clearing the value and leaving it unchanged.
map<string, Role> updated_members = 4
Optional. List of members to be updated in the Group. Key is the member's Account ID, value is the Role. To remove a member from the group, set the role to unspecified. Only updated records have to be sent, not all the members of the group.
map<string, string> updated_content = 5
Optional. List of content to be updated in the Group. Key is a pretty path on which the content is published, value is a Hypermedia URL of the content. To unpublish content set the value to an empty string for a given pretty path. Only updated records have to be sent, not all the content of the group.
string site_setup_url = 6
Optional. Secret setup URL that is provided during site server deployment. I.e. a place on the Web where this group has to be published.
rpc SyncGroupSite (, )
groups.proto:26Forces a sync of a group with its site. Only works for those groups that are published to sites. Could be useful to trigger the sync manually without having to wait for the next round of the automatic periodic sync.
message
groups.proto:109Request to sync group site.
string group_id = 1
Group ID to sync.
message
groups.proto:115Response for syncing a group site.
optional site_info = 1
The site info of a group after the sync.
rpc ListMembers (, )
groups.proto:29Lists members of a group.
message
groups.proto:121Request to list members.
string id = 1
Required. ID of the group to list members of.
string version = 2
Optional. Version of the group to list members of. If not specified, the latest version of the group according to its members is used.
int32 page_size = 3
Optional. Maximum number of members to return.
string page_token = 4
Optional. Page token to continue listing members from.
message
groups.proto:138Response to list members.
string owner_account_id = 1
ID of the group owner.
map<string, Role> members = 2
List of members of the group, including the owner.
string next_page_token = 3
Token to continue listing members from.
rpc ListContent (, )
groups.proto:32Lists content of a group.
message
groups.proto:150Request to list content.
string id = 1
Required. ID of the group to list content of.
string version = 2
Optional. Version of the group to list content of. If not specified, the latest version of the group according to its members is used.
int32 page_size = 3
Optional. Maximum number of content to return.
string page_token = 4
Optional. Page token to continue listing content from.
message
groups.proto:167Response to list content.
map<string, string> content = 1
List of content of the group. Key is the path and value is a Hypermedia URL to the content.
string next_page_token = 2
Token to continue listing content from.
rpc ListGroups (, )
groups.proto:35Lists groups.
message
groups.proto:177Request to list groups.
int32 page_size = 1
Optional. Maximum number of groups to return.
string page_token = 2
Optional. Page token to continue listing groups from.
message
groups.proto:186Response to list groups.
repeated groups = 1
List of groups.
string next_page_token = 2
Token to continue listing groups from.
rpc ListDocumentGroups (, )
groups.proto:38Lists groups that a document is published to.
message
groups.proto:195Request to list groups for a document.
string document_id = 1
Required. ID of the document to list groups for. Must be fully-qualified Entity ID.
int32 page_size = 2
Optional. Maximum number of groups to return.
string page_token = 3
Optional. Page token to continue listing groups from.
message
groups.proto:208Response to list groups for a document.
repeated items = 1
List of document publications in groups.
string next_page_token = 2
Token to continue listing groups from.
rpc ListAccountGroups (, )
groups.proto:41Lists groups that an account is a member of.
message
groups.proto:235Request to list groups for an account.
string account_id = 1
Required. ID of the account to list groups for. Must be Account ID, not the ID of the Account Entity.
int32 page_size = 2
Optional. Maximum number of groups to return.
string page_token = 3
Optional. Page token to continue listing groups from.
message
groups.proto:248Response to list groups for an account.
repeated items = 1
List of groups that the account is a member of with their role.
string next_page_token = 2
Token to continue listing groups from.
service Website
website.proto:9API service exposed by the website server. It's exposed as gRPC over Libp2p.
rpc GetSiteInfo (, )
website.proto:12Gets the public information about the website. This information is also available as JSON over HTTP on `/.well-known/hypermedia-site`.
message
website.proto:22Request for getting the public site information.
(message has no fields)
message
website.proto:48Publicly available information about the website.
optional peer_info = 1
P2P information for the website.
string group_id = 2
Group ID being served on the site. Can be empty if site is not initialized yet.
string group_version = 3
Version of the group according to the website server.
rpc InitializeServer (, )
website.proto:15Initializes the server to become a website for a specific group.
message
website.proto:25Request for initializing the site.
string secret = 1
Required. The secret provided during the site deployment process. It's a trust-on-first-use, one-time-use secret that is used for the initial site setup, during which the site remembers the groups that it must serve, and who is the owner of the site.
string group_id = 2
Required. ID of the group that should be served on this site.
message
website.proto:36Response for initializing the site.
(message has no fields)
rpc PublishBlobs (, )
website.proto:18Publishes blobs to the website.
message
website.proto:39Request for publishing blobs.
repeated string blobs = 1
List of blob CIDs that we expect to be available on the site.
message
website.proto:45Response for publishing blobs.
(message has no fields)
message
groups.proto:263Group represents the basic information about a group entity.
Used as response type in: Groups.CreateGroup, Groups.GetGroup, Groups.UpdateGroup
Used as field type in: ,
string id = 1
ID of the group.
string title = 2
Title of the group.
string description = 3
Description of the group.
string owner_account_id = 4
Account ID of the group owner.
optional create_time = 5
Timestamp when the group was first created.
string version = 6
Version of the group entity that is being returned by the server. When latest version is requested, this is the same as latest_version.
optional update_time = 7
Timestamp of the version of the group.
optional site_info = 8
Optional. Site-related information for groups that are published to sites.
message
groups.proto:265Extra metadata about Site Groups.
Used in: ,
string base_url = 1
Base Web URL of the Site where the Group is being published to.
optional last_sync_time = 2
Timestamp of the last sync of the Group's content with the Site. This field will be updated regardless of whether we were able to sync or not.
optional last_ok_sync_time = 3
Timestamp of the last successful sync of the Group's content with the Site.
string last_sync_error = 5
The error message from the last sync (if it was unsuccessful).
string version = 4
Version of the Group as per the Site.
message
groups.proto:249Used in:
optional group = 1
Role role = 2
message
groups.proto:209Used in:
string group_id = 1
ID of the group that the document is published to.
string change_id = 2
ID of the group change that published the document to the group. I.e. the version of the group that introduced the document to the group.
optional change_time = 3
Timestamp of the change that published the document to the group.
string path = 4
Path at which document is published.
string raw_url = 5
Raw URL that is published to the group.
message
website.proto:61Peer information for P2P network.
Used in:
string peer_id = 1
Libp2p peer ID.
repeated string addrs = 2
Multiaddrs for the peer, without the peer ID, in order to use it with libp2p AddrInfo API.
string account_id = 3
Mintter Account ID of the site.
enum Role
groups.proto:310Role of a group member.
Used in: , , ,
ROLE_UNSPECIFIED = 0
Zero value which is an invalid role. This role is used to delete members, and serves as a tombstone, because in our CRDT there's no way to truly delete something.
OWNER = 1
Output only. Role for an owner. Cannot be used in updates, can only be returned in queries.
EDITOR = 2
Editor role which allows members to manage content of the group.