API docs by Redocly

Halo-Plus API Documentation (1.0.1)

Download OpenAPI specification:Download

nineya: blog@nineya.com URL: https://github.com/nineya/halo-plus/issues License: GNU General Public License v3.0 Terms of Service

Documentation for Halo-Plus API

admin-controller

Admin Controller

Gets environments info

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Gets halo log file content

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
lines
required
integer <int64>

lines

Responses

Checks Installation status

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Login

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
authcode
string = 6 characters
password
required
string [ 0 .. 100 ] characters
username
required
string [ 0 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "authcode": "string",
  • "password": "string",
  • "username": "string"
}

Login

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
authcode
string = 6 characters
password
required
string [ 0 .. 100 ] characters
username
required
string [ 0 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "authcode": "string",
  • "password": "string",
  • "username": "string"
}

Logs out (Clear session)

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Sends reset password verify code

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
email
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "username": "string"
}

Resets password by verify code

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
code
required
string
email
required
string
password
required
string [ 8 .. 100 ] characters
username
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "email": "string",
  • "password": "stringst",
  • "username": "string"
}

Refreshes token

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
refreshToken
required
string

refreshToken

Responses

attachment-controller

Attachment Controller

pageBy

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
attachmentType
string
Enum: "ALIOSS" "BAIDUBOS" "HUAWEIOBS" "LOCAL" "MINIO" "QINIUOSS" "SMMS" "TENCENTCOS" "UPOSS"
keyword
string
mediaType
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
team
string

Responses

Deletes attachments permanently in batch by id array

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Updates attachment in batch

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
id
integer <int32>
name
string [ 0 .. 255 ] characters
team
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Lists all of media types

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Lists all of photo teams

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Lists all of types.

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Uploads single file

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

Uploads multi files (Invalid in Swagger UI)

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: multipart/form-data
files
required
Array of strings <binary>

files

Responses

Updates a attachment

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
attachmentId
required
integer <int32>

attachmentId

Request Body schema: application/json
id
integer <int32>
name
string [ 0 .. 255 ] characters
team
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "team": "string"
}

Gets attachment detail by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
id
required
integer <int32>

id

Responses

Deletes attachment permanently by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
id
required
integer <int32>

id

Responses

backup-controller

Backup Controller

Lists all exported data

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Exports all data

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Deletes a exported data

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
filename
required
string

filename

Responses

getDataBackup

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
filename
required
string

filename

Responses

Downloads a exported data

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
fileName
required
string

fileName

Responses

Gets all markdown backups

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Exports markdowns

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
needFrontMatter
boolean

Responses

Request samples

Content type
application/json
{
  • "needFrontMatter": true
}

Deletes a markdown backup

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
filename
required
string

filename

Responses

Downloads a work markdown backup file

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
fileName
required
string

fileName

Responses

getMarkdownBackup

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
filename
required
string

filename

Responses

Imports markdown

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

Gets all work directory backups

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Backups work directory

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Deletes a work directory backup

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
filename
required
string

filename

Responses

getWorkDirBackup

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
filename
required
string

filename

Responses

Gets items that can be backed up

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Downloads a work directory backup file

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
filename
required
string

filename

Responses

category-controller

Category Controller

Lists all categories

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings
more
boolean

more

Responses

Creates category

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
description
string [ 0 .. 100 ] characters
id
integer <int32>
name
required
string [ 0 .. 255 ] characters
parentId
integer <int32>
password
string [ 0 .. 255 ] characters
priority
integer <int32>
slug
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "parentId": 0,
  • "password": "string",
  • "priority": 0,
  • "slug": "string",
  • "thumbnail": "string"
}

Updates category in batch

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
description
string [ 0 .. 100 ] characters
id
integer <int32>
name
required
string [ 0 .. 255 ] characters
parentId
integer <int32>
password
string [ 0 .. 255 ] characters
priority
integer <int32>
slug
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

List all categories as tree

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings

Responses

Gets category detail

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
categoryId
required
integer <int32>

categoryId

Responses

Updates category

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
categoryId
required
integer <int32>

categoryId

Request Body schema: application/json
description
string [ 0 .. 100 ] characters
id
integer <int32>
name
required
string [ 0 .. 255 ] characters
parentId
integer <int32>
password
string [ 0 .. 255 ] characters
priority
integer <int32>
slug
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "parentId": 0,
  • "password": "string",
  • "priority": 0,
  • "slug": "string",
  • "thumbnail": "string"
}

