YourSelfHosted/memos
1
0
Fork 0
mirror of https://github.com/usememos/memos.git synced 2025-04-13 00:52:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: run buf generate

Browse Source
This commit is contained in:
Steven 2024-02-07 21:51:30 +08:00
parent 06fb2174c3
commit 99568236a3
2 changed files with 84 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api/v2/apidocs.swagger.md
View File

@ -842,7 +842,7 @@ UpdateUserSetting updates the setting of a user.
| Name | Located in | Description | Required | Schema | | Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ | | ---- | ---------- | ----------- | -------- | ------ |
| setting.name | path | The name of the user. Format: users/{username} | Yes | string | | setting.name | path | The name of the user. Format: users/{username} | Yes | string |
| setting | body | | Yes | { **"locale"**: string, **"appearance"**: string, **"memoVisibility"**: string, **"telegramUserId"**: string } | | setting | body | | Yes | { **"locale"**: string, **"appearance"**: string, **"memoVisibility"**: string, **"telegramUserId"**: string, **"compactView"**: boolean } |
##### Responses ##### Responses
@ -1093,6 +1093,7 @@ GetActivity returns the activity with the given id.
| appearance | string | The preferred appearance of the user. | No | | appearance | string | The preferred appearance of the user. | No |
| memoVisibility | string | The default visibility of the memo. | No | | memoVisibility | string | The default visibility of the memo. | No |
| telegramUserId | string | The telegram user id of the user. | No | | telegramUserId | string | The telegram user id of the user. | No |
| compactView | boolean | The compact view for a memo. | No |
#### apiv2Webhook #### apiv2Webhook

109
api/v2/apidocs.swagger.yaml
View File

