HealthCheck schema · VitePress OpenAPI Docs

Skip to content

VitePress OpenAPI Docs

Main Navigation Guide Reference

Appearance

Sidebar Navigation

albums

List all albums

Create album

Get album by ID

Replace album

Partially update album

Delete album

List album's photos

auth

HTTP Basic demo

Log in

Log out

Get current user

Refresh token

Register new user

categories

List all categories

Create category

Get category by ID

Replace category

Partially update category

Delete category

List category's products

comments

List all comments

Create comment

Get comment by ID

Replace comment

Partially update comment

Delete comment

database

Admin aggregate report

Export database

Reset database

Re-seed database

Database stats

OpenAPI spec

notifications

List all notifications

Create notification

Get notification by ID

Replace notification

Partially update notification

Delete notification

orders

List all orders

Create order

Get order by ID

Replace order

Partially update order

Delete order

photos

List all photos

Create photo

Get photo by ID

Replace photo

Partially update photo

Delete photo

posts

List all posts

Create post

Get post by ID

Replace post

Partially update post

Delete post

List post's comments

products

List all products

Create product

Get product by ID

Replace product

Partially update product

Delete product

List product's reviews

reviews

List all reviews

Create review

Get review by ID

Replace review

Partially update review

Delete review

todos

List all todos

Create todo

Get todo by ID

Replace todo

Partially update todo

Delete todo

users

List all users

Create user

Get user by ID

Replace user

Partially update user

Delete user

List user's albums

List user's comments

List user's notifications

List user's orders

List user's posts

List user's reviews

List user's tasks

utils

Batch operations

Delayed response

Echo request

Echo POST

Health check

Random number(s)

Lorem Ipsum

Random UUID(s)

Return HTTP status code

SSE event stream

Mock file upload

webhooks

List webhooks

Register webhook

Get webhook

Update webhook

Delete webhook

Delivery history

Send test event

Album created

Album deleted

Album updated

Category created

Category deleted

Category updated

Comment created

Comment deleted

Comment updated

Notification created

Notification deleted

Notification updated

Order created

Order deleted

Order updated

Photo created

Photo deleted

Photo updated

Post created

Post deleted

Post updated

Product created

Product deleted

Product updated

Review created

Review deleted

Review updated

Todo created

Todo deleted

Todo updated

User created

User deleted

User updated

Test ping

Schemas

AdminReport

Album

AlbumInput

AuthCredentials

AuthResponse

BasicDemoResponse

BatchOperation

BatchResult

Category

CategoryInput

Comment

CommentInput

DbStats

EchoResponse

Error

HealthCheck

Notification

NotificationInput

Order

OrderInput

Photo

PhotoInput

Post

PostInput

Product

ProductInput

Review

ReviewInput

SeedRequest

Todo

TodoInput

TokenResponse

UploadResponse

User

UserInput

Webhook

WebhookDelivery

WebhookInput

WebhookPayload

Changelog

History

On this page

HealthCheck object

Field	Type	Description
`status`required	string
`uptime`required	number (double)	Uptime in seconds
`timestamp`required	string (date-time)
`memory`	object
`data`	object	Record counts

Released under the MIT License.

Copyright © 2024-present vitepress-openapi-docs contributors