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 swagger docs

Browse Source
This commit is contained in:
Steven
2023-09-27 00:52:42 +08:00
parent 03a0972712
commit 9d1c9fc505
3 changed files with 3 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
docs/api/v1.md
View File

@@ -476,72 +476,6 @@ Removes a relation between two memos
| 400 | Memo ID is not a number: %s \| Related memo ID is not a number: %s | |
| 500 | Failed to delete memo relation | |
---
### /api/v1/memo/{memoId}/resource
#### GET
##### Summary
Get resource list of a memo
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| memoId | path | ID of memo to fetch resource list from | Yes | integer |
##### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Memo resource list | [ [v1.Resource](#v1resource) ] |
| 400 | ID is not a number: %s | |
| 500 | Failed to fetch resource list | |
#### POST
##### Summary
Bind resource to memo
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| memoId | path | ID of memo to bind resource to | Yes | integer |
| body | body | Memo resource request object | Yes | [v1.UpsertMemoResourceRequest](#v1upsertmemoresourcerequest) |
##### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Memo resource binded | boolean |
| 400 | ID is not a number: %s \| Malformatted post memo resource request \| Resource not found | |
| 401 | Missing user in session \| Unauthorized to bind this resource | |
| 500 | Failed to fetch resource \| Failed to upsert memo resource | |
### /api/v1/memo/{memoId}/resource/{resourceId}
#### DELETE
##### Summary
Unbind resource from memo
##### Parameters
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| memoId | path | ID of memo to unbind resource from | Yes | integer |
| resourceId | path | ID of resource to unbind from memo | Yes | integer |
##### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Memo resource unbinded. *200 is returned even if the reference doesn't exists | boolean |
| 400 | Memo ID is not a number: %s \| Resource ID is not a number: %s \| Memo not found | |
| 401 | Missing user in session \| Unauthorized | |
| 500 | Failed to find memo \| Failed to fetch resource list | |
---
### /api/v1/ping
@@ -1260,7 +1194,7 @@ Get website metadata
| filename | string | Domain specific fields | No |
| id | integer | | No |
| internalPath | string | | No |
| linkedMemoAmount | integer | | No |
| memoID | integer | | No |
| size | integer | | No |
| type | string | | No |
| updatedTs | integer | | No |
@@ -1438,20 +1372,6 @@ Get website metadata
| updatedTs | integer | | No |
| visibility | [v1.Visibility](#v1visibility) | | No |
#### v1.Resource
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| createdTs | integer | | No |
| creatorId | integer | Standard fields | No |
| externalLink | string | | No |
| filename | string | Domain specific fields | No |
| id | integer | | No |
| linkedMemoAmount | integer | Related fields | No |
| size | integer | | No |
| type | string | | No |
| updatedTs | integer | | No |
#### v1.Role
| Name | Type | Description | Required |
@@ -1591,13 +1511,6 @@ Get website metadata
| relatedMemoId | integer | | No |
| type | [v1.MemoRelationType](#v1memorelationtype) | | No |
#### v1.UpsertMemoResourceRequest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| resourceId | integer | | No |
| updatedTs | integer | | No |
#### v1.UpsertSystemSettingRequest
| Name | Type | Description | Required |