usememos/memos

Fork 0

mirror of https://github.com/usememos/memos.git synced 2025-10-24 21:41:17 +08:00

Steven dd9ee44a1f docs: regenerate swagger

2024-01-29 22:05:33 +08:00

46 KiB

Raw Blame History

api/v2/activity_service.proto

Version: version not set

AuthService

/api/v2/auth/status

POST

Responses

Code	Description	Schema
200	A successful response.	v2GetAuthStatusResponse
default	An unexpected error response.	googlerpcStatus

InboxService

/api/v2/inboxes

GET

Parameters

Name	Located in	Description	Required	Schema
user	query	Format: users/{username}	No	string

Responses

Code	Description	Schema
200	A successful response.	v2ListInboxesResponse
default	An unexpected error response.	googlerpcStatus

/v2/inboxes

PATCH

Parameters

Name	Located in	Description	Required	Schema
inbox	body		Yes	v2Inbox

Responses

Code	Description	Schema
200	A successful response.	v2UpdateInboxResponse
default	An unexpected error response.	googlerpcStatus

/v2/{name}

DELETE

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the inbox to delete. Format: inboxes/{inbox}	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2DeleteInboxResponse
default	An unexpected error response.	googlerpcStatus

MarkdownService

/api/v2/markdown

POST

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v2ParseMarkdownRequest

Responses

Code	Description	Schema
200	A successful response.	v2ParseMarkdownResponse
default	An unexpected error response.	googlerpcStatus

MemoService

/api/v2/memos

GET

Summary

ListMemos lists memos with pagination and filter.

Parameters

Name	Located in	Description	Required	Schema
pageSize	query	The maximum number of memos to return.	No	integer
pageToken	query	A page token, received from a previous `ListMemos` call. Provide this to retrieve the subsequent page.	No	string
filter	query	Filter is used to filter memos returned in the list. Format: "creator == users/{username} && visibilities == ['PUBLIC', 'PROTECTED']"	No	string

Responses

Code	Description	Schema
200	A successful response.	v2ListMemosResponse
default	An unexpected error response.	googlerpcStatus

POST

Summary

CreateMemo creates a memo.

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v2CreateMemoRequest

Responses

Code	Description	Schema
200	A successful response.	v2CreateMemoResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/memos/stats

GET

Summary

GetUserMemosStats gets stats of memos for a user.

Parameters

Name	Located in	Description	Required	Schema
name	query	name is the name of the user to get stats for. Format: users/{username}	No	string
timezone	query	timezone location Format: uses tz identifier https://en.wikipedia.org/wiki/List_of_tz_database_time_zones	No	string
filter	query	Same as ListMemosRequest.filter	No	string

Responses

Code	Description	Schema
200	A successful response.	v2GetUserMemosStatsResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/memos/{id}

GET

Summary

GetMemo gets a memo by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2GetMemoResponse
default	An unexpected error response.	googlerpcStatus

DELETE

Summary

DeleteMemo deletes a memo by id.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2DeleteMemoResponse
default	An unexpected error response.	googlerpcStatus

PATCH

Summary

UpdateMemo updates a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer
body	body		Yes	MemoServiceUpdateMemoBody

Responses

Code	Description	Schema
200	A successful response.	v2UpdateMemoResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/memos/{id}/comments

GET

Summary

ListMemoComments lists comments for a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2ListMemoCommentsResponse
default	An unexpected error response.	googlerpcStatus

POST

Summary

CreateMemoComment creates a comment for a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path	id is the memo id to create comment for.	Yes	integer
create.content	query		No	string
create.visibility	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v2CreateMemoCommentResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/memos/{id}/relations

GET

Summary

ListMemoRelations lists relations for a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2ListMemoRelationsResponse
default	An unexpected error response.	googlerpcStatus

POST

Summary

SetMemoRelations sets relations for a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer
body	body		Yes	MemoServiceSetMemoRelationsBody

Responses

Code	Description	Schema
200	A successful response.	v2SetMemoRelationsResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/memos/{id}/resources

GET

Summary

ListMemoResources lists resources for a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2ListMemoResourcesResponse
default	An unexpected error response.	googlerpcStatus

POST

Summary

SetMemoResources sets resources for a memo.

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer
body	body		Yes	MemoServiceSetMemoResourcesBody

Responses

Code	Description	Schema
200	A successful response.	v2SetMemoResourcesResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/memos/{name}

