package com.mintter.documents.v1alpha
Get desktop application:
View/edit binary Protocol Buffers messages
service Changes
changes.proto:12Changes service provides information about the atomic version controlled changes of Mintter objects.
rpc GetChangeInfo (, )
changes.proto:14Returns information about a single change.
message
changes.proto:21Request for getting change info.
string id = 1
ID of the Change.
rpc ListChanges (, )
changes.proto:17List changes of a given object.
message
changes.proto:27Request to list changes.
string document_id = 1
Required. ID of the Mintter object to list changes for.
int32 page_size = 2
Optional. Number of results per page.
string page_token = 3
Optional. Token for the page to return.
message
changes.proto:39Response with a list of changes.
repeated changes = 1
List of changes matching the request.
string next_page_token = 2
Token for the next page if there's any.
service Comments
comments.proto:11Comments service allows users to add comments to documents.
rpc CreateComment (, )
comments.proto:13Creates a new comment.
message
comments.proto:23Request to create a comment.
string target = 1
Required. The URI of the target hypermedia resource which is being commented. It's best to use versioned URIs to propagate better context and intent, even if the comments are eventually "overlaid" onto the newer versions of the resource.
string replied_comment = 2
Optional. If a comment is a reply to another comment, this must be the ID of the replied comment. The target of the reply and the replied comment must be the same (although version could differ if the reply is made reading a newer version of the document).
repeated content = 3
Required. Content of the comment.
rpc GetComment (, )
comments.proto:16Gets a single comment by ID.
message
comments.proto:39Request to get a comment.
string id = 1
Required. ID of the comment to retrieve.
rpc ListComments (, )
comments.proto:19Lists comments for a given target.
message
comments.proto:45Request to list comments.
string target = 1
Required. The URI of the target resource for which comments should be listed.
int32 page_size = 2
Optional. The maximum number of comments to return.
string page_token = 3
Optional. The page token obtained from a previous request (if any).
message
comments.proto:57Response with a list of comments.
repeated comments = 1
List of comments.
string next_page_token = 2
Token to retrieve the next page of comments (if necessary).
Content graph service provides access to citations (backlinks).
rpc ListCitations (, )
content_graph.proto:9message
content_graph.proto:12string document_id = 1
Required. Document ID for which citations need to be retrieved.
message
content_graph.proto:18Response with citations.
repeated links = 1
List of links that point to the requested document, recursively, according to the requested depth.
service Drafts
documents.proto:13Drafts service exposes the functionality
rpc CreateDraft (, )
documents.proto:15Creates a new draft with a new permanent document ID.
message
documents.proto:37Request to create a new draft.
string existing_document_id = 1
Optional. Existing Document ID can be specified to update previously published document. A draft will be created with the content of the most recent known version.
string version = 2
Optional. Version of the existing document to create draft from. If version is specified existing_document_id must also be specified.
rpc DeleteDraft (, )
documents.proto:18Deletes a draft by its document ID.
message
documents.proto:49Request to delete an existing draft.
string document_id = 1
ID of the document whose draft needs to be deleted. Only one
rpc GetDraft (, )
documents.proto:21Gets a single draft if exists.
message
documents.proto:55Request to get a single draft.
string document_id = 1
ID of the document for which draft was previously created.
rpc UpdateDraft (, )
documents.proto:24Updates a draft using granular update operations.
message
documents.proto:61Request to update an existing draft using granular operations.
string document_id = 3
ID of the document to be updated.
repeated changes = 4
List of document changes that must be applied to the existing document.
message
documents.proto:70Response after draft is updated.
string change_id = 1
The ID of the change representing the draft version after the update is processed.
optional updated_document = 2
The state of the document after the update.
rpc ListDrafts (, )
documents.proto:27List currently stored drafts.
message
documents.proto:110Request to list stored drafts.
int32 page_size = 1
Optional. Number of results per page.
string page_token = 2
Optional. Token for the page to return.
message
documents.proto:119Response for listing drafts.
repeated documents = 1
Drafts matching the list request. Content is omitted.
string next_page_token = 2
Token for the next page if there's any.
rpc ListDocumentDrafts (, )
documents.proto:30Lists drafts for a given document.
message
documents.proto:129Request to list document drafts.
string document_id = 1
ID of the document to list drafts for.
message
documents.proto:135Response with the list of drafts for a given document ID.
repeated drafts = 1
Drafts come without content, only metadata, similar to the rest of list responses.
rpc PublishDraft (, )
documents.proto:33Publishes a draft. I.e. draft will become a publication, and will no longer appear in drafts section.
message
documents.proto:142Request to publish a draft.
string document_id = 1
ID of the document which current draft needs to be published.
service Merge
documents.proto:227Merge service provides access to merge documents.
rpc MergeChanges (, )
documents.proto:229Merge changes and publishes.
message
documents.proto:236Request for merging changes in a document.
string id = 1
Required. Document ID from which versions are going to be taken.
repeated string versions = 2
Required. Versions to be merged.
rpc RebaseChanges (, )
documents.proto:232Rebase changes
message
documents.proto:245Request for rebasing changes in a document.
string base_draft_id = 1
Required. Draft ID to be rebased.
repeated string versions = 3
Required. Versions to be applied applied on top of the base document.
service Publications
documents.proto:150Publications service provides access to published documents.
rpc GetPublication (, )
documents.proto:152Gets a single publication.
message
documents.proto:165Request for getting a single publication.
string document_id = 1
Required. ID of the published document.
string version = 2
Optional. Specific version of the published document. If empty, the latest one is returned.
bool local_only = 3
Optional. If true, only local publications will be found. False by default. Deprecated: use [Entities.DiscoverEntity] API explicitly instead.
rpc ListPublications (, )
documents.proto:155Lists stored publications. Only the most recent versions show up.
message
documents.proto:187Request for listing publications.
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.
bool trusted_only = 3
Optional. When provided, the response will only contain publications *owned* (created) by trusted accounts of this node. By default, it returns all the publications (trusted_only = false)
rpc PushPublication (, )
documents.proto:158Push Local publication to the gateway.
message
documents.proto:178Request for getting a single publication.
string document_id = 1
Required. ID of the published document to be pushed.
string url = 2
Required. URL of the gateway to push to. Multiaddress format accepted (comma separated).
Lists publications owned by a given account.
message
documents.proto:212Request for listing publications owned by a given account.
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.
string account_id = 3
Required. Account ID to list publications for.
message
documents.proto:345Conceptual annotation "layer" that is applied to arbitrary spans of block text. An "identity" of the layer should be derived deterministically based on its type attributes. Spans inside the same annotation can't overlap. Spans are stored inside the Annotation in a "columnar" format, i.e. StructureOfArrays instead of ArrayOfStructures. See: https://en.wikipedia.org/wiki/AoS_and_SoA. This is useful to reduce the number of allocations and offers more compact serialization, because protobuf is able to "pack" primitive repeated fields more efficiently.
Used in:
string type = 1
Type of the annotation.
string ref = 5
Optional. A hyperlink to an external resource. Must be a valid URL.
map<string, string> attributes = 2
Arbitrary key-value attributes of the annotation.
repeated int32 starts = 3
Start offsets of possibly disjoint spans of text for which this annotation is applied. Must be sorted and have the same number of items as `ends` list.
repeated int32 ends = 4
End offsets of possibly disjoint spans of text for which this annotation is applied. Must be sorted and have the same number of items as `starts` list.
message
documents.proto:312Content block.
Used in: ,
string id = 1
Block ID. Must be unique within the document.
string type = 2
Type of the block. Specific to the renderer.
string text = 3
Text of the content block.
string ref = 7
Optional. The hyperlink to an external resource. Must be a valid URL.
map<string, string> attributes = 4
Arbitrary attributes of the block.
repeated annotations = 5
Annotation "layers" of the block.
string revision = 6
Output only. Current revision of the block. It's the ID of the last Change that modified this block. Additional information about the Change can be obtained using the Changes service.
message
documents.proto:303Content block with children.
Used in: , ,
optional block = 1
Content block.
repeated children = 2
Child blocks.
message
changes.proto:48Metadata about a single Change.
Used as response type in: Changes.GetChangeInfo
Used as field type in:
string id = 1
ID of the Change.
string author = 2
Author of the Change.
optional create_time = 3
Time when this change was recorded by the author.
string version = 4
The document version ID corresponding to this changes. TODO(burdiyan): after the breaking change the change ID can be used directly as version.
repeated string deps = 5
IDs of other Changes that are dependencies of this Change.
message
comments.proto:68Comment is a unit of discussion. Comments are created targeting some hypermedia resource (ideally with a versioned link). Replies are created targeting the same resource, in addition to pointing to the comment they are replying to.
Used as response type in: Comments.CreateComment, Comments.GetComment
Used as field type in:
string id = 1
ID of the current comment.
string target = 2
The URI of the target resource which the comment is attached to. This is normally a Hypermedia Document, but potentially can be anything. Reply comments should share the same target as the comment they are replying to, but could potentially point to a different version.
string thread_root = 3
The ID of the top-level non-reply comment of the conversation thread.
string replied_comment = 4
The ID of the comment to which this comment is a reply. For initial comments this field is empty.
string author = 5
Account ID of the author of the comment.
repeated content = 6
Content of the comment.
optional create_time = 7
Timestamp when the comment was created.
message
documents.proto:268Document represents metadata and content of a draft or publication.
Used as response type in: Drafts.CreateDraft, Drafts.GetDraft, Merge.RebaseChanges
Used as field type in: , , ,
string id = 1
Permanent ID of the document.
string title = 2
Title of the document.
string author = 4
Output only. Author ID of the document.
repeated string editors = 11
Output only. Account IDs of all the editors of the document. Includes the original author as well.
repeated children = 9
This is WIP feature for block-aware API. It will supersede the `content` field.
optional create_time = 6
Output only. Time when document was created.
optional update_time = 7
Output only. Time when document was updated.
optional publish_time = 8
Output only. Time when this version was published. Not present in drafts.
string version = 12
Output only. Current version of the document.
string previous_version = 13
Output only. Previous version of the document, unless this is the first version.
message
documents.proto:79Granular document change.
Used in:
oneof op
string set_title = 1
New title to set on the document.
move_block = 3
Move operation that creates/moves a block within the document hierarchy.
replace_block = 4
New block state that replaces an existing block.
string delete_block = 5
ID of a block to delete.
message
documents.proto:83Operation to move an existing block to a different place in the document. Move and Create operations are both expressed with this. Conceptually new blocks are moved out of nowhere into the document.
Used in:
string block_id = 1
ID of the block to move.
string parent = 2
ID of the new parent for the block being moved.
string left_sibling = 3
ID of the new left sibling for the block being moved.
message
content_graph.proto:24Description of a link inside a document.
Used in:
optional source = 1
Required. Describes where link originates from.
optional target = 2
Required. Describes where link points to. Here the block_id is optional, because the whole document can be linked.
bool is_latest = 3
Indicates whether the link targets the latest version of the document. Notice that the target link node might still have a version specified, which has to be treated as a frame of reference, i.e. "this version or newer" if is_latest is true.
message
content_graph.proto:40Describes "sides" of a Link.
Used in:
string document_id = 1
ID of the document on one side of a Link.
string version = 2
Version of the document.
string block_id = 3
ID of the block inside the document.
message
documents.proto:201Response with list of publications.
Used as response type in: Publications.ListAccountPublications, Publications.ListPublications
repeated publications = 1
List of publications matching the request. Only most recent versions are returned. Content is omitted, only metadata is present.
string next_page_token = 2
Token for the next page if there're more results.
message
documents.proto:258State of the document after publication. Deprecated: use the Document message instead, it has all the same fields.
Used as response type in: Drafts.PublishDraft, Merge.MergeChanges, Publications.GetPublication
Used as field type in:
string version = 1
Version points to the state of the publication at some point in time. Deprecated: use the version field of the Document message instead.
optional document = 2
Published document.