YourSelfHosted/memos
1
0
Fork 0
mirror of https://github.com/usememos/memos.git synced 2025-06-05 22:09:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: regenerate api docs

Browse Source
This commit is contained in:
johnnyjoy
2024-10-19 16:13:27 +08:00
parent 67dc9a3f0a
commit c2e820400e
1 changed files with 60 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

248
proto/gen/apidocs.swagger.yaml
View File

@@ -311,16 +311,12 @@ paths:
type: integer type: integer
format: int32 format: int32
- name: pageToken - name: pageToken
description: |- description: "A page token, received from a previous `ListMemos` call.\r\nProvide this to retrieve the subsequent page."
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: |- description: "Filter is used to filter memos returned in the list.\r\nFormat: \"creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']\""
Filter is used to filter memos returned in the list.
Format: "creator == 'users/{uid}' && visibilities == ['PUBLIC', 'PROTECTED']"
in: query in: query
required: false required: false
type: string type: string
@@ -509,9 +505,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: filter - name: filter
description: |- description: "Filter is used to filter users returned in the list.\r\nFormat: \"username == 'frank'\""
Filter is used to filter users returned in the list.
Format: "username == 'frank'"
in: query in: query
required: false required: false
type: string type: string
@@ -672,9 +666,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The resource name of the workspace setting.\r\nFormat: settings/{setting}"
The resource name of the workspace setting.
Format: settings/{setting}
in: path in: path
required: true required: true
type: string type: string
@@ -696,9 +688,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: setting.name - name: setting.name
description: |- description: "name is the name of the setting.\r\nFormat: settings/{setting}"
name is the name of the setting.
Format: settings/{setting}
in: path in: path
required: true required: true
type: string type: string
@@ -734,9 +724,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: identityProvider.name - name: identityProvider.name
description: |- description: "The name of the identityProvider.\r\nFormat: identityProviders/{id}"
The name of the identityProvider.
Format: identityProviders/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -774,9 +762,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: inbox.name - name: inbox.name
description: |- description: "The name of the inbox.\r\nFormat: inboxes/{id}"
The name of the inbox.
Format: inboxes/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -820,10 +806,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: memo.name - name: memo.name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}\r\nid is the system generated id."
The name of the memo.
Format: memos/{id}
id is the system generated id.
in: path in: path
required: true required: true
type: string type: string
@@ -841,9 +824,7 @@ paths:
$ref: '#/definitions/v1RowStatus' $ref: '#/definitions/v1RowStatus'
creator: creator:
type: string type: string
title: |- title: "The name of the creator.\r\nFormat: users/{id}"
The name of the creator.
Format: users/{id}
createTime: createTime:
type: string type: string
format: date-time format: date-time
@@ -890,9 +871,7 @@ paths:
readOnly: true readOnly: true
parent: parent:
type: string type: string
title: |- title: "The name of the parent memo.\r\nFormat: memos/{id}"
The name of the parent memo.
Format: memos/{id}
readOnly: true readOnly: true
snippet: snippet:
type: string type: string
@@ -918,9 +897,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_1 - name: name_1
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -942,9 +919,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_1 - name: name_1
description: |- description: "The name of the identityProvider to delete.\r\nFormat: identityProviders/{id}"
The name of the identityProvider to delete.
Format: identityProviders/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -966,9 +941,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_2 - name: name_2
description: |- description: "The name of the identityProvider to get.\r\nFormat: identityProviders/{id}"
The name of the identityProvider to get.
Format: identityProviders/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -990,9 +963,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_2 - name: name_2
description: |- description: "The name of the inbox to delete.\r\nFormat: inboxes/{id}"
The name of the inbox to delete.
Format: inboxes/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1014,10 +985,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_3 - name: name_3
description: |- description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier."
The name of the resource.
Format: resources/{id}
id is the system generated unique identifier.
in: path in: path
required: true required: true
type: string type: string
@@ -1039,10 +1007,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_3 - name: name_3
description: |- description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier."
The name of the resource.
Format: resources/{id}
id is the system generated unique identifier.
in: path in: path
required: true required: true
type: string type: string
@@ -1064,9 +1029,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_4 - name: name_4
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1088,9 +1051,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name_4 - name: name_4
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1112,9 +1073,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the activity.\r\nFormat: activities/{id}"
The name of the activity.
Format: activities/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1136,9 +1095,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1160,9 +1117,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1183,9 +1138,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1213,9 +1166,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1242,9 +1193,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1265,9 +1214,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1294,9 +1241,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1317,9 +1262,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1346,9 +1289,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1370,9 +1311,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1399,9 +1338,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1423,9 +1360,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1452,9 +1387,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1477,9 +1410,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: |- description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to delete all tags."
The parent, who owns the tags.
Format: memos/{id}. Use "memos/-" to delete all tags.
in: path in: path
required: true required: true
type: string type: string
@@ -1510,9 +1441,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: parent - name: parent
description: |- description: "The parent, who owns the tags.\r\nFormat: memos/{id}. Use \"memos/-\" to rename all tags."
The parent, who owns the tags.
Format: memos/{id}. Use "memos/-" to rename all tags.
in: path in: path
required: true required: true
type: string type: string
@@ -1539,10 +1468,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: resource.name - name: resource.name
description: |- description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier."
The name of the resource.
Format: resources/{id}
id is the system generated unique identifier.
in: path in: path
required: true required: true
type: string type: string
@@ -1574,9 +1500,7 @@ paths:
format: int64 format: int64
memo: memo:
type: string type: string
title: |- title: "The related memo.\r\nFormat: memos/{id}"
The related memo.
Format: memos/{id}
tags: tags:
- ResourceService - ResourceService
/api/v1/{setting.name}: /api/v1/{setting.name}:
@@ -1594,9 +1518,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: setting.name - name: setting.name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1633,9 +1555,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: user.name - name: user.name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1689,9 +1609,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
in: path in: path
required: true required: true
type: string type: string
@@ -1724,10 +1642,7 @@ paths:
$ref: '#/definitions/googlerpcStatus' $ref: '#/definitions/googlerpcStatus'
parameters: parameters:
- name: name - name: name
description: |- description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier."
The name of the resource.
Format: resources/{id}
id is the system generated unique identifier.
in: path in: path
required: true required: true
type: string type: string
@@ -1920,9 +1835,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the identityProvider.\r\nFormat: identityProviders/{id}"
The name of the identityProvider.
Format: identityProviders/{id}
type: type:
$ref: '#/definitions/apiv1IdentityProviderType' $ref: '#/definitions/apiv1IdentityProviderType'
title: title:
@@ -1958,10 +1871,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: |- description: "The name of the memo.\r\nFormat: memos/{id}\r\nid is the system generated id."
The name of the memo.
Format: memos/{id}
id is the system generated id.
uid: uid:
type: string type: string
description: The user defined id of the memo. description: The user defined id of the memo.
@@ -1969,9 +1879,7 @@ definitions:
$ref: '#/definitions/v1RowStatus' $ref: '#/definitions/v1RowStatus'
creator: creator:
type: string type: string
title: |- title: "The name of the creator.\r\nFormat: users/{id}"
The name of the creator.
Format: users/{id}
createTime: createTime:
type: string type: string
format: date-time format: date-time
@@ -2018,9 +1926,7 @@ definitions:
readOnly: true readOnly: true
parent: parent:
type: string type: string
title: |- title: "The name of the parent memo.\r\nFormat: memos/{id}"
The name of the parent memo.
Format: memos/{id}
readOnly: true readOnly: true
snippet: snippet:
type: string type: string
@@ -2053,9 +1959,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
locale: locale:
type: string type: string
description: The preferred locale of the user. description: The preferred locale of the user.
@@ -2099,10 +2003,7 @@ definitions:
weekStartDayOffset: weekStartDayOffset:
type: integer type: integer
format: int32 format: int32
description: |- description: "week_start_day_offset is the week start day offset from Sunday.\r\n0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday\r\nDefault is Sunday."
week_start_day_offset is the week start day offset from Sunday.
0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday
Default is Sunday.
disallowChangeUsername: disallowChangeUsername:
type: boolean type: boolean
description: disallow_change_username disallows changing username. description: disallow_change_username disallows changing username.
@@ -2153,9 +2054,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "name is the name of the setting.\r\nFormat: settings/{setting}"
name is the name of the setting.
Format: settings/{setting}
generalSetting: generalSetting:
$ref: '#/definitions/apiv1WorkspaceGeneralSetting' $ref: '#/definitions/apiv1WorkspaceGeneralSetting'
storageSetting: storageSetting:
@@ -2170,9 +2069,7 @@ definitions:
description: storage_type is the storage type. description: storage_type is the storage type.
filepathTemplate: filepathTemplate:
type: string type: string
title: |- title: "The template of file path.\r\ne.g. assets/{timestamp}_{filename}"
The template of file path.
e.g. assets/{timestamp}_{filename}
uploadSizeLimitMb: uploadSizeLimitMb:
type: string type: string
format: int64 format: int64
@@ -2331,9 +2228,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the activity.\r\nFormat: activities/{id}"
The name of the activity.
Format: activities/{id}
creatorId: creatorId:
type: integer type: integer
format: int32 format: int32
@@ -2476,9 +2371,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the inbox.\r\nFormat: inboxes/{id}"
The name of the inbox.
Format: inboxes/{id}
sender: sender:
type: string type: string
title: 'Format: users/{id}' title: 'Format: users/{id}'
@@ -2552,9 +2445,7 @@ definitions:
$ref: '#/definitions/v1Inbox' $ref: '#/definitions/v1Inbox'
nextPageToken: nextPageToken:
type: string type: string
description: |- 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."
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
v1ListMemoCommentsResponse: v1ListMemoCommentsResponse:
type: object type: object
properties: properties:
@@ -2597,9 +2488,7 @@ definitions:
$ref: '#/definitions/apiv1Memo' $ref: '#/definitions/apiv1Memo'
nextPageToken: nextPageToken:
type: string type: string
description: |- 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."
A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
v1ListNode: v1ListNode:
type: object type: object
properties: properties:
@@ -2675,14 +2564,10 @@ definitions:
properties: properties:
memo: memo:
$ref: '#/definitions/v1MemoRelationMemo' $ref: '#/definitions/v1MemoRelationMemo'
title: |- title: "The name of memo.\r\nFormat: \"memos/{uid}\""
The name of memo.
Format: "memos/{uid}"
relatedMemo: relatedMemo:
$ref: '#/definitions/v1MemoRelationMemo' $ref: '#/definitions/v1MemoRelationMemo'
title: |- title: "The name of related memo.\r\nFormat: \"memos/{uid}\""
The name of related memo.
Format: "memos/{uid}"
type: type:
$ref: '#/definitions/v1MemoRelationType' $ref: '#/definitions/v1MemoRelationType'
v1MemoRelationMemo: v1MemoRelationMemo:
@@ -2690,9 +2575,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the memo.\r\nFormat: memos/{id}"
The name of the memo.
Format: memos/{id}
uid: uid:
type: string type: string
snippet: snippet:
@@ -2866,9 +2749,7 @@ definitions:
format: int32 format: int32
creator: creator:
type: string type: string
title: |- title: "The name of the creator.\r\nFormat: users/{id}"
The name of the creator.
Format: users/{id}
contentId: contentId:
type: string type: string
reactionType: reactionType:
@@ -2885,10 +2766,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
description: |- description: "The name of the resource.\r\nFormat: resources/{id}\r\nid is the system generated unique identifier."
The name of the resource.
Format: resources/{id}
id is the system generated unique identifier.
uid: uid:
type: string type: string
description: The user defined id of the resource. description: The user defined id of the resource.
@@ -2910,9 +2788,7 @@ definitions:
format: int64 format: int64
memo: memo:
type: string type: string
title: |- title: "The related memo.\r\nFormat: memos/{id}"
The related memo.
Format: memos/{id}
v1RestoreMarkdownNodesRequest: v1RestoreMarkdownNodesRequest:
type: object type: object
properties: properties:
@@ -3034,9 +2910,7 @@ definitions:
properties: properties:
name: name:
type: string type: string
title: |- title: "The name of the user.\r\nFormat: users/{id}"
The name of the user.
Format: users/{id}
id: id:
type: integer type: integer
format: int32 format: int32
@@ -3110,9 +2984,7 @@ definitions:
properties: properties:
owner: owner:
type: string type: string
title: |- title: "The name of instance owner.\r\nFormat: \"users/{id}\""
The name of instance owner.
Format: "users/{id}"
version: version:
type: string type: string
title: version is the current version of instance title: version is the current version of instance