GET

Summary

GetMemoByName gets a memo by name.

Parameters

Name	Located in	Description	Required	Schema
name	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2GetMemoByNameResponse
default	An unexpected error response.	googlerpcStatus

ResourceService

/api/v2/resources

GET

Responses

Code	Description	Schema
200	A successful response.	v2ListResourcesResponse
default	An unexpected error response.	googlerpcStatus

POST

Parameters

Name	Located in	Required	Schema
filename	query	No	string
externalLink	query	No	string
type	query	No	string
memoId	query	No	integer

Responses

Code	Description	Schema
200	A successful response.	v2CreateResourceResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/resources/{id}

GET

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2GetResourceResponse
default	An unexpected error response.	googlerpcStatus

DELETE

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2DeleteResourceResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/resources/{name}

GET

Parameters

Name	Located in	Description	Required	Schema
name	path		Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2GetResourceByNameResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/resources/{resource.id}

PATCH

Parameters

Name	Located in	Description	Required	Schema
resource.id	path	id is the system generated unique identifier.	Yes	integer
resource	body		Yes	{ "name": string, "createTime": dateTime, "filename": string, "externalLink": string, "type": string, "size": string (int64), "memoId": integer }

Responses

Code	Description	Schema
200	A successful response.	v2UpdateResourceResponse
default	An unexpected error response.	googlerpcStatus

TagService

/api/v2/tags

GET

Parameters

Name	Located in	Description	Required	Schema
user	query	The creator of tags. Format: users/{username}	No	string

Responses

Code	Description	Schema
200	A successful response.	v2ListTagsResponse
default	An unexpected error response.	googlerpcStatus

DELETE

Parameters

Name	Located in	Description	Required	Schema
tag.name	query		No	string
tag.creator	query	The creator of tags. Format: users/{username}	No	string

Responses

Code	Description	Schema
200	A successful response.	v2DeleteTagResponse
default	An unexpected error response.	googlerpcStatus

POST

Parameters

Name	Located in	Description	Required	Schema
name	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v2UpsertTagResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/tags/suggestion

GET

Parameters

Name	Located in	Description	Required	Schema
user	query	The creator of tags. Format: users/{username}	No	string

Responses

Code	Description	Schema
200	A successful response.	v2GetTagSuggestionsResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/tags:rename

PATCH

Parameters

Name	Located in	Description	Required	Schema
user	query	The creator of tags. Format: users/{username}	No	string
oldName	query		No	string
newName	query		No	string

Responses

Code	Description	Schema
200	A successful response.	v2RenameTagResponse
default	An unexpected error response.	googlerpcStatus

UserService

/api/v2/users

GET

Summary

ListUsers returns a list of users.

Responses

Code	Description	Schema
200	A successful response.	v2ListUsersResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/{name}

GET

Summary

GetUser gets a user by name.

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the user. Format: users/{username}	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2GetUserResponse
default	An unexpected error response.	googlerpcStatus

DELETE

Summary

DeleteUser deletes a user.

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the user. Format: users/{username}	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2DeleteUserResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/{name}/access_tokens

GET

Summary

ListUserAccessTokens returns a list of access tokens for a user.

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the user. Format: users/{username}	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2ListUserAccessTokensResponse
default	An unexpected error response.	googlerpcStatus

POST

Summary

CreateUserAccessToken creates a new access token for a user.

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the user. Format: users/{username}	Yes	string
body	body		Yes	UserServiceCreateUserAccessTokenBody

Responses

Code	Description	Schema
200	A successful response.	v2CreateUserAccessTokenResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/{name}/access_tokens/{accessToken}

DELETE

Summary

DeleteUserAccessToken deletes an access token for a user.

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the user. Format: users/{username}	Yes	string
accessToken	path	access_token is the access token to delete.	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2DeleteUserAccessTokenResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/{name}/setting

GET

Parameters

Name	Located in	Description	Required	Schema
name	path	The name of the user. Format: users/{username}	Yes	string

Responses

Code	Description	Schema
200	A successful response.	v2GetUserSettingResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/{setting.name}

PATCH

Parameters

Name	Located in	Description	Required	Schema
setting.name	path	The name of the user. Format: users/{username}	Yes	string
setting	body		Yes	{ "locale": string, "appearance": string, "memoVisibility": string, "telegramUserId": string }

