UNPKG

@yuzhi-jiang/memos-mcp

Version:

MCP服务器,连接到Memos API并提供搜索、管理和改进功能

1,649 lines 92.6 kB
swagger: "2.0" info: title: api/v1/activity_service.proto version: version not set tags: - name: ActivityService - name: UserService - name: AuthService - name: IdentityProviderService - name: InboxService - name: MarkdownService - name: ResourceService - name: MemoService - name: WebhookService - name: WorkspaceService - name: WorkspaceSettingService consumes: - application/json produces: - application/json paths: /api/v1/auth/signin: post: summary: SignIn signs in the user with the given username and password. operationId: AuthService_SignIn responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: username description: The username to sign in with. in: query required: false type: string - name: password description: The password to sign in with. in: query required: false type: string - name: neverExpire description: Whether the session should never expire. in: query required: false type: boolean tags: - AuthService /api/v1/auth/signin/sso: post: summary: SignInWithSSO signs in the user with the given SSO code. operationId: AuthService_SignInWithSSO responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: idpId description: The ID of the SSO provider. in: query required: false type: integer format: int32 - name: code description: The code to sign in with. in: query required: false type: string - name: redirectUri description: The redirect URI. in: query required: false type: string tags: - AuthService /api/v1/auth/signout: post: summary: SignOut signs out the user. operationId: AuthService_SignOut responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - AuthService /api/v1/auth/signup: post: summary: SignUp signs up the user with the given username and password. operationId: AuthService_SignUp responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: username description: The username to sign up with. in: query required: false type: string - name: password description: The password to sign up with. in: query required: false type: string tags: - AuthService /api/v1/auth/status: post: summary: GetAuthStatus returns the current auth status of the user. operationId: AuthService_GetAuthStatus responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - AuthService /api/v1/identityProviders: get: summary: ListIdentityProviders lists identity providers. operationId: IdentityProviderService_ListIdentityProviders responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListIdentityProvidersResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - IdentityProviderService post: summary: CreateIdentityProvider creates an identity provider. operationId: IdentityProviderService_CreateIdentityProvider responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1IdentityProvider' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: identityProvider description: The identityProvider to create. in: body required: true schema: $ref: '#/definitions/apiv1IdentityProvider' tags: - IdentityProviderService /api/v1/inboxes: get: summary: ListInboxes lists inboxes for a user. operationId: InboxService_ListInboxes responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListInboxesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user description: 'Format: users/{user}' in: query required: false type: string - name: pageSize description: The maximum number of inbox to return. in: query required: false type: integer format: int32 - name: pageToken description: Provide this to retrieve the subsequent page. in: query required: false type: string tags: - InboxService /api/v1/markdown/link:metadata: get: summary: GetLinkMetadata returns metadata for a given link. operationId: MarkdownService_GetLinkMetadata responses: "200": description: A successful response. schema: $ref: '#/definitions/v1LinkMetadata' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: link in: query required: false type: string tags: - MarkdownService /api/v1/markdown/node:restore: post: summary: RestoreMarkdownNodes restores the given nodes to markdown content. operationId: MarkdownService_RestoreMarkdownNodes responses: "200": description: A successful response. schema: $ref: '#/definitions/v1RestoreMarkdownNodesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1RestoreMarkdownNodesRequest' tags: - MarkdownService /api/v1/markdown/node:stringify: post: summary: StringifyMarkdownNodes stringify the given nodes to plain text content. operationId: MarkdownService_StringifyMarkdownNodes responses: "200": description: A successful response. schema: $ref: '#/definitions/v1StringifyMarkdownNodesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1StringifyMarkdownNodesRequest' tags: - MarkdownService /api/v1/markdown:parse: post: summary: ParseMarkdown parses the given markdown content and returns a list of nodes. operationId: MarkdownService_ParseMarkdown responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ParseMarkdownResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1ParseMarkdownRequest' tags: - MarkdownService /api/v1/memos: get: summary: ListMemos lists memos with pagination and filter. operationId: MemoService_ListMemos responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListMemosResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos." in: query required: false type: string - name: pageSize description: The maximum number of memos to return. in: query required: false type: integer format: int32 - name: pageToken description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." in: query required: false type: string - name: state description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos." in: query required: false type: string enum: - STATE_UNSPECIFIED - NORMAL - ARCHIVED default: STATE_UNSPECIFIED - name: sort description: "What field to sort the results by.\r\nDefault to display_time." in: query required: false type: string - name: direction description: "The direction to sort the results by.\r\nDefault to DESC." in: query required: false type: string enum: - DIRECTION_UNSPECIFIED - ASC - DESC default: DIRECTION_UNSPECIFIED - name: filter description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`." in: query required: false type: string - name: oldFilter description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\"" in: query required: false type: string tags: - MemoService post: summary: CreateMemo creates a memo. operationId: MemoService_CreateMemo responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1Memo' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: memo description: The memo to create. in: body required: true schema: $ref: '#/definitions/apiv1Memo' required: - memo tags: - MemoService /api/v1/reactions/{id}: delete: summary: DeleteMemoReaction deletes a reaction for a memo. operationId: MemoService_DeleteMemoReaction responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: id description: "The id of the reaction.\r\nRefer to the `Reaction.id`." in: path required: true type: integer format: int32 tags: - MemoService /api/v1/resources: get: summary: ListResources lists all resources. operationId: ResourceService_ListResources responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListResourcesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - ResourceService post: summary: CreateResource creates a new resource. operationId: ResourceService_CreateResource responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Resource' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: resource in: body required: true schema: $ref: '#/definitions/v1Resource' tags: - ResourceService /api/v1/users: get: summary: ListUsers returns a list of users. operationId: UserService_ListUsers responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListUsersResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - UserService post: summary: CreateUser creates a new user. operationId: UserService_CreateUser responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: user in: body required: true schema: $ref: '#/definitions/v1User' tags: - UserService /api/v1/users/-/stats: post: summary: ListAllUserStats returns all user stats. operationId: UserService_ListAllUserStats responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListAllUserStatsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - UserService /api/v1/users:username: get: summary: GetUserByUsername gets a user by username. operationId: UserService_GetUserByUsername responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: username description: The username of the user. in: query required: false type: string tags: - UserService /api/v1/webhooks: get: summary: ListWebhooks returns a list of webhooks. operationId: WebhookService_ListWebhooks responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListWebhooksResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: creator description: The name of the creator. in: query required: false type: string tags: - WebhookService post: summary: CreateWebhook creates a new webhook. operationId: WebhookService_CreateWebhook responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Webhook' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: body in: body required: true schema: $ref: '#/definitions/v1CreateWebhookRequest' tags: - WebhookService /api/v1/webhooks/{id}: get: summary: GetWebhook returns a webhook by id. operationId: WebhookService_GetWebhook responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Webhook' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: id in: path required: true type: integer format: int32 tags: - WebhookService delete: summary: DeleteWebhook deletes a webhook by id. operationId: WebhookService_DeleteWebhook responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: id in: path required: true type: integer format: int32 tags: - WebhookService /api/v1/webhooks/{webhook.id}: patch: summary: UpdateWebhook updates a webhook. operationId: WebhookService_UpdateWebhook responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Webhook' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: webhook.id in: path required: true type: integer format: int32 - name: webhook in: body required: true schema: type: object properties: creator: type: string description: The name of the creator. createTime: type: string format: date-time updateTime: type: string format: date-time name: type: string url: type: string tags: - WebhookService /api/v1/workspace/profile: get: summary: GetWorkspaceProfile returns the workspace profile. operationId: WorkspaceService_GetWorkspaceProfile responses: "200": description: A successful response. schema: $ref: '#/definitions/v1WorkspaceProfile' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' tags: - WorkspaceService /api/v1/workspace/{name}: get: summary: GetWorkspaceSetting returns the setting by name. operationId: WorkspaceSettingService_GetWorkspaceSetting responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1WorkspaceSetting' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: |- The resource name of the workspace setting. Format: settings/{setting} in: path required: true type: string pattern: settings/[^/]+ tags: - WorkspaceSettingService /api/v1/workspace/{setting.name}: patch: summary: SetWorkspaceSetting updates the setting. operationId: WorkspaceSettingService_SetWorkspaceSetting responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1WorkspaceSetting' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: setting.name description: |- name is the name of the setting. Format: settings/{setting} in: path required: true type: string pattern: settings/[^/]+ - name: setting description: setting is the setting to update. in: body required: true schema: type: object properties: generalSetting: $ref: '#/definitions/apiv1WorkspaceGeneralSetting' storageSetting: $ref: '#/definitions/apiv1WorkspaceStorageSetting' memoRelatedSetting: $ref: '#/definitions/apiv1WorkspaceMemoRelatedSetting' title: setting is the setting to update. tags: - WorkspaceSettingService /api/v1/{identityProvider.name}: patch: summary: UpdateIdentityProvider updates an identity provider. operationId: IdentityProviderService_UpdateIdentityProvider responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1IdentityProvider' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: identityProvider.name description: |- The name of the identityProvider. Format: identityProviders/{id}, id is the system generated auto-incremented id. in: path required: true type: string pattern: identityProviders/[^/]+ - name: identityProvider description: The identityProvider to update. in: body required: true schema: type: object properties: type: $ref: '#/definitions/apiv1IdentityProviderType' title: type: string identifierFilter: type: string config: $ref: '#/definitions/apiv1IdentityProviderConfig' title: The identityProvider to update. tags: - IdentityProviderService /api/v1/{inbox.name}: patch: summary: UpdateInbox updates an inbox. operationId: InboxService_UpdateInbox responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Inbox' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: inbox.name description: |- The name of the inbox. Format: inboxes/{id}, id is the system generated auto-incremented id. in: path required: true type: string pattern: inboxes/[^/]+ - name: inbox in: body required: true schema: type: object properties: sender: type: string title: 'Format: users/{user}' receiver: type: string title: 'Format: users/{user}' status: $ref: '#/definitions/v1InboxStatus' createTime: type: string format: date-time type: $ref: '#/definitions/v1InboxType' activityId: type: integer format: int32 tags: - InboxService /api/v1/{memo.name}: patch: summary: UpdateMemo updates a memo. operationId: MemoService_UpdateMemo responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1Memo' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: memo.name description: "The name of the memo.\r\nFormat: memos/{memo}, memo is the user defined id or uuid." in: path required: true type: string pattern: memos/[^/]+ - name: memo description: "The memo to update.\r\nThe `name` field is required." in: body required: true schema: type: object properties: state: $ref: '#/definitions/v1State' creator: type: string title: "The name of the creator.\r\nFormat: users/{user}" createTime: type: string format: date-time updateTime: type: string format: date-time displayTime: type: string format: date-time content: type: string nodes: type: array items: type: object $ref: '#/definitions/v1Node' readOnly: true visibility: $ref: '#/definitions/v1Visibility' tags: type: array items: type: string readOnly: true pinned: type: boolean resources: type: array items: type: object $ref: '#/definitions/v1Resource' relations: type: array items: type: object $ref: '#/definitions/v1MemoRelation' reactions: type: array items: type: object $ref: '#/definitions/v1Reaction' readOnly: true property: $ref: '#/definitions/v1MemoProperty' readOnly: true parent: type: string title: "The name of the parent memo.\r\nFormat: memos/{id}" readOnly: true snippet: type: string description: The snippet of the memo content. Plain text only. readOnly: true location: $ref: '#/definitions/apiv1Location' description: The location of the memo. title: "The memo to update.\r\nThe `name` field is required." required: - memo tags: - MemoService /api/v1/{name_1}: get: summary: GetUser gets a user by name. operationId: UserService_GetUser responses: "200": description: A successful response. schema: $ref: '#/definitions/v1User' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_1 description: The name of the user. in: path required: true type: string pattern: users/[^/]+ tags: - UserService delete: summary: DeleteIdentityProvider deletes an identity provider. operationId: IdentityProviderService_DeleteIdentityProvider responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_1 description: The name of the identityProvider to delete. in: path required: true type: string pattern: identityProviders/[^/]+ tags: - IdentityProviderService /api/v1/{name_2}: get: summary: GetIdentityProvider gets an identity provider. operationId: IdentityProviderService_GetIdentityProvider responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1IdentityProvider' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_2 description: The name of the identityProvider to get. in: path required: true type: string pattern: identityProviders/[^/]+ tags: - IdentityProviderService delete: summary: DeleteInbox deletes an inbox. operationId: InboxService_DeleteInbox responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_2 description: The name of the inbox to delete. in: path required: true type: string pattern: inboxes/[^/]+ tags: - InboxService /api/v1/{name_3}: get: summary: GetResource returns a resource by name. operationId: ResourceService_GetResource responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Resource' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_3 description: The name of the resource. in: path required: true type: string pattern: resources/[^/]+ tags: - ResourceService delete: summary: DeleteResource deletes a resource by name. operationId: ResourceService_DeleteResource responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_3 description: The name of the resource. in: path required: true type: string pattern: resources/[^/]+ tags: - ResourceService /api/v1/{name_4}: get: summary: GetMemo gets a memo. operationId: MemoService_GetMemo responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1Memo' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_4 description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ tags: - MemoService delete: summary: DeleteMemo deletes a memo. operationId: MemoService_DeleteMemo responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name_4 description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ tags: - MemoService /api/v1/{name}: get: summary: GetActivity returns the activity with the given id. operationId: ActivityService_GetActivity responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Activity' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: |- The name of the activity. Format: activities/{id}, id is the system generated auto-incremented id. in: path required: true type: string pattern: activities/[^/]+ tags: - ActivityService delete: summary: DeleteUser deletes a user. operationId: UserService_DeleteUser responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the user. in: path required: true type: string pattern: users/[^/]+ tags: - UserService /api/v1/{name}/access_tokens: get: summary: ListUserAccessTokens returns a list of access tokens for a user. operationId: UserService_ListUserAccessTokens responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListUserAccessTokensResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the user. in: path required: true type: string pattern: users/[^/]+ tags: - UserService post: summary: CreateUserAccessToken creates a new access token for a user. operationId: UserService_CreateUserAccessToken responses: "200": description: A successful response. schema: $ref: '#/definitions/v1UserAccessToken' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the user. in: path required: true type: string pattern: users/[^/]+ - name: body in: body required: true schema: $ref: '#/definitions/UserServiceCreateUserAccessTokenBody' tags: - UserService /api/v1/{name}/access_tokens/{accessToken}: delete: summary: DeleteUserAccessToken deletes an access token for a user. operationId: UserService_DeleteUserAccessToken responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the user. in: path required: true type: string pattern: users/[^/]+ - name: accessToken description: access_token is the access token to delete. in: path required: true type: string tags: - UserService /api/v1/{name}/comments: get: summary: ListMemoComments lists comments for a memo. operationId: MemoService_ListMemoComments responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListMemoCommentsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ tags: - MemoService post: summary: CreateMemoComment creates a comment for a memo. operationId: MemoService_CreateMemoComment responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1Memo' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ - name: comment description: The comment to create. in: body required: true schema: $ref: '#/definitions/apiv1Memo' tags: - MemoService /api/v1/{name}/reactions: get: summary: ListMemoReactions lists reactions for a memo. operationId: MemoService_ListMemoReactions responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListMemoReactionsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ tags: - MemoService post: summary: UpsertMemoReaction upserts a reaction for a memo. operationId: MemoService_UpsertMemoReaction responses: "200": description: A successful response. schema: $ref: '#/definitions/v1Reaction' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ - name: body in: body required: true schema: $ref: '#/definitions/MemoServiceUpsertMemoReactionBody' tags: - MemoService /api/v1/{name}/relations: get: summary: ListMemoRelations lists relations for a memo. operationId: MemoService_ListMemoRelations responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListMemoRelationsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ tags: - MemoService patch: summary: SetMemoRelations sets relations for a memo. operationId: MemoService_SetMemoRelations responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ - name: body in: body required: true schema: $ref: '#/definitions/MemoServiceSetMemoRelationsBody' tags: - MemoService /api/v1/{name}/resources: get: summary: ListMemoResources lists resources for a memo. operationId: MemoService_ListMemoResources responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListMemoResourcesResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ tags: - MemoService patch: summary: SetMemoResources sets resources for a memo. operationId: MemoService_SetMemoResources responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the memo. in: path required: true type: string pattern: memos/[^/]+ - name: body in: body required: true schema: $ref: '#/definitions/MemoServiceSetMemoResourcesBody' tags: - MemoService /api/v1/{name}/setting: get: summary: GetUserSetting gets the setting of a user. operationId: UserService_GetUserSetting responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1UserSetting' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the user. in: path required: true type: string pattern: users/[^/]+ tags: - UserService /api/v1/{name}/stats: get: summary: GetUserStats returns the stats of a user. operationId: UserService_GetUserStats responses: "200": description: A successful response. schema: $ref: '#/definitions/v1UserStats' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: name description: The name of the user. in: path required: true type: string pattern: users/[^/]+ tags: - UserService /api/v1/{parent}/memos: get: summary: ListMemos lists memos with pagination and filter. operationId: MemoService_ListMemos2 responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListMemosResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: "The parent is the owner of the memos.\r\nIf not specified or `users/-`, it will list all memos." in: path required: true type: string pattern: users/[^/]+ - name: pageSize description: The maximum number of memos to return. in: query required: false type: integer format: int32 - name: pageToken description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." in: query required: false type: string - name: state description: "The state of the memos to list.\r\nDefault to `NORMAL`. Set to `ARCHIVED` to list archived memos." in: query required: false type: string enum: - STATE_UNSPECIFIED - NORMAL - ARCHIVED default: STATE_UNSPECIFIED - name: sort description: "What field to sort the results by.\r\nDefault to display_time." in: query required: false type: string - name: direction description: "The direction to sort the results by.\r\nDefault to DESC." in: query required: false type: string enum: - DIRECTION_UNSPECIFIED - ASC - DESC default: DIRECTION_UNSPECIFIED - name: filter description: "Filter is a CEL expression to filter memos.\r\nRefer to `Shortcut.filter`." in: query required: false type: string - name: oldFilter description: "[Deprecated] Old filter contains some specific conditions to filter memos.\r\nFormat: \"creator == 'users/{user}' && visibilities == ['PUBLIC', 'PROTECTED']\"" in: query required: false type: string tags: - MemoService /api/v1/{parent}/shortcuts: get: summary: ListShortcuts returns a list of shortcuts for a user. operationId: UserService_ListShortcuts responses: "200": description: A successful response. schema: $ref: '#/definitions/v1ListShortcutsResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: The name of the user. in: path required: true type: string pattern: users/[^/]+ tags: - UserService post: summary: CreateShortcut creates a new shortcut for a user. operationId: UserService_CreateShortcut responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1Shortcut' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: The name of the user. in: path required: true type: string pattern: users/[^/]+ - name: shortcut in: body required: true schema: $ref: '#/definitions/apiv1Shortcut' - name: validateOnly in: query required: false type: boolean tags: - UserService /api/v1/{parent}/shortcuts/{id}: delete: summary: DeleteShortcut deletes a shortcut for a user. operationId: UserService_DeleteShortcut responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: The name of the user. in: path required: true type: string pattern: users/[^/]+ - name: id description: The id of the shortcut. in: path required: true type: string tags: - UserService /api/v1/{parent}/shortcuts/{shortcut.id}: patch: summary: UpdateShortcut updates a shortcut for a user. operationId: UserService_UpdateShortcut responses: "200": description: A successful response. schema: $ref: '#/definitions/apiv1Shortcut' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: The name of the user. in: path required: true type: string pattern: users/[^/]+ - name: shortcut.id in: path required: true type: string - name: shortcut in: body required: true schema: type: object properties: title: type: string filter: type: string tags: - UserService /api/v1/{parent}/tags/{tag}: delete: summary: DeleteMemoTag deletes a tag for a memo. operationId: MemoService_DeleteMemoTag responses: "200": description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: parent description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to delete all tags." in: path required: true type: string pattern: memos/[^/]+ - name: tag in: path required: true type: string - name: deleteRelatedMemos in: query required: false type: boolean tags: - MemoService /api/v1/{parent}/tags:rename: patch: summary: RenameMemoTag renames a tag for a memo. operationId: MemoService_RenameMemoTag responses: "200": description: A suc