From 7c9a375393812e9b49865d50164195921f045ec5 Mon Sep 17 00:00:00 2001 From: spiral Date: Sat, 30 Oct 2021 18:50:19 -0400 Subject: [PATCH] feat: temporarily add warning message about pre-release apiv2 docs --- docs/content/api/legacy.md | 4 ++-- docs/content/api/reference.md | 6 +++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/content/api/legacy.md b/docs/content/api/legacy.md index 46b4f2f2..dc2f1dbe 100644 --- a/docs/content/api/legacy.md +++ b/docs/content/api/legacy.md @@ -4,10 +4,10 @@ permalink: /api/legacy --- # Legacy API documentation - + ## Models The following three models (usually represented in JSON format) represent the various objects in PluralKit's API. diff --git a/docs/content/api/reference.md b/docs/content/api/reference.md index 6001780e..055241f8 100644 --- a/docs/content/api/reference.md +++ b/docs/content/api/reference.md @@ -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