Responses

Code	Description	Schema
200	A successful response.	v2UpdateUserSettingResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/{user.name}

PATCH

Summary

UpdateUser updates a user.

Parameters

Name	Located in	Description	Required	Schema
user.name	path	The name of the user. Format: users/{username}	Yes	string
user	body		Yes	{ "id": integer, "role": UserRole, "username": string, "email": string, "nickname": string, "avatarUrl": string, "password": string, "rowStatus": apiv2RowStatus, "createTime": dateTime, "updateTime": dateTime }

Responses

Code	Description	Schema
200	A successful response.	v2UpdateUserResponse
default	An unexpected error response.	googlerpcStatus

/v1/users

POST

Summary

CreateUser creates a new user.

Parameters

Name	Located in	Description	Required	Schema
user	body		Yes	v2User

Responses

Code	Description	Schema
200	A successful response.	v2CreateUserResponse
default	An unexpected error response.	googlerpcStatus

WebhookService

/api/v2/webhooks

GET

Parameters

Name	Located in	Description	Required	Schema
creatorId	query		No	integer

Responses

Code	Description	Schema
200	A successful response.	v2ListWebhooksResponse
default	An unexpected error response.	googlerpcStatus

POST

Parameters

Name	Located in	Description	Required	Schema
body	body		Yes	v2CreateWebhookRequest

Responses

Code	Description	Schema
200	A successful response.	v2CreateWebhookResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/webhooks/{id}

GET

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2GetWebhookResponse
default	An unexpected error response.	googlerpcStatus

DELETE

Parameters

Name	Located in	Description	Required	Schema
id	path		Yes	integer

Responses

Code	Description	Schema
200	A successful response.	v2DeleteWebhookResponse
default	An unexpected error response.	googlerpcStatus

/api/v2/webhooks/{webhook.id}

PATCH

Parameters

Name	Located in	Description	Required	Schema
webhook.id	path		Yes	integer
body	body		Yes	WebhookServiceUpdateWebhookBody

Responses

Code	Description	Schema
200	A successful response.	v2UpdateWebhookResponse
default	An unexpected error response.	googlerpcStatus

WorkspaceService

/api/v2/workspace/profile

GET

Responses

Code	Description	Schema
200	A successful response.	v2GetWorkspaceProfileResponse
default	An unexpected error response.	googlerpcStatus

PATCH

Parameters

Name	Located in	Description	Required	Schema
workspaceProfile	body	System info is the updated data.	Yes	v2WorkspaceProfile

Responses

Code	Description	Schema
200	A successful response.	v2UpdateWorkspaceProfileResponse
default	An unexpected error response.	googlerpcStatus

ActivityService

/v2/activities

GET

Parameters

Name	Located in	Description	Required	Schema
id	query		No	integer

Responses

Code	Description	Schema
200	A successful response.	v2GetActivityResponse
default	An unexpected error response.	googlerpcStatus

Models

MemoServiceSetMemoRelationsBody

Name	Type	Description	Required
relations	[ v2MemoRelation ]		No

MemoServiceSetMemoResourcesBody

Name	Type	Description	Required
resources	[ v2Resource ]		No

MemoServiceUpdateMemoBody

Name	Type	Description	Required
memo	v2Memo		No
updateMask	string		No

TableNodeRow

Name	Type	Description	Required
cells	[ string ]		No

UserRole

Name	Type	Description	Required
UserRole	string

UserServiceCreateUserAccessTokenBody

Name	Type	Description	Required
description	string		No
expiresAt	dateTime		No

WebhookServiceUpdateWebhookBody

Name	Type	Description	Required
webhook	{ "creatorId": integer, "createdTime": dateTime, "updatedTime": dateTime, "rowStatus": apiv2RowStatus, "name": string, "url": string }		No
updateMask	string		No

apiv2ActivityMemoCommentPayload

Name	Type	Description	Required
memoId	integer		No
relatedMemoId	integer		No

apiv2ActivityPayload

Name	Type	Description	Required
memoComment	apiv2ActivityMemoCommentPayload		No
versionUpdate	apiv2ActivityVersionUpdatePayload		No

apiv2ActivityVersionUpdatePayload

Name	Type	Description	Required
version	string		No

apiv2RowStatus

Name	Type	Description	Required
apiv2RowStatus	string

apiv2UserSetting