Deletes category

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
categoryId
required
integer <int32>

categoryId

Responses

install-controller

Install Controller

Initializes the blog

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
avatar
string [ 0 .. 1023 ] characters
description
string [ 0 .. 1023 ] characters
email
required
string [ 0 .. 127 ] characters
locale
string
nickname
required
string [ 0 .. 255 ] characters
password
string [ 8 .. 100 ] characters
title
required
string
url
string
username
required
string [ 0 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "avatar": "string",
  • "description": "string",
  • "email": "string",
  • "locale": "string",
  • "nickname": "string",
  • "password": "stringst",
  • "title": "string",
  • "url": "string",
  • "username": "string"
}

journal-comment-controller

Journal Comment Controller

Lists journal comments

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
status
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

Responses

Creates a journal comment

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
allowNotification
boolean
author
required
string [ 0 .. 50 ] characters
authorUrl
string [ 0 .. 255 ] characters
content
required
string [ 0 .. 1023 ] characters
email
string [ 0 .. 255 ] characters
parentId
integer <int64>
postId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowNotification": true,
  • "author": "string",
  • "authorUrl": "string",
  • "content": "string",
  • "email": "string",
  • "parentId": 0,
  • "postId": 0
}

Lists latest journal comments

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
top
integer <int32>

top

status
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Responses

Updates a journal comment by comment id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Request Body schema: application/json
allowNotification
boolean
author
required
string [ 0 .. 50 ] characters
authorUrl
string [ 0 .. 255 ] characters
content
required
string [ 0 .. 1023 ] characters
email
string [ 0 .. 255 ] characters
parentId
integer <int64>
postId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowNotification": true,
  • "author": "string",
  • "authorUrl": "string",
  • "content": "string",
  • "email": "string",
  • "parentId": 0,
  • "postId": 0
}

Deletes comment permanently and recursively

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Responses

Updates comment status

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

status
required
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Responses

Lists comment with list view

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
journalId
required
integer <int32>

journalId

query Parameters
sort
Array of strings
page
integer <int32>

page

Responses

Lists comments with tree view

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
journalId
required
integer <int32>

journalId

query Parameters
sort
Array of strings
page
integer <int32>

page

Responses

journal-controller

Journal Controller

Lists journals

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
type
string
Enum: "INTIMATE" "PUBLIC"

Responses

Creates a journal

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
content
string
keepRaw
boolean
sourceContent
required
string
type
string
Enum: "INTIMATE" "PUBLIC"

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "keepRaw": true,
  • "sourceContent": "string",
  • "type": "INTIMATE"
}

Gets latest journals

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
top
integer <int32>

top

Responses

Updates a Journal

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
id
required
integer <int32>

id

Request Body schema: application/json
content
string
keepRaw
boolean
sourceContent
required
string
type
string
Enum: "INTIMATE" "PUBLIC"

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "keepRaw": true,
  • "sourceContent": "string",
  • "type": "INTIMATE"
}

Delete journal

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
journalId
required
integer <int32>

journalId

Responses

log-controller

Log Controller

Lists logs

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
page
integer <int32>
size
integer <int32>
sort
Array of strings

Responses

Clears all logs

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Pages latest logs

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
top
integer <int32>

top

Responses

mail-controller

Mail Controller

Tests the SMTP service

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
content
required
string
subject
required
string
to
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "subject": "string",
  • "to": "string"
}

Test connection with email server

Authorizations:
ADMIN-Authorizationadmin_token

Responses

menu-controller

Menu Controller

Lists all menus

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings

Responses

Creates a menu

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
icon
string [ 0 .. 50 ] characters
id
integer <int32>
name
required
string [ 0 .. 50 ] characters
parentId
integer <int32>
priority
integer <int32>
target
string [ 0 .. 50 ] characters
team
string [ 0 .. 255 ] characters
url
required
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
{
  • "icon": "string",
  • "id": 0,
  • "name": "string",
  • "parentId": 0,
  • "priority": 0,
  • "target": "string",
  • "team": "string",
  • "url": "string"
}

updateBatchBy

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
icon
string [ 0 .. 50 ] characters
id
integer <int32>
name
required
string [ 0 .. 50 ] characters
parentId
integer <int32>
priority
integer <int32>
target
string [ 0 .. 50 ] characters
team
string [ 0 .. 255 ] characters
url
required
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

createBatchBy

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
icon
string [ 0 .. 50 ] characters
id
integer <int32>
name
required
string [ 0 .. 50 ] characters
parentId
integer <int32>
priority
integer <int32>
target
string [ 0 .. 50 ] characters
team
string [ 0 .. 255 ] characters
url
required
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