@ -170,12 +170,16 @@ paths:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page." description: |-
A page token, received from a previous `ListMemos` call.
Provide this to retrieve the subsequent page.
in: query in: query
required: false required: false
type: string type: string
- name: filter - name: filter
description: "Filter is used to filter memos returned in the list.\r\nFormat: \"creator == users/{username} && visibilities == ['PUBLIC', 'PROTECTED']\"" description: |-
Filter is used to filter memos returned in the list.
Format: "creator == users/{username} && visibilities == ['PUBLIC', 'PROTECTED']"
in: query in: query
required: false required: false
type: string type: string
@ -236,12 +240,17 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "name is the name of the user to get stats for.\r\nFormat: users/{username}" description: |-
name is the name of the user to get stats for.
Format: users/{username}
in: query in: query
required: false required: false
type: string type: string
- name: timezone - name: timezone
description: "timezone location\r\nFormat: uses tz identifier\r\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones" description: |-
timezone location
Format: uses tz identifier
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
in: query in: query
required: false required: false
type: string type: string
@ -474,7 +483,9 @@ paths:
$ref: '#/definitions/apiv2RowStatus' $ref: '#/definitions/apiv2RowStatus'
creator: creator:
type: string type: string
title: "The name of the creator.\r\nFormat: users/{username}" title: |-
The name of the creator.
Format: users/{username}
creatorId: creatorId:
type: integer type: integer
format: int32 format: int32
@ -701,7 +712,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user - name: user
description: "The creator of tags.\r\nFormat: users/{username}" description: |-
The creator of tags.
Format: users/{username}
in: query in: query
required: false required: false
type: string type: string
@ -725,7 +738,9 @@ paths:
required: false required: false
type: string type: string
- name: tag.creator - name: tag.creator
description: "The creator of tags.\r\nFormat: users/{username}" description: |-
The creator of tags.
Format: users/{username}
in: query in: query
required: false required: false
type: string type: string
@ -765,7 +780,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user - name: user
description: "The creator of tags.\r\nFormat: users/{username}" description: |-
The creator of tags.
Format: users/{username}
in: query in: query
required: false required: false
type: string type: string
@ -788,7 +805,9 @@ paths:
- TagService - TagService
/api/v2/tags:rename: /api/v2/tags:rename:
patch: patch:
summary: "RenameTag renames a tag.\r\nAll related memos will be updated." summary: |-
RenameTag renames a tag.
All related memos will be updated.
operationId: TagService_RenameTag operationId: TagService_RenameTag
responses: responses:
"200": "200":
@ -801,7 +820,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user - name: user
description: "The creator of tags.\r\nFormat: users/{username}" description: |-
The creator of tags.
Format: users/{username}
in: query in: query
required: false required: false
type: string type: string
@ -1025,7 +1046,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: inbox.name - name: inbox.name
description: "The name of the inbox.\r\nFormat: inboxes/{uid}" description: |-
The name of the inbox.
Format: inboxes/{uid}
in: path in: path
required: true required: true
type: string type: string
@ -1069,7 +1092,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_1 - name: name_1
description: "The name of the inbox to delete.\r\nFormat: inboxes/{uid}" description: |-
The name of the inbox to delete.
Format: inboxes/{uid}
in: path in: path
required: true required: true
type: string type: string
@ -1091,7 +1116,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1112,7 +1139,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1134,7 +1163,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1155,7 +1186,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1182,7 +1215,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1209,7 +1244,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1231,7 +1268,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: setting.name - name: setting.name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1274,7 +1313,9 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user.name - name: user.name
description: "The name of the user.\r\nFormat: users/{username}" description: |-
The name of the user.
Format: users/{username}
in: path in: path
required: true required: true
type: string type: string
@ -1397,7 +1438,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: "The name of the user.\r\nFormat: users/{username}" title: |-
The name of the user.
Format: users/{username}
locale: locale:
type: string type: string
description: The preferred locale of the user. description: The preferred locale of the user.
@ -1582,7 +1625,9 @@ definitions:
additionalProperties: additionalProperties:
type: integer type: integer
format: int32 format: int32
description: "stats is the stats of memo creating/updating activities.\r\nkey is the year-month-day string. e.g. \"2020-01-01\"." description: |-
stats is the stats of memo creating/updating activities.
key is the year-month-day string. e.g. "2020-01-01".
v2GetUserResponse: v2GetUserResponse:
type: object type: object
properties: properties:
@ -1608,7 +1653,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: "The name of the inbox.\r\nFormat: inboxes/{uid}" title: |-
The name of the inbox.
Format: inboxes/{uid}
sender: sender:
type: string type: string
title: 'Format: users/{username}' title: 'Format: users/{username}'
@ -1681,7 +1728,9 @@ definitions:
$ref: '#/definitions/v2Memo' $ref: '#/definitions/v2Memo'
nextPageToken: nextPageToken:
type: string type: string
description: "A token, which can be sent as `page_token` to retrieve the next page.\r\nIf this field is omitted, there are no subsequent pages." description: |-
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
v2ListResourcesResponse: v2ListResourcesResponse:
type: object type: object
properties: properties:
@ -1736,7 +1785,9 @@ definitions:
$ref: '#/definitions/apiv2RowStatus' $ref: '#/definitions/apiv2RowStatus'
creator: creator:
type: string type: string
title: "The name of the creator.\r\nFormat: users/{username}" title: |-
The name of the creator.
Format: users/{username}
creatorId: creatorId:
type: integer type: integer
format: int32 format: int32
@ -1847,7 +1898,9 @@ definitions:
type: string type: string
creator: creator:
type: string type: string
title: "The creator of tags.\r\nFormat: users/{username}" title: |-
The creator of tags.
Format: users/{username}
v2UpdateInboxResponse: v2UpdateInboxResponse:
type: object type: object
properties: properties:
@ -1898,7 +1951,9 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: "The name of the user.\r\nFormat: users/{username}" title: |-
The name of the user.
Format: users/{username}
id: id:
type: integer type: integer
format: int32 format: int32