Name	Type	Description	Required
name	string		No
locale	string	The preferred locale of the user.	No
appearance	string	The preferred appearance of the user.	No
memoVisibility	string	The default visibility of the memo.	No
telegramUserId	string	The telegram user id of the user.	No

apiv2Webhook

Name	Type	Required
id	integer	No
creatorId	integer	No
createdTime	dateTime	No
updatedTime	dateTime	No
rowStatus	apiv2RowStatus	No
name	string	No
url	string	No

googlerpcStatus

Name	Type	Required
code	integer	No
message	string	No
details	[ protobufAny ]	No

protobufAny

Name	Type	Description	Required
@type	string		No

v2Activity

Name	Type	Required
id	integer	No
creatorId	integer	No
type	string	No
level	string	No
createTime	dateTime	No
payload	apiv2ActivityPayload	No

v2AutoLinkNode

Name	Type	Description	Required
url	string		No
isRawText	boolean		No

v2BlockquoteNode

Name	Type	Description	Required
children	[ v2Node ]		No

v2BoldItalicNode

Name	Type	Description	Required
symbol	string		No
content	string		No

v2BoldNode

Name	Type	Description	Required
symbol	string		No
children	[ v2Node ]		No

v2CodeBlockNode

Name	Type	Description	Required
language	string		No
content	string		No

v2CodeNode

Name	Type	Description	Required
content	string		No

v2CreateMemoCommentResponse

Name	Type	Description	Required
memo	v2Memo		No

v2CreateMemoRequest

Name	Type	Description	Required
content	string		No
visibility	v2Visibility		No

v2CreateMemoResponse

Name	Type	Description	Required
memo	v2Memo		No

v2CreateResourceResponse

Name	Type	Description	Required
resource	v2Resource		No

v2CreateUserAccessTokenResponse

Name	Type	Description	Required
accessToken	v2UserAccessToken		No

v2CreateUserResponse

Name	Type	Description	Required
user	v2User		No

v2CreateWebhookRequest

Name	Type	Description	Required
name	string		No
url	string		No

v2CreateWebhookResponse

Name	Type	Description	Required
webhook	apiv2Webhook		No

v2DeleteInboxResponse

Name	Type	Description	Required
v2DeleteInboxResponse	object

v2DeleteMemoResponse

Name	Type	Description	Required
v2DeleteMemoResponse	object

v2DeleteResourceResponse

Name	Type	Description	Required
v2DeleteResourceResponse	object

v2DeleteTagResponse

Name	Type	Description	Required
v2DeleteTagResponse	object

v2DeleteUserAccessTokenResponse

Name	Type	Description	Required
v2DeleteUserAccessTokenResponse	object

v2DeleteUserResponse

Name	Type	Description	Required
v2DeleteUserResponse	object

v2DeleteWebhookResponse

Name	Type	Description	Required
v2DeleteWebhookResponse	object

v2EmbeddedContentNode

Name	Type	Description	Required
resourceName	string		No
params	string		No

v2EscapingCharacterNode

Name	Type	Description	Required
symbol	string		No

v2GetActivityResponse

Name	Type	Description	Required
activity	v2Activity		No

v2GetAuthStatusResponse

Name	Type	Description	Required
user	v2User		No

v2GetMemoByNameResponse

Name	Type	Description	Required
memo	v2Memo		No

v2GetMemoResponse

Name	Type	Description	Required
memo	v2Memo		No

v2GetResourceByNameResponse

Name	Type	Description	Required
resource	v2Resource		No

v2GetResourceResponse

Name	Type	Description	Required
resource	v2Resource		No

v2GetTagSuggestionsResponse

Name	Type	Description	Required
tags	[ string ]		No

v2GetUserMemosStatsResponse

Name	Type	Description	Required
stats	object	stats is the stats of memo creating/updating activities. key is the year-month-day string. e.g. "2020-01-01".	No

v2GetUserResponse

Name	Type	Description	Required
user	v2User		No

v2GetUserSettingResponse

Name	Type	Description	Required
setting	apiv2UserSetting		No

v2GetWebhookResponse

Name	Type	Description	Required
webhook	apiv2Webhook		No

v2GetWorkspaceProfileResponse

Name	Type	Description	Required
workspaceProfile	v2WorkspaceProfile		No

v2HeadingNode

Name	Type	Description	Required
level	integer		No
children	[ v2Node ]		No

v2HighlightNode

Name	Type	Description	Required
content	string		No