deleteBatchBy

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Lists menus as tree by team

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings
team
required
string

team

Responses

Lists all menu teams

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Lists menus as tree

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings

Responses

Gets menu detail by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
menuId
required
integer <int32>

menuId

Responses

Updates a menu

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
menuId
required
integer <int32>

menuId

Request Body schema: application/json
icon
string [ 0 .. 50 ] characters
id
integer <int32>
name
required
string [ 0 .. 50 ] characters
parentId
integer <int32>
priority
integer <int32>
target
string [ 0 .. 50 ] characters
team
string [ 0 .. 255 ] characters
url
required
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
{
  • "icon": "string",
  • "id": 0,
  • "name": "string",
  • "parentId": 0,
  • "priority": 0,
  • "target": "string",
  • "team": "string",
  • "url": "string"
}

Deletes a menu

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
menuId
required
integer <int32>

menuId

Responses

migrate-controller

Migrate Controller

Migrate from Halo

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

option-controller

Option Controller

Lists options

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Creates option

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
key
required
string [ 0 .. 100 ] characters
type
string
Enum: "CUSTOM" "INTERNAL"
value
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "type": "CUSTOM",
  • "value": "string"
}

Lists all options with list view

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
type
string
Enum: "CUSTOM" "INTERNAL"

Responses

Lists all options with map view

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Lists options with map view by keys

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Saves options by option map

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Saves options

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
key
required
string [ 0 .. 100 ] characters
type
string
Enum: "CUSTOM" "INTERNAL"
value
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Gets option detail by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
id
required
integer <int32>

id

Responses

Updates option

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
optionId
required
integer <int32>

optionId

Request Body schema: application/json
key
required
string [ 0 .. 100 ] characters
type
string
Enum: "CUSTOM" "INTERNAL"
value
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "type": "CUSTOM",
  • "value": "string"
}

Deletes option

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
optionId
required
integer <int32>

optionId

Responses

photo-controller

Photo Controller

Lists photos

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
team
string

Responses

Creates a photo

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
description
string
id
integer <int32>
location
string
name
required
string
takeTime
string <date-time>
team
string
thumbnail
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "location": "string",
  • "name": "string",
  • "takeTime": "2019-08-24T14:15:22Z",
  • "team": "string",
  • "thumbnail": "string",
  • "url": "string"
}

Updates photo in batch

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
description
string
id
integer <int32>
location
string
name
required
string
takeTime
string <date-time>
team
string
thumbnail
required
string
url
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Batch creation photos

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
description
string
id
integer <int32>
location
string
name
required
string
takeTime
string <date-time>
team
string
thumbnail
required
string
url
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Deletes photos permanently in batch by id array

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Lists latest photos

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings

Responses

Lists all of photo teams

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Gets photo detail by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
photoId
required
integer <int32>

photoId

Responses

Updates a photo

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
photoId
required
integer <int32>

photoId

Request Body schema: application/json
description
string
id
integer <int32>
location
string
name
required
string
takeTime
string <date-time>
team
string
thumbnail
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "location": "string",
  • "name": "string",
  • "takeTime": "2019-08-24T14:15:22Z",
  • "team": "string",
  • "thumbnail": "string",
  • "url": "string"
}

Deletes photo by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
photoId
required
integer <int32>

photoId

Responses

Likes a photo

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
photoId
required
integer <int32>

photoId

Responses

post-comment-controller

Post Comment Controller

Lists post comments

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
status
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

Responses

Creates a post comment (new or reply)

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
allowNotification
boolean
author
required
string [ 0 .. 50 ] characters
authorUrl
string [ 0 .. 255 ] characters
content
required
string [ 0 .. 1023 ] characters
email
string [ 0 .. 255 ] characters
parentId
integer <int64>
postId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowNotification": true,
  • "author": "string",
  • "authorUrl": "string",
  • "content": "string",
  • "email": "string",
  • "parentId": 0,
  • "postId": 0
}

Delete post comments permanently in batch by id array

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Pages post latest comments

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
top
integer <int32>

top

status
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Responses

Updates post comment status in batch

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
status
required
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Request Body schema: application/json
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Gets a post comment by comment id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Responses

