docs: deprecate v1 api

CodeMyst · Apr 28, 2024 · 5574a8b · 5574a8b
1 parent 2607492
commit 5574a8b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 18 deletions.
diff --git a/public/docs/index.md b/public/docs/index.md
@@ -2,7 +2,7 @@
 
 the base endpoint for the api is `https://paste.myst.rs/api/v2`.
 
-the old v1 api is still available and works at `https://paste.myst.rs/api/` so that means that old applications don't need to change anything to use the api but we strongly suggest you upgrade to the v2 api as the old one might stop working. you can view the docs to the v1 api here: [[v1 api docs]](/api-docs/v1)
+the old v1 api is now **deprecated**, but it is still available at `https://paste.myst.rs/api/`. please move on to the v2 api as soon as possible, as it will be removed at some point. you can view the docs to the v1 api here: [[v1 api docs]](/api-docs/v1)
 
 you don't need any api keys to access the api, unless you need to access pastes or features that require an account. the api is rate limited to 5 requests per second, after exceeding the rate limit your requests will get a `429 (too many requests)` response code. if you need to do more requests than that contact me.
 
@@ -28,21 +28,20 @@ and all of the objects that are needed for api requests: [objects](/api-docs/obj
 
 here are some api libraries that are developed by other people. they are not directly supported by me. big thanks to the developers! if you want your library added here just open an issue.
 
-| link                                                                | language   | author          | supports v2 |
+| link                                                                | language   | author          | api version |
 |---------------------------------------------------------------------|------------|-----------------|-------------|
-| [pastemyst.java](https://github.com/YeffyCodeGit/pastemyst.java)    | java       | Yeff            | yes         |
-| [pastemyst-cpp](https://github.com/billyeatcookies/pastemyst-cpp)   | c++        | billyeatcookies | yes         |
-| [MystPaste.NET](https://github.com/shift-eleven/MystPaste.NET)      | c#         | shift-eleven    | yes         |
-| [pastemystgo](https://github.com/WaifuShork/pastemystgo)            | go         | WaifuShork      | yes         |
-| [pastemyst.v](https://github.com/billyateallcookies/pastemyst.v)    | v          | billyeatcookies | yes         |
-| [pastemyst-ts](https://github.com/YilianSource/pastemyst-ts)        | ts         | YilianSource    | yes         |
-| [pastemyst-rs](https://github.com/ANF/pastemyst-rs)                 | rust       | ANF-Studios     | yes         |
-| [pastemyst.js](https://github.com/harshhhdev/pastemyst.js)          | js/ts      | harshhhdev      | yes         |
-| [pastemyst-d](https://github.com/CodeMyst/pastemyst-d)              | d          | codemyst        | yes         |
-| [pastemyst-py](https://github.com/Dmunch04/pastemyst-py)            | python     | munchii         | yes         |
-| [PasteMystNet](https://github.com/dentolos19/PasteMystNet)          | c#         | dentolos19      | yes         |
-| [PasteMyst.jl](https://github.com/lines-of-codes/PasteMyst.jl)      | Julia      | lines-of-codes  | yes         |
-| [PasteMyst-JS](https://github.com/FleshMobProductions/PasteMyst-JS) | js         | fmproductions   | no          |
-
-
-you should avoid using a library not supporting the v2 api, since it might break and is lacking a lot of features.
+| [pastemyst.java](https://github.com/YeffyCodeGit/pastemyst.java)    | java       | Yeff            | v2          |
+| [pastemyst-cpp](https://github.com/billyeatcookies/pastemyst-cpp)   | c++        | billyeatcookies | v2          |
+| [MystPaste.NET](https://github.com/shift-eleven/MystPaste.NET)      | c#         | shift-eleven    | v2          |
+| [pastemystgo](https://github.com/WaifuShork/pastemystgo)            | go         | WaifuShork      | v2          |
+| [pastemyst.v](https://github.com/billyateallcookies/pastemyst.v)    | v          | billyeatcookies | v2          |
+| [pastemyst-ts](https://github.com/YilianSource/pastemyst-ts)        | ts         | YilianSource    | v2          |
+| [pastemyst-rs](https://github.com/ANF/pastemyst-rs)                 | rust       | ANF-Studios     | v2          |
+| [pastemyst.js](https://github.com/harshhhdev/pastemyst.js)          | js/ts      | harshhhdev      | v2          |
+| [pastemyst-d](https://github.com/CodeMyst/pastemyst-d)              | d          | codemyst        | v2          |
+| [pastemyst-py](https://github.com/Dmunch04/pastemyst-py)            | python     | munchii         | v2          |
+| [PasteMystNet](https://github.com/dentolos19/PasteMystNet)          | c#         | dentolos19      | v2          |
+| [PasteMyst.jl](https://github.com/lines-of-codes/PasteMyst.jl)      | Julia      | lines-of-codes  | v2          |
+| [PasteMyst-JS](https://github.com/FleshMobProductions/PasteMyst-JS) | js         | fmproductions   | v1          |
+
+avoid using the v1 api as it's now deprecated and will be removed in a future version of pastemyst.
diff --git a/public/docs/v1.md b/public/docs/v1.md
@@ -1,5 +1,9 @@
 ## v1 api docs
 
+### deprecation notice
+
+the v1 api is now deprecated, and will be removed in a future version of pastemyst. please upgrade to the v2 api as soon as possible.
+
 ### get a paste
 
 <p class="method">GET</p> <code>/paste?id=<span class="var">{id}</span></code>