v2HorizontalRuleNode

Name	Type	Description	Required
symbol	string		No

v2ImageNode

Name	Type	Description	Required
altText	string		No
url	string		No

v2Inbox

Name	Type	Required
name	string	No
sender	string	No
receiver	string	No
status	v2InboxStatus	No
createTime	dateTime	No
type	v2InboxType	No
activityId	integer	No

v2InboxStatus

Name	Type	Description	Required
v2InboxStatus	string

v2InboxType

Name	Type	Description	Required
v2InboxType	string

v2ItalicNode

Name	Type	Description	Required
symbol	string		No
content	string		No

v2LineBreakNode

Name	Type	Description	Required
v2LineBreakNode	object

v2LinkNode

Name	Type	Description	Required
text	string		No
url	string		No

v2ListInboxesResponse

Name	Type	Description	Required
inboxes	[ v2Inbox ]		No

v2ListMemoCommentsResponse

Name	Type	Description	Required
memos	[ v2Memo ]		No

v2ListMemoRelationsResponse

Name	Type	Description	Required
relations	[ v2MemoRelation ]		No

v2ListMemoResourcesResponse

Name	Type	Description	Required
resources	[ v2Resource ]		No

v2ListMemosResponse

Name	Type	Description	Required
memos	[ v2Memo ]		No
nextPageToken	string	A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.	No

v2ListResourcesResponse

Name	Type	Description	Required
resources	[ v2Resource ]		No

v2ListTagsResponse

Name	Type	Description	Required
tags	[ v2Tag ]		No

v2ListUserAccessTokensResponse

Name	Type	Description	Required
accessTokens	[ v2UserAccessToken ]		No

v2ListUsersResponse

Name	Type	Description	Required
users	[ v2User ]		No

v2ListWebhooksResponse

Name	Type	Description	Required
webhooks	[ apiv2Webhook ]		No

v2MathBlockNode

Name	Type	Description	Required
content	string		No

v2MathNode

Name	Type	Description	Required
content	string		No

v2Memo

Name	Type	Description	Required
id	integer	id is the system generated unique identifier.	No
name	string	name is the user provided name.	No
rowStatus	apiv2RowStatus		No
creator	string		No
creatorId	integer		No
createTime	dateTime		No
updateTime	dateTime		No
displayTime	dateTime		No
content	string		No
nodes	[ v2Node ]		No
visibility	v2Visibility		No
pinned	boolean		No
parentId	integer		No
resources	[ v2Resource ]		No
relations	[ v2MemoRelation ]		No

v2MemoRelation

Name	Type	Required
memoId	integer	No
relatedMemoId	integer	No
type	v2MemoRelationType	No

v2MemoRelationType

Name	Type	Description	Required
v2MemoRelationType	string

v2Node

Name	Type	Required
type	v2NodeType	No
lineBreakNode	v2LineBreakNode	No
paragraphNode	v2ParagraphNode	No
codeBlockNode	v2CodeBlockNode	No
headingNode	v2HeadingNode	No
horizontalRuleNode	v2HorizontalRuleNode	No
blockquoteNode	v2BlockquoteNode	No
orderedListNode	v2OrderedListNode	No
unorderedListNode	v2UnorderedListNode	No
taskListNode	v2TaskListNode	No
mathBlockNode	v2MathBlockNode	No
tableNode	v2TableNode	No
embeddedContentNode	v2EmbeddedContentNode	No
textNode	v2TextNode	No
boldNode	v2BoldNode	No
italicNode	v2ItalicNode	No
boldItalicNode	v2BoldItalicNode	No
codeNode	v2CodeNode	No
imageNode	v2ImageNode	No
linkNode	v2LinkNode	No
autoLinkNode	v2AutoLinkNode	No
tagNode	v2TagNode	No
strikethroughNode	v2StrikethroughNode	No
escapingCharacterNode	v2EscapingCharacterNode	No
mathNode	v2MathNode	No
highlightNode	v2HighlightNode	No
subscriptNode	v2SubscriptNode	No
superscriptNode	v2SuperscriptNode	No
referencedContentNode	v2ReferencedContentNode	No

v2NodeType

Name	Type	Description	Required
v2NodeType	string

v2OrderedListNode

Name	Type	Required
number	string	No
indent	integer	No
children	[ v2Node ]	No

v2ParagraphNode