Updates a post comment

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Request Body schema: application/json
allowNotification
boolean
author
required
string [ 0 .. 50 ] characters
authorUrl
string [ 0 .. 255 ] characters
content
required
string [ 0 .. 1023 ] characters
email
string [ 0 .. 255 ] characters
parentId
integer <int64>
postId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowNotification": true,
  • "author": "string",
  • "authorUrl": "string",
  • "content": "string",
  • "email": "string",
  • "parentId": 0,
  • "postId": 0
}

Deletes post comment permanently and recursively

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Responses

Updates post comment status

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

status
required
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Responses

Lists post comment with list view

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

query Parameters
sort
Array of strings
page
integer <int32>

page

Responses

Lists post comments with tree view

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

query Parameters
sort
Array of strings
page
integer <int32>

page

Responses

post-controller

Post Controller

Lists posts

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
categoryId
integer <int32>
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
status
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"
statuses
Array of strings unique
more
boolean

more

Responses

Creates a post

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
autoSave
boolean

autoSave

Request Body schema: application/json
categoryIds
Array of integers <int32> unique [ items <int32 > ]
content
string
createTime
string <date-time>
disallowComment
boolean
editorType
string
Enum: "MARKDOWN" "RICHTEXT"
keepRaw
boolean
metaDescription
string
metaKeywords
string
Array of objects (PostMetaParam) unique
originalContent
string
password
string [ 0 .. 255 ] characters
slug
string [ 0 .. 255 ] characters
status
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"
summary
string
tagIds
Array of integers <int32> unique [ items <int32 > ]
template
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters
title
required
string [ 0 .. 100 ] characters
topPriority
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "categoryIds": [
    ],
  • "content": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "disallowComment": true,
  • "editorType": "MARKDOWN",
  • "keepRaw": true,
  • "metaDescription": "string",
  • "metaKeywords": "string",
  • "metas": [
    ],
  • "originalContent": "string",
  • "password": "string",
  • "slug": "string",
  • "status": "DRAFT",
  • "summary": "string",
  • "tagIds": [
    ],
  • "template": "string",
  • "thumbnail": "string",
  • "title": "string",
  • "topPriority": 0
}

Deletes posts permanently in batch by id array

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Pages latest post

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
top
integer <int32>

top

Responses

Gets a post preview link

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

Responses

Gets a page of post by post status

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
status
required
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"

status

query Parameters
page
integer <int32>
size
integer <int32>
sort
Array of strings
more
boolean

more

Responses

Updates post status in batch

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
status
required
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"

status

Request Body schema: application/json
Array
integer <int32>

Responses

Request samples

Content type
application/json
[
  • 0
]

Gets a post

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

Responses

Updates a post

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

query Parameters
autoSave
boolean

autoSave

Request Body schema: application/json
categoryIds
Array of integers <int32> unique [ items <int32 > ]
content
string
createTime
string <date-time>
disallowComment
boolean
editorType
string
Enum: "MARKDOWN" "RICHTEXT"
keepRaw
boolean
metaDescription
string
metaKeywords
string
Array of objects (PostMetaParam) unique
originalContent
string
password
string [ 0 .. 255 ] characters
slug
string [ 0 .. 255 ] characters
status
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"
summary
string
tagIds
Array of integers <int32> unique [ items <int32 > ]
template
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters
title
required
string [ 0 .. 100 ] characters
topPriority
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "categoryIds": [
    ],
  • "content": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "disallowComment": true,
  • "editorType": "MARKDOWN",
  • "keepRaw": true,
  • "metaDescription": "string",
  • "metaKeywords": "string",
  • "metas": [
    ],
  • "originalContent": "string",
  • "password": "string",
  • "slug": "string",
  • "status": "DRAFT",
  • "summary": "string",
  • "tagIds": [
    ],
  • "template": "string",
  • "thumbnail": "string",
  • "title": "string",
  • "topPriority": 0
}

Deletes a post permanently

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

Responses

Likes a post

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

Responses

Gets a post preview link

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

Responses

Updates draft

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

Request Body schema: application/json
content
string
keepRaw
boolean
originalContent
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "keepRaw": true,
  • "originalContent": "string"
}

Updates post status

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
postId
required
integer <int32>

postId

status
required
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"

status

Responses

sheet-comment-controller

Sheet Comment Controller

Lists sheet comments

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
keyword
string
page
integer <int32>
size
integer <int32>
sort
Array of strings
status
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

Responses

