Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit cdad1e7

Browse files
committedNov 24, 2024··
Add API docs
1 parent c2bb1e6 commit cdad1e7

File tree

4 files changed

+25
-7
lines changed

4 files changed

+25
-7
lines changed
 

‎api-reference/authentication.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Authentication
1+
---
2+
title: 'Authentication'
3+
description: 'Learn how to authenticate with the Cachet API'
4+
---
25

36
<Tip>
47
Cachet is built on the belief that your service status is open and transparent, therefore all `GET` requests are public and require no authentication to access the information.

‎api-reference/endpoints.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# Endpoints
2-
3-
## Endpoints
1+
---
2+
title: 'Endpoints'
3+
description: 'Here you can find all the available endpoints for the Cachet API.'
4+
---
45

56
Cachet provides a RESTful JSON API that allows you to interact with the application programmatically. The API is designed to be simple and easy to use.
67

7-
:::info Under Development
8+
<Info>
89
The API is currently active development and may change in the future. Please check back for updates.
9-
:::
10+
</Info>
1011

1112
### General
1213

‎api-reference/introduction.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# API
1+
---
2+
title: 'Introduction'
3+
---
24

35
<Warning>
46
This documentation refers to the Cachet v3 API. If you are looking for the Cachet v2 API, please refer to the previous [Cachet API documentation](https://github.com/cachethq/docs/tree/2.x).

‎mint.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@
3838
"name": "Blog",
3939
"icon": "newspaper",
4040
"url": "https://blog.cachethq.io"
41+
},
42+
{
43+
"name": "API Reference",
44+
"url": "api-reference",
45+
"icon": "square-terminal"
4146
}
4247
],
4348
"navigation": [
@@ -69,6 +74,13 @@
6974
"configuration/queue",
7075
"configuration/subscribers"
7176
]
77+
}, {
78+
"group": "API Documentation",
79+
"pages": [
80+
"api-reference/introduction",
81+
"api-reference/authentication",
82+
"api-reference/endpoints"
83+
]
7284
}
7385
],
7486
"footerSocials": {

0 commit comments

Comments
 (0)
Please sign in to comment.