Name	Type	Description	Required
children	[ v2Node ]		No

v2ParseMarkdownRequest

Name	Type	Description	Required
markdown	string		No

v2ParseMarkdownResponse

Name	Type	Description	Required
nodes	[ v2Node ]		No

v2ReferencedContentNode

Name	Type	Description	Required
resourceName	string		No
params	string		No

v2RenameTagResponse

Name	Type	Description	Required
tag	v2Tag		No

v2Resource

Name	Type	Description	Required
id	integer	id is the system generated unique identifier.	No
name	string	name is the user provided name.	No
createTime	dateTime		No
filename	string		No
externalLink	string		No
type	string		No
size	string (int64)		No
memoId	integer		No

v2SetMemoRelationsResponse

Name	Type	Description	Required
v2SetMemoRelationsResponse	object

v2SetMemoResourcesResponse

Name	Type	Description	Required
v2SetMemoResourcesResponse	object

v2StrikethroughNode

Name	Type	Description	Required
content	string		No

v2SubscriptNode

Name	Type	Description	Required
content	string		No

v2SuperscriptNode

Name	Type	Description	Required
content	string		No

v2TableNode

Name	Type	Required
header	[ string ]	No
delimiter	[ string ]	No
rows	[ TableNodeRow ]	No

v2Tag

Name	Type	Description	Required
name	string		No
creator	string		No

v2TagNode

Name	Type	Description	Required
content	string		No

v2TaskListNode

Name	Type	Required
symbol	string	No
indent	integer	No
complete	boolean	No
children	[ v2Node ]	No

v2TextNode

Name	Type	Description	Required
content	string		No

v2UnorderedListNode

Name	Type	Required
symbol	string	No
indent	integer	No
children	[ v2Node ]	No

v2UpdateInboxResponse

Name	Type	Description	Required
inbox	v2Inbox		No

v2UpdateMemoResponse

Name	Type	Description	Required
memo	v2Memo		No

v2UpdateResourceResponse

Name	Type	Description	Required
resource	v2Resource		No

v2UpdateUserResponse

Name	Type	Description	Required
user	v2User		No

v2UpdateUserSettingResponse

Name	Type	Description	Required
setting	apiv2UserSetting		No

v2UpdateWebhookResponse

Name	Type	Description	Required
webhook	apiv2Webhook		No

v2UpdateWorkspaceProfileResponse

Name	Type	Description	Required
workspaceProfile	v2WorkspaceProfile		No

v2UpsertTagResponse

Name	Type	Description	Required
tag	v2Tag		No

v2User

Name	Type	Required
name	string	No
id	integer	No
role	UserRole	No
username	string	No
email	string	No
nickname	string	No
avatarUrl	string	No
password	string	No
rowStatus	apiv2RowStatus	No
createTime	dateTime	No
updateTime	dateTime	No

v2UserAccessToken

Name	Type	Required
accessToken	string	No
description	string	No
issuedAt	dateTime	No
expiresAt	dateTime	No

v2Visibility

Name	Type	Description	Required
v2Visibility	string

v2WorkspaceProfile

Name	Type	Required
version	string	No
mode	string	No
allowRegistration	boolean	No
disablePasswordLogin	boolean	No
additionalScript	string	No
additionalStyle	string	No

46 KiB Raw Blame History

api/v2/activity_service.proto

Version: version not set

AuthService

/api/v2/auth/status

POST

Responses

InboxService

/api/v2/inboxes

GET

Parameters

Responses

/v2/inboxes

PATCH

Parameters

Responses

/v2/{name}

DELETE

Parameters

Responses

MarkdownService

/api/v2/markdown

POST

Parameters

Responses

MemoService

/api/v2/memos

GET

Summary

Parameters

Responses

POST

Summary

Parameters

Responses

/api/v2/memos/stats

GET

Summary

Parameters

Responses

/api/v2/memos/{id}

GET

Summary

Parameters

Responses

DELETE

Summary

Parameters

Responses

PATCH

Summary

Parameters

Responses

/api/v2/memos/{id}/comments

GET

Summary

Parameters

Responses

POST

Summary

Parameters

Responses

/api/v2/memos/{id}/relations

GET

Summary

Parameters

Responses

POST

Summary

Parameters

Responses

/api/v2/memos/{id}/resources

GET

Summary

Parameters

Responses

POST

Summary

Parameters

Responses

46 KiB

Raw Blame History