Creates a sheet comment (new or reply)

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
allowNotification
boolean
author
required
string [ 0 .. 50 ] characters
authorUrl
string [ 0 .. 255 ] characters
content
required
string [ 0 .. 1023 ] characters
email
string [ 0 .. 255 ] characters
parentId
integer <int64>
postId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowNotification": true,
  • "author": "string",
  • "authorUrl": "string",
  • "content": "string",
  • "email": "string",
  • "parentId": 0,
  • "postId": 0
}

Deletes sheet comments permanently in batch by id array

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Lists latest sheet comments

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
top
integer <int32>

top

status
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Responses

Updates sheet comment status in batch

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
status
required
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Request Body schema: application/json
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

Gets a sheet comment by comment id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Responses

Updates a sheet comment

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Request Body schema: application/json
allowNotification
boolean
author
required
string [ 0 .. 50 ] characters
authorUrl
string [ 0 .. 255 ] characters
content
required
string [ 0 .. 1023 ] characters
email
string [ 0 .. 255 ] characters
parentId
integer <int64>
postId
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "allowNotification": true,
  • "author": "string",
  • "authorUrl": "string",
  • "content": "string",
  • "email": "string",
  • "parentId": 0,
  • "postId": 0
}

Deletes sheet comment permanently and recursively

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

Responses

Updates sheet comment status

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
commentId
required
integer <int64>

commentId

status
required
string
Enum: "AUDITING" "PUBLISHED" "RECYCLE"

status

Responses

Lists sheet comment with list view

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

query Parameters
sort
Array of strings
page
integer <int32>

page

Responses

Lists sheet comments with tree view

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

query Parameters
sort
Array of strings
page
integer <int32>

page

Responses

sheet-controller

Sheet Controller

Gets a page of sheet

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
page
integer <int32>
size
integer <int32>
sort
Array of strings

Responses

Creates a sheet

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
autoSave
boolean

autoSave

Request Body schema: application/json
content
string
createTime
string <date-time>
disallowComment
boolean
editorType
string
Enum: "MARKDOWN" "RICHTEXT"
keepRaw
boolean
metaDescription
string
metaKeywords
string
Array of objects (SheetMetaParam) unique
originalContent
string
password
string [ 0 .. 255 ] characters
slug
string [ 0 .. 255 ] characters
status
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"
summary
string
template
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters
title
required
string [ 0 .. 100 ] characters
topPriority
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "disallowComment": true,
  • "editorType": "MARKDOWN",
  • "keepRaw": true,
  • "metaDescription": "string",
  • "metaKeywords": "string",
  • "metas": [
    ],
  • "originalContent": "string",
  • "password": "string",
  • "slug": "string",
  • "status": "DRAFT",
  • "summary": "string",
  • "template": "string",
  • "thumbnail": "string",
  • "title": "string",
  • "topPriority": 0
}

Lists independent sheets

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Gets a sheet preview link

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

Responses

Gets a sheet

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

Responses

Updates a sheet

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

query Parameters
autoSave
boolean

autoSave

Request Body schema: application/json
content
string
createTime
string <date-time>
disallowComment
boolean
editorType
string
Enum: "MARKDOWN" "RICHTEXT"
keepRaw
boolean
metaDescription
string
metaKeywords
string
Array of objects (SheetMetaParam) unique
originalContent
string
password
string [ 0 .. 255 ] characters
slug
string [ 0 .. 255 ] characters
status
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"
summary
string
template
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters
title
required
string [ 0 .. 100 ] characters
topPriority
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "createTime": "2019-08-24T14:15:22Z",
  • "disallowComment": true,
  • "editorType": "MARKDOWN",
  • "keepRaw": true,
  • "metaDescription": "string",
  • "metaKeywords": "string",
  • "metas": [
    ],
  • "originalContent": "string",
  • "password": "string",
  • "slug": "string",
  • "status": "DRAFT",
  • "summary": "string",
  • "template": "string",
  • "thumbnail": "string",
  • "title": "string",
  • "topPriority": 0
}

Deletes a sheet

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

Responses

Updates draft

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

Request Body schema: application/json
content
string
keepRaw
boolean
originalContent
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "keepRaw": true,
  • "originalContent": "string"
}

Updates a sheet

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
sheetId
required
integer <int32>

sheetId

status
required
string
Enum: "DRAFT" "INTIMATE" "PUBLISHED" "RECYCLE"

status

Responses

static-storage-controller

Static Storage Controller

Lists static files

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Creates a folder

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
basePath
string

basePath

folderName
required
string

folderName

Responses

Deletes file by relative path

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
path
required
string

path

Responses

Save static file

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
content
string
path
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "path": "string"
}

Renames static file

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
basePath
string

basePath

