liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: temporarily add warning message about pre-release apiv2 docs

Browse Source
This commit is contained in:
spiral 2021-10-30 18:50:19 -04:00
parent d9da50c189
commit 7c9a375393
No known key found for this signature in database
GPG Key ID: A6059F0CA0E1BD31
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/content/api/legacy.md
View File

@ -4,10 +4,10 @@ permalink: /api/legacy
---
# Legacy API documentation
<!--
::: warning
This is the documentation for v1 of the PluralKit API. Please use v2 going forwards - v1 is deprecated and will be removed eventually.
:::
::: -->
## Models
The following three models (usually represented in JSON format) represent the various objects in PluralKit's API.

6
docs/content/api/reference.md
View File

@ -1,6 +1,6 @@
---
title: Reference
permalink: /api/reference
permalink: /api
---
# API Reference
@ -8,6 +8,10 @@ permalink: /api/reference
PluralKit has a basic HTTP REST API for querying and modifying your system.
The root endpoint of the API is `https://api.pluralkit.me/v2/`.
::: warning
This documentation is currently pre-release. Until this notice is removed, please refer to the [legacy API documentation](/api/legacy) for model and endpoint information.
:::
#### Authorization header token example
```
Authorization: z865MC7JNhLtZuSq1NXQYVe+FgZJHBfeBCXOPYYRwH4liDCDrsd7zdOuR45mX257