package com.mintter.entities.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

Provides functionality to query information about Hypermedia Entities.

• rpc GetChange (GetChangeRequest, Change)

  entities.proto:14

  Gets a change by ID.

  message GetChangeRequest

  entities.proto:42

  Request to get a change by ID.

  • string id = 1

    ID of the change.

• rpc GetEntityTimeline (GetEntityTimelineRequest, EntityTimeline)

  entities.proto:17

  Gets the DAG of changes for an entity.

  message GetEntityTimelineRequest

  entities.proto:48

  Request to get the timeline of an entity.

  • string id = 1

    The entity ID to get the timeline for.

  • bool include_drafts = 2

    Flag to include draft changes in the timeline, otherwise they are omitted by default.

  message EntityTimeline

  entities.proto:97

  The timeline of an entity.

  • string id = 1

    The ID of the entity.

  • string owner = 2

    Account ID of the owner of the entity.

  • map<string, Change> changes = 3

    The set of changes for the entity keyed by change ID.

  • repeated string changes_by_time = 4

    The sorted list of change IDs by time.

  • repeated string roots = 5

    The set of changes that has no dependencies. Normally there should only be one root, but just in case it's defined as a list.

  • repeated string heads = 6

    The set of leaf changes considering the entire DAG.

  • repeated AuthorVersion author_versions = 7

    The set of author versions/variants sorted by timestamp.

• rpc DiscoverEntity (DiscoverEntityRequest, DiscoverEntityResponse)

  entities.proto:20

  Triggers a best-effort discovery of an entity.

  message DiscoverEntityRequest

  entities.proto:58

  Request to discover an entity.

  • string id = 1

    Required. The entity ID to discover.

  • string version = 2

    Optional. Version of the entity to discover.

  message DiscoverEntityResponse

  entities.proto:67

  Response to discover an entity.

  TODO(burdiyan): add summary of the discovery process. Or maybe even make this call streaming?

  (message has no fields)

• rpc SearchEntities (SearchEntitiesRequest, SearchEntitiesResponse)

  entities.proto:25

  Finds the list of local entities whose titles match the input string. A fuzzy search is performed among documents, groups and accounts. For groups and documents, we match the title, while we match alias in accounts.

  message SearchEntitiesRequest

  entities.proto:169

  Request to

  • string query = 1

    Query to find. Since we use Fuzzy search, a single query may return multiple entities.

  message SearchEntitiesResponse

  entities.proto:177

  A list of entities matching the request.

  • repeated Entity entities = 1

    Entities matching the input title

  • string next_page_token = 2

    Token for the next page if there's any.

• rpc DeleteEntity (DeleteEntityRequest, google.protobuf.Empty)

  entities.proto:28

  Deletes an entity from the local node. It removes all the patches corresponding to it, including comments.

  message DeleteEntityRequest

  entities.proto:186

  Request for deleting an entity.

  • string id = 1

    Entity ID of the entity to be removed. All versions will also be removed.

  • string reason = 2

    Optional. Reason why the user wants to delete that entity.

• rpc ListDeletedEntities (ListDeletedEntitiesRequest, ListDeletedEntitiesResponse)

  entities.proto:31

  Lists deleted entities.

  message ListDeletedEntitiesRequest

  entities.proto:196

  Request for listing deleted entities.

  • int32 page_size = 1

    Optional. Number of results per page. Default is defined by the server.

  • string page_token = 2

    Optional. Value from next_page_token obtains from a previous response.

  message ListDeletedEntitiesResponse

  entities.proto:205

  Response with list of deleted entities.

  • repeated DeletedEntity deleted_entities = 1

    List of deleted entities.

  • string next_page_token = 2

    Token for the next page if there're more results.

• rpc UndeleteEntity (UndeleteEntityRequest, google.protobuf.Empty)

  entities.proto:35

  Undo the entity delition by removing the entity from the deleted list. That entity, if available will be synced back in the next syncing round (or manually discovered).

  message UndeleteEntityRequest

  entities.proto:214

  Request for restoring an entity.

  • string id = 1

    Entity ID of the entity to be restored. All versions will also be restored.

• rpc ListEntityMentions (ListEntityMentionsRequest, ListEntityMentionsResponse)

  entities.proto:38

  List mentions of a given Entity across the locally-available content.

  message ListEntityMentionsRequest

  entities.proto:221

  Request to list mentions of an entity.

  • string id = 1

    Required. ID of the entity to list mentions for.

  • int32 page_size = 2

    Optional. The size of the page to return by the server. The server may ignore this, and return a bigger response.

  • string page_token = 3

    Optional. The page token to continue the pagination.

  • bool reverse_order = 4

    Optional. Whether to return the results in descending order (newest-first). By default mentions are listed in the chronological order, according to the *locally perceived* order of the blobs that contain the mentions. I.e. we sort the links according to the time we receive the blobs, not according to the time blobs claim to have been created. This is to prevent losing new mentions in case of receiving out-of-date blobs. This flag must remain the same when paginating through the results.

  message ListEntityMentionsResponse

  entities.proto:244

  Response to list mentions of an entity.

  • repeated Mention mentions = 1

    Required. The list of mentions for the entity.

  • string next_page_token = 2

    Optional. Token for the next page if there's any.

Set of heads from a given author.

Used in: EntityTimeline

• string author = 1

  Account ID of the author.

• repeated string heads = 2

  The set of leaf changes from that author.

• string version = 3

  The version string corresponding to the author's variant. I.e. same as heads but concatenated with a '.' delimiter.

• optional google.protobuf.Timestamp version_time = 4

  The timestamp of the author's version. For compound versions the greatest timestamp is used.

A change to an entity.

Used as response type in: Entities.GetChange

Used as field type in: EntityTimeline

• string id = 1

  ID of the change.

• string author = 2

  Author of the change.

• optional google.protobuf.Timestamp create_time = 3

  Timestamp when the change was created.

• repeated string deps = 4

  IDs of other changes this change depends on.

• repeated string children = 6

  IDs of other changes that depend on this change.

• bool is_trusted = 5

  Indicates whether this changes comes from a trusted peer of ours.

• bool is_draft = 7

  Indicates whether this change is a draft.

Publication that has been deleted

Used in: ListDeletedEntitiesResponse

• string id = 1

  EID of the deleted entity.

• optional google.protobuf.Timestamp delete_time = 2

  When the entity was deleted.

• string deleted_reason = 3

  Reason why this entity was deleted.

• string metadata = 4

  Further metadata about the deleted entity, title, etc ...

A change to an entity.

Used in: SearchEntitiesResponse

• string id = 1

  EID of the entity.

• string title = 2

  Title of the entity, depending on the type: Alias in the case of account. Title in the case of groups and documents Empty in the case of comments.

• string owner = 3

  The owner of the entity

Mention of an Entity. Source means the place where the mention was found. Target means the entity being mentioned.

Used in: ListEntityMentionsResponse

• string source = 1

  Required. The ID of the source where the mention was found.

• string source_context = 2

  Optional. Context can mean different things depending on the type of the source: it can be the block ID when source is a Document or Comment, it can be a pretty-path when source is a Group that mentions a Document, it can also be empty.

• optional Mention.BlobInfo source_blob = 3

  Required. Information about the blob where the mention was found.

• string target_version = 4

  Optional. The version of the target Entity the link points to, if one is specified in the link.

• bool is_exact_version = 5

  Required. Specifies whether the link points to the exact/pinned version of the target document, or if the target version is a *suggested* minimum version, and a later one should be preferred if exists.

• string target_fragment = 6

  Optional. The fragment portion of the link.

Information about a structural blob that contains the mention.

Used in: Mention

• string cid = 1

  The CID-formatted hash of the blob.

• string author = 2

  The Account ID of the author of the blob.

• optional google.protobuf.Timestamp create_time = 3

  The timestamp of the blob.

• bool is_draft = 4

  Specifies whether the blob is a draft.