newName
string

newName

Responses

Uploads static file

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
basePath
string

basePath

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

statistic-controller

Statistic Controller

Gets blog statistics.

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Gets blog statistics with user

Authorizations:
ADMIN-Authorizationadmin_token

Responses

tag-controller

Tag Controller

Lists tags

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
sort
Array of strings
more
boolean

Return more information(post count) if it is set

Responses

Creates a tag

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
color
string [ 0 .. 24 ] characters

标签颜色，支持多种颜色模式，例如 Hex: #cfd3d7，颜色名称：LightGrey，RGB: rgb(207, 211, 215)，RGBA: rgb(207, 211, 215, 0.5)等

name
required
string [ 0 .. 255 ] characters
slug
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
{
  • "color": "#e23d66",
  • "name": "string",
  • "slug": "string",
  • "thumbnail": "string"
}

Gets tag detail by id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
tagId
required
integer <int32>

tagId

Responses

Updates a tag

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
tagId
required
integer <int32>

tagId

Request Body schema: application/json
color
string [ 0 .. 24 ] characters

标签颜色，支持多种颜色模式，例如 Hex: #cfd3d7，颜色名称：LightGrey，RGB: rgb(207, 211, 215)，RGBA: rgb(207, 211, 215, 0.5)等

name
required
string [ 0 .. 255 ] characters
slug
string [ 0 .. 255 ] characters
thumbnail
string [ 0 .. 1023 ] characters

Responses

Request samples

Content type
application/json
{
  • "color": "#e23d66",
  • "name": "string",
  • "slug": "string",
  • "thumbnail": "string"
}

Deletes a tag

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
tagId
required
integer <int32>

tagId

Responses

theme-controller

Theme Controller

Lists all themes

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Gets activate theme

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Fetches activated theme configuration

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Lists all activate theme files

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Lists activated theme settings

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Saves theme settings

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Gets custom post templates

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Gets custom sheet templates

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Determines if template exists

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
template
required
string

template

Responses

Fetches a new theme

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
uri
required
string

uri

Responses

Upgrades theme from remote

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Gets template content

Authorizations:
ADMIN-Authorizationadmin_token
query Parameters
path
required
string

path

Responses

Updates template content

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
content
string
path
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "path": "string"
}

Reloads themes

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Uploads a theme

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

Upgrades theme by file

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

Gets theme property by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Deletes a theme

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

query Parameters
deleteSettings
boolean

deleteSettings

Responses

Activates a theme

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Fetches theme configuration by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Fetches theme configuration group names by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Fetches theme configuration by theme id and group name

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

group
required
string

group

Responses

Lists theme files by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Gets template content by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

query Parameters
path
required
string

path

Responses

Updates template content by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Request Body schema: application/json
content
string
path
string

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "path": "string"
}

Lists theme settings by theme id and group name

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

group
required
string

group

Responses

Lists theme settings by theme id

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Responses

Saves theme settings

Authorizations:
ADMIN-Authorizationadmin_token
path Parameters
themeId
required
string

themeId

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

user-controller

User Controller

Generate Multi-Factor Auth qr image

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
authcode
required
string = 6 characters
mfaKey
string
mfaType
string
Enum: "NONE" "TFA_TOTP"

Responses

Request samples

Content type
application/json
{
  • "authcode": "string",
  • "mfaKey": "string",
  • "mfaType": "NONE"
}

Updates user's Multi Factor Auth

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
authcode
required
string = 6 characters
mfaKey
string
mfaType
string
Enum: "NONE" "TFA_TOTP"

Responses

Request samples

Content type
application/json
{
  • "authcode": "string",
  • "mfaKey": "string",
  • "mfaType": "NONE"
}

Gets user profile

Authorizations:
ADMIN-Authorizationadmin_token

Responses

Updates user profile

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
avatar
string [ 0 .. 1023 ] characters
description
string [ 0 .. 1023 ] characters
email
required
string [ 0 .. 127 ] characters
nickname
required
string [ 0 .. 255 ] characters
password
string [ 8 .. 100 ] characters
username
required
string [ 0 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "avatar": "string",
  • "description": "string",
  • "email": "string",
  • "nickname": "string",
  • "password": "stringst",
  • "username": "string"
}

Updates user's password

Authorizations:
ADMIN-Authorizationadmin_token
Request Body schema: application/json
newPassword
required
string [ 0 .. 100 ] characters
oldPassword
required
string [ 0 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "newPassword": "string",
  • "oldPassword": "string"
}