chore:ci: pull heads/release/0.19.1 from usememos/memos

memospot · Feb 9, 2024 · c273837 · c273837
2 parents 08933af + fc9d2c0
commit c273837
Show file tree

Hide file tree

Showing 26 changed files with 1,040 additions and 850 deletions.
diff --git a/memos/api/v2/apidocs.swagger.md b/memos/api/v2/apidocs.swagger.md
@@ -120,7 +120,7 @@ ListInboxes lists inboxes for a user.
 | 200 | A successful response. | [v2ListInboxesResponse](#v2listinboxesresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /v2/inboxes
+### /api/v2/{inbox.name}
 
 #### PATCH
 ##### Summary
@@ -131,7 +131,8 @@ UpdateInbox updates an inbox.
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| inbox | body |  | Yes | [v2Inbox](#v2inbox) |
+| inbox.name | path | The name of the inbox. Format: inboxes/{uid} | Yes | string |
+| inbox | body |  | Yes | { **"sender"**: string, **"receiver"**: string, **"status"**: [v2InboxStatus](#v2inboxstatus), **"createTime"**: dateTime, **"type"**: [v2InboxType](#v2inboxtype), **"activityId"**: integer } |
 
 ##### Responses
 
@@ -140,7 +141,7 @@ UpdateInbox updates an inbox.
 | 200 | A successful response. | [v2UpdateInboxResponse](#v2updateinboxresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /v2/{name}
+### /api/v2/{name_1}
 
 #### DELETE
 ##### Summary
@@ -151,7 +152,7 @@ DeleteInbox deletes an inbox.
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| name | path | The name of the inbox to delete. Format: inboxes/{inbox} | Yes | string |
+| name_1 | path | The name of the inbox to delete. Format: inboxes/{uid} | Yes | string |
 
 ##### Responses
 
@@ -203,52 +204,54 @@ CreateMemo creates a memo.
 | 200 | A successful response. | [v2CreateMemoResponse](#v2creatememoresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /api/v2/memos/stats
+### /api/v2/memos/name/{name}
 
 #### GET
 ##### Summary
 
-GetUserMemosStats gets stats of memos for a user.
+GetMemoByName gets a memo by name.
 
 ##### 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 |
+| name | path |  | Yes | string |
 
 ##### Responses
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2GetUserMemosStatsResponse](#v2getusermemosstatsresponse) |
+| 200 | A successful response. | [v2GetMemoByNameResponse](#v2getmemobynameresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /api/v2/memos/{id}
+### /api/v2/memos/stats
 
 #### GET
 ##### Summary
 
-GetMemo gets a memo by id.
+GetUserMemosStats gets stats of memos for a user.
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| id | path |  | Yes | integer |
+| 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. | [v2GetMemoResponse](#v2getmemoresponse) |
+| 200 | A successful response. | [v2GetUserMemosStatsResponse](#v2getusermemosstatsresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-#### DELETE
+### /api/v2/memos/{id}
+
+#### GET
 ##### Summary
 
-DeleteMemo deletes a memo by id.
+GetMemo gets a memo by id.
 
 ##### Parameters
 
@@ -260,26 +263,25 @@ DeleteMemo deletes a memo by id.
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2DeleteMemoResponse](#v2deletememoresponse) |
+| 200 | A successful response. | [v2GetMemoResponse](#v2getmemoresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-#### PATCH
+#### DELETE
 ##### Summary
 
-UpdateMemo updates a memo.
+DeleteMemo deletes a memo by id.
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
 | id | path |  | Yes | integer |
-| body | body |  | Yes | [MemoServiceUpdateMemoBody](#memoserviceupdatememobody) |
 
 ##### Responses
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2UpdateMemoResponse](#v2updatememoresponse) |
+| 200 | A successful response. | [v2DeleteMemoResponse](#v2deletememoresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
 ### /api/v2/memos/{id}/comments
@@ -400,24 +402,25 @@ SetMemoResources sets resources for a memo.
 | 200 | A successful response. | [v2SetMemoResourcesResponse](#v2setmemoresourcesresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /api/v2/memos/{name}
+### /api/v2/memos/{memo.id}
 
-#### GET
+#### PATCH
 ##### Summary
 
-GetMemoByName gets a memo by name.
+UpdateMemo updates a memo.
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| name | path |  | Yes | string |
+| memo.id | path | id is the system generated unique identifier. | Yes | integer |
+| memo | body |  | Yes | { **"name"**: string, **"rowStatus"**: [apiv2RowStatus](#apiv2rowstatus), **"creator"**: string, **"creatorId"**: integer, **"createTime"**: dateTime, **"updateTime"**: dateTime, **"displayTime"**: dateTime, **"content"**: string, **"visibility"**: [v2Visibility](#v2visibility), **"pinned"**: boolean, **"parentId"**: integer, **"resources"**: [ [v2Resource](#v2resource) ], **"relations"**: [ [v2MemoRelation](#v2memorelation) ] } |
 
 ##### Responses
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2GetMemoByNameResponse](#v2getmemobynameresponse) |
+| 200 | A successful response. | [v2UpdateMemoResponse](#v2updatememoresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
 ### /api/v2/memos:export
@@ -437,7 +440,7 @@ ExportMemos exports memos.
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response.(streaming responses) | { **"result"**: [v2ExportMemosResponse](#v2exportmemosresponse), **"error"**: [googlerpcStatus](#googlerpcstatus) } |
+| 200 | A successful response. | [v2ExportMemosResponse](#v2exportmemosresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
 ---
@@ -478,30 +481,32 @@ CreateResource creates a new resource.
 | 200 | A successful response. | [v2CreateResourceResponse](#v2createresourceresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /api/v2/resources/{id}
+### /api/v2/resources/name/{name}
 
 #### GET
 ##### Summary
 
-GetResource returns a resource by id.
+GetResourceByName returns a resource by name.
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| id | path |  | Yes | integer |
+| name | path |  | Yes | string |
 
 ##### Responses
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2GetResourceResponse](#v2getresourceresponse) |
+| 200 | A successful response. | [v2GetResourceByNameResponse](#v2getresourcebynameresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-#### DELETE
+### /api/v2/resources/{id}
+
+#### GET
 ##### Summary
 
-DeleteResource deletes a resource by id.
+GetResource returns a resource by id.
 
 ##### Parameters
 
@@ -513,27 +518,25 @@ DeleteResource deletes a resource by id.
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2DeleteResourceResponse](#v2deleteresourceresponse) |
+| 200 | A successful response. | [v2GetResourceResponse](#v2getresourceresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /api/v2/resources/{name}
-
-#### GET
+#### DELETE
 ##### Summary
 
-GetResourceByName returns a resource by name.
+DeleteResource deletes a resource by id.
 
 ##### Parameters
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| name | path |  | Yes | string |
+| id | path |  | Yes | integer |
 
 ##### Responses
 
 | Code | Description | Schema |
 | ---- | ----------- | ------ |
-| 200 | A successful response. | [v2GetResourceByNameResponse](#v2getresourcebynameresponse) |
+| 200 | A successful response. | [v2DeleteResourceResponse](#v2deleteresourceresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
 ### /api/v2/resources/{resource.id}
@@ -691,6 +694,24 @@ ListUsers returns a list of users.
 | 200 | A successful response. | [v2ListUsersResponse](#v2listusersresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
+#### POST
+##### Summary
+
+CreateUser creates a new user.
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ------ |
+| user | body |  | Yes | [v2User](#v2user) |
+
+##### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | A successful response. | [v2CreateUserResponse](#v2createuserresponse) |
+| default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
+
 ### /api/v2/{name}
 
 #### GET
@@ -851,26 +872,6 @@ UpdateUser updates a user.
 | 200 | A successful response. | [v2UpdateUserResponse](#v2updateuserresponse) |
 | default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
 
-### /v1/users
-
-#### POST
-##### Summary
-
-CreateUser creates a new user.
-
-##### Parameters
-
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| user | body |  | Yes | [v2User](#v2user) |
-
-##### Responses
-
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [v2CreateUserResponse](#v2createuserresponse) |
-| default | An unexpected error response. | [googlerpcStatus](#googlerpcstatus) |
-
 ---
 ## WebhookService
 
@@ -962,7 +963,7 @@ UpdateWebhook updates a webhook.
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
 | webhook.id | path |  | Yes | integer |
-| body | body |  | Yes | [WebhookServiceUpdateWebhookBody](#webhookserviceupdatewebhookbody) |
+| webhook | body |  | Yes | { **"creatorId"**: integer, **"createdTime"**: dateTime, **"updatedTime"**: dateTime, **"rowStatus"**: [apiv2RowStatus](#apiv2rowstatus), **"name"**: string, **"url"**: string } |
 
 ##### Responses
 
@@ -1009,7 +1010,7 @@ UpdateWorkspaceProfile updates the workspace profile.
 ---
 ## ActivityService
 
-### /v2/activities
+### /v2/activities/{id}
 
 #### GET
 ##### Summary
@@ -1020,7 +1021,7 @@ GetActivity returns the activity with the given id.
 
 | Name | Located in | Description | Required | Schema |
 | ---- | ---------- | ----------- | -------- | ------ |
-| id | query |  | No | integer |
+| id | path |  | Yes | integer |
 
 ##### Responses
 
@@ -1044,13 +1045,6 @@ GetActivity returns the activity with the given id.
 | ---- | ---- | ----------- | -------- |
 | resources | [ [v2Resource](#v2resource) ] |  | No |
 
-#### MemoServiceUpdateMemoBody
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| memo | [v2Memo](#v2memo) |  | No |
-| updateMask | string |  | No |
-
 #### UserRole
 
 | Name | Type | Description | Required |
@@ -1064,13 +1058,6 @@ GetActivity returns the activity with the given id.
 | description | string |  | No |
 | expiresAt | dateTime |  | No |
 
-#### WebhookServiceUpdateWebhookBody
-
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| webhook | { **"creatorId"**: integer, **"createdTime"**: dateTime, **"updatedTime"**: dateTime, **"rowStatus"**: [apiv2RowStatus](#apiv2rowstatus), **"name"**: string, **"url"**: string } |  | No |
-| updateMask | string |  | No |
-
 #### apiv2ActivityMemoCommentPayload
 
 | Name | Type | Description | Required |
@@ -1246,7 +1233,7 @@ GetActivity returns the activity with the given id.
 
 | Name | Type | Description | Required |
 | ---- | ---- | ----------- | -------- |
-| file | byte |  | No |
+| content | byte |  | No |
 
 #### v2GetActivityResponse