Download OpenAPI specification:Download
Get comments of the page of the revision
| page_id | string (ObjectId) Example: page_id=5ae5fccfc5577b0004dbd8ab Object ID |
| revision_id | string (ObjectId) Example: revision_id=5ae5fccfc5577b0004dbd8ab Object ID |
{- "ok": true,
- "comments": [
- {
- "_id": "5ae5fccfc5577b0004dbd8ab",
- "__v": 0,
- "page": "5ae5fccfc5577b0004dbd8ab",
- "creator": "5ae5fccfc5577b0004dbd8ab",
- "revision": "5ae5fccfc5577b0004dbd8ab",
- "comment": "good",
- "commentPosition": 0,
- "createdAt": "2010-01-01T00:00:00.000Z"
}
]
}Post comment for the page
required | object |
{- "commentForm": {
- "page_id": "5ae5fccfc5577b0004dbd8ab",
- "revision_id": "5ae5fccfc5577b0004dbd8ab",
- "comment": "good",
- "comment_position": 0
}
}{- "ok": true,
- "comment": {
- "_id": "5ae5fccfc5577b0004dbd8ab",
- "__v": 0,
- "page": "5ae5fccfc5577b0004dbd8ab",
- "creator": "5ae5fccfc5577b0004dbd8ab",
- "revision": "5ae5fccfc5577b0004dbd8ab",
- "comment": "good",
- "commentPosition": 0,
- "createdAt": "2010-01-01T00:00:00.000Z"
}
}Update comment dody
required | object |
{- "form": {
- "commentForm": {
- "page_id": "5ae5fccfc5577b0004dbd8ab",
- "revision_id": "5ae5fccfc5577b0004dbd8ab",
- "comment_id": "5ae5fccfc5577b0004dbd8ab",
- "comment": "good"
}
}
}{- "ok": true,
- "comment": {
- "_id": "5ae5fccfc5577b0004dbd8ab",
- "__v": 0,
- "page": "5ae5fccfc5577b0004dbd8ab",
- "creator": "5ae5fccfc5577b0004dbd8ab",
- "revision": "5ae5fccfc5577b0004dbd8ab",
- "comment": "good",
- "commentPosition": 0,
- "createdAt": "2010-01-01T00:00:00.000Z"
}
}Remove specified comment
| comment_id required | string (ObjectId) Object ID |
{- "comment_id": "5ae5fccfc5577b0004dbd8ab"
}{- "ok": true
}Retrieve all tags associated with a specific page
| pageId required | string <ObjectId> Example: pageId=507f1f77bcf86cd799439011 Unique identifier of the page |
{- "ok": true,
- "tags": [
- "javascript",
- "tutorial",
- "backend"
]
}Retrieve UpdatePost notification settings for a specific path
| path required | string Examples:
Page path to get UpdatePost settings for |
{- "ok": true,
- "updatePost": [
- "general",
- "development",
- "notifications"
]
}Delete a page either softly or completely, with optional recursive deletion
| page_id required | string <ObjectId> Unique identifier of the page to delete |
| revision_id | string <ObjectId> Revision ID for conflict detection |
| completely | boolean Default: false Whether to delete the page completely (true) or soft delete (false) |
| recursively | boolean Default: false Whether to delete child pages recursively |
{- "page_id": "507f1f77bcf86cd799439011",
- "revision_id": "507f1f77bcf86cd799439012"
}{- "ok": true,
- "path": "/user/example",
- "isRecursively": true,
- "isCompletely": false
}Restore a previously deleted (soft-deleted) page
| page_id required | string <ObjectId> Unique identifier of the page to restore |
| recursively | boolean Default: false Whether to restore child pages recursively |
{- "page_id": "507f1f77bcf86cd799439011"
}{- "ok": true,
- "page": {
- "_id": "507f1f77bcf86cd799439011",
- "path": "/user/example",
- "title": "Example Page",
- "status": "published"
}
}Remove all redirect entries that point to the specified page path
| path required | string Target path to remove redirects for |
{- "path": "/user/example"
}{- "ok": true,
- "path": "/user/example"
}Upload profile image
| file | string <binary> attachment data |
| user | string user to set profile image |
{- "ok": true,
- "attachment": {
- "id": "5e0734e072560e001761fa67",
- "_id": "5e0734e072560e001761fa67",
- "__v": 0,
- "fileFormat": "image/png",
- "fileName": "601b7c59d43a042c0117e08dd37aad0a.png",
- "originalName": "profile.png",
- "creator": "5ae5fccfc5577b0004dbd8ab",
- "page": null,
- "createdAt": "2010-01-01T00:00:00.000Z",
- "fileSize": 3494332,
- "filePathProxied": "/attachment/5e0734e072560e001761fa67",
- "downloadPathProxied": "/download/5e0734e072560e001761fa67"
}
}Remove attachment
| attachment_id required | string (ObjectId) Object ID |
{- "attachment_id": "5ae5fccfc5577b0004dbd8ab"
}{- "ok": true
}Remove profile image
| user | string user to remove profile image |
{- "user": "string"
}{- "ok": true
}object |
{- "registerForm": {
- "name": "string",
- "username": "string",
- "email": "string",
- "password": "string"
}
}{- "redirectTo": "string"
}Search pages
| q required | string Example: q=daily report keyword |
| path | string (PagePath) Example: path=/path/to/page Page path |
| offset | integer (Offset) Example: offset=0 Offset for pagination |
| limit | integer (Limit) Example: limit=10 Limit for pagination |
{- "ok": true,
- "meta": {
- "took": 34,
- "total": 2,
- "results": 2
}, - "totalCount": 35,
- "data": [
- {
- "_id": "5ae5fccfc5577b0004dbd8ab",
- "__v": 0,
- "commentCount": 3,
- "createdAt": "2010-01-01T00:00:00.000Z",
- "creator": {
- "__v": 0,
- "_id": "5ae5fccfc5577b0004dbd8ab",
- "lang": "en_US",
- "status": 0,
- "admin": false,
- "email": "alice@aaa.aaa",
- "username": "alice",
- "name": "Alice",
- "createdAt": "2010-01-01T00:00:00.000Z"
}, - "extended": { },
- "grant": 1,
- "grantedUsers": [
- "5ae5fccfc5577b0004dbd8ab"
], - "lastUpdateUser": {
- "__v": 0,
- "_id": "5ae5fccfc5577b0004dbd8ab",
- "lang": "en_US",
- "status": 0,
- "admin": false,
- "email": "alice@aaa.aaa",
- "username": "alice",
- "name": "Alice",
- "createdAt": "2010-01-01T00:00:00.000Z"
}, - "liker": [ ],
- "path": "/path/to/page",
- "revision": "string",
- "seenUsers": [
- "5ae5fccfc5577b0004dbd8ab"
], - "status": "published",
- "updatedAt": "2010-01-01T00:00:00.000Z"
}
]
}Update tag
| pageId | string (ObjectId) Object ID |
| revisionId | string (ObjectId) Object ID |
| tags | Array of strings (Tags) Tags |
{- "pageId": "5ae5fccfc5577b0004dbd8ab",
- "revisionId": "5ae5fccfc5577b0004dbd8ab",
- "tags": [
- "daily",
- "report",
- "tips"
]
}{- "ok": true,
- "tags": [
- "daily",
- "report",
- "tips"
]
}Get tags
| limit | integer (Limit) Example: limit=10 Limit for pagination |
| offset | integer (Offset) Example: offset=0 Offset for pagination |
{- "ok": true,
- "data": [
- {
- "_id": "5e2d6aede35da4004ef7e0b7",
- "name": "daily",
- "count": 3
}
]
}