readded depreacted fields

lavalink-devs · Dec 2, 2023 · cceae99 · cceae99
1 parent f8a5261
commit cceae99
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 27 deletions.
diff --git a/docs/api/plugins.md b/docs/api/plugins.md
@@ -4,8 +4,9 @@ description: Make your own plugin for Lavalink.
 
 # Make your own plugin
 
-> **Note:**  
-> If your plugin is developed in Kotlin make sure you are using **Kotlin v1.8.22**
+!!! info
+
+    If your plugin is developed in Kotlin make sure you are using **Kotlin v1.8.22**
 
 Follow [these steps](https://github.com/lavalink-devs/lavalink-plugin-template#how-to-use-this-template) to set up a new Lavalink plugin
 

diff --git a/docs/api/rest.md b/docs/api/rest.md
@@ -90,7 +90,7 @@ When Lavalink encounters an error, it will respond with a JSON object containing
 This endpoint is used to resolve audio tracks for use with the [Update Player](#update-player) endpoint.
 
 
-!!! note
+!!! tip
 
     Lavalink supports searching via YouTube, YouTube Music, and Soundcloud. To search, you must prefix your identifier with `ytsearch:`, `ytmsearch:` or `scsearch:` respectively.
 
@@ -682,8 +682,9 @@ Updates or creates the player for this guild if it doesn't already exist.
 PATCH /v4/sessions/{sessionId}/players/{guildId}?noReplace=true
 ```
 
-> **Note**
-> - `sessionId` in the path should be the value from the [ready op](websocket.md#ready-op).
+!!! info
+
+    `sessionId` in the path should be the value from the [ready op](websocket.md#ready-op).
 
 Query Params:
 
@@ -693,26 +694,33 @@ Query Params:
 
 Request:
 
-| Field         | Type                                        | Description                                                                                   |
-|---------------|---------------------------------------------|-----------------------------------------------------------------------------------------------|
-| track?        | [Update Player Track](#update-player-track) | Specification for a new track to load, as well as user data to set                       |
-| position?     | int                                         | The track position in milliseconds                                                            |
-| endTime?      | ?int                                        | The track end time in milliseconds (must be > 0). `null` resets this if it was set previously |
-| volume?       | int                                         | The player volume, in percentage, from 0 to 1000                                              |
-| paused?       | bool                                        | Whether the player is paused                                                                  |
-| filters?      | [Filters](#filters) object                  | The new filters to apply. This will override all previously applied filters                   |                   
-| voice?        | [Voice State](#voice-state) object          | Information required for connecting to Discord                                                |
+| Field              | Type                                        | Description                                                                                   |
+|--------------------|---------------------------------------------|-----------------------------------------------------------------------------------------------|
+| track?             | [Update Player Track](#update-player-track) | Specification for a new track to load, as well as user data to set                            |
+| ~~encodedTrack?~~* | ?string                                     | The base64 encoded track to play. `null` stops the current track                              |
+| ~~identifier?~~*   | string                                      | The identifier of the track to play                                                           |
+| *position*?        | int                                         | The track position in milliseconds                                                            |
+| endTime?           | ?int                                        | The track end time in milliseconds (must be > 0). `null` resets this if it was set previously |
+| volume?            | int                                         | The player volume, in percentage, from 0 to 1000                                              |
+| paused?            | bool                                        | Whether the player is paused                                                                  |
+| filters?           | [Filters](#filters) object                  | The new filters to apply. This will override all previously applied filters                   |                   
+| voice?             | [Voice State](#voice-state) object          | Information required for connecting to Discord                                                |
+
+!!! info
+
+    \* `encoded` and `identifier` are mutually exclusive and `DEPRECATED`. Use `track` instead.
 
 #### Update Player Track
 
-| Field         | Type    | Description                                                         |
-|---------------|---------|---------------------------------------------------------------------|
-| encoded? *    | ?string | The base64 encoded track to play. `null` stops the current track    |
-| identifier? * | string  | The identifier of the track to play                                 |
-| userData?     | object  | Additional track data to be sent back in the [Track Object](#track) |
+| Field        | Type    | Description                                                         |
+|--------------|---------|---------------------------------------------------------------------|
+| encoded?*    | ?string | The base64 encoded track to play. `null` stops the current track    |
+| identifier?* | string  | The identifier of the track to play                                 |
+| userData?    | object  | Additional track data to be sent back in the [Track Object](#track) |
+
+!!! info
 
-> **Note**
-> - \* `encoded` and `identifier` are mutually exclusive.
+    \* `encoded` and `identifier` are mutually exclusive.
 
 When `identifier` is used, Lavalink will try to resolve the identifier as a single track. An HTTP `400` error is returned when resolving a playlist, search result, or no tracks.
 

diff --git a/docs/changelog/v3.md b/docs/changelog/v3.md
@@ -24,8 +24,9 @@
 * Fix errors when doing multiple session resumes
 * Update lavaplayer to `1.4.0` see [here](https://github.com/Walkyst/lavaplayer-fork/releases/tag/1.4.0) for more info
 
-> **Note**
-> Lavalink Docker images are now found in the GitHub Container Registry instead of DockerHub
+!!! info
+
+  Lavalink Docker images are now found in the GitHub Container Registry instead of DockerHub
 
 ## v3.7.4
 

diff --git a/docs/changelog/v4.md b/docs/changelog/v4.md
@@ -30,10 +30,11 @@
 * Update to the [Protocol Module](https://github.com/lavalink-devs/Lavalink/tree/master/protocol) to support Kotlin/JS
 * Removal of all `/v3` endpoints except `/version`. All other endpoints are now under `/v4`
 
-> **Warning**
-> This is a beta release, and as such, may contain bugs. Please report any bugs you find to the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new/choose).
-> For more info on the changes in this release, see [here](../api/index.md#v370---v400)
-> If you have any question regarding the changes in this release, please ask in the [support server]({{ discord_help }}) or [GitHub discussions](https://github.com/lavalink-devs/Lavalink/discussions/categories/q-a)
+!!! warning
+
+    This is a beta release, and as such, may contain bugs. Please report any bugs you find to the [issue tracker](https://github.com/lavalink-devs/Lavalink/issues/new/choose).
+    For more info on the changes in this release, see [here](../api/index.md#v370---v400)
+    If you have any question regarding the changes in this release, please ask in the [support server]({{ discord_help }}) or [GitHub discussions](https://github.com/lavalink-devs/Lavalink/discussions/categories/q-a)
 
 Contributors:
 [@topi314](https://github.com/topi314), [@freyacodes](https://github.com/freyacodes), [@DRSchlaubi](https://github.com/DRSchlaubi) and [@melike2d](https://github.com/melike2d)

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -96,6 +96,9 @@ markdown_extensions:
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.highlight
+  - pymdownx.caret
+  - pymdownx.mark
+  - pymdownx.tilde
   - footnotes
   - def_list
   - attr_list