Sv443 4 месяцев назад
Родитель
Сommit
5f00b8ffa3

+ 8 - 0
www/.vuepress/configs/navbar/en.ts

@@ -11,6 +11,14 @@ export const navbarEn: NavbarOptions = [
       },
     ],
   },
+  {
+    text: "GitHub",
+    link: "https://github.com/Sv443/geniURL",
+  },
+  {
+    text: "Discord",
+    link: "https://dc.sv443.net",
+  },
   /*{
     text: 'Routes',
     children: [

+ 11 - 2
www/docs/routes/README.md

@@ -1,11 +1,20 @@
 ---
 lang: en-US
-title: General info
+title: Info
 description: General information about all routes that are offered by geniURL's REST service
 ---
 
-# General info
+## General info
 All routes support gzip, deflate and brotli compression.  
   
 Also all routes always return the properties `error` and `matches`.  
 They can be used to determine whether a response has succeeded (error = false, matches > 0), is errored (error = true, matches = null) or just didn't yield any results (error = true, matches = 0).  
+
+<br>
+
+## Available routes
+These are the available routes:
+- [GET `/search`](./search#get-search) - Search for lyrics (multiple results)
+  - [GET `/search/top`](./search#get-search-top) - Search for lyrics (only the top result)
+- [GET `/translations/:songId`](./translations) - Fetch lyrics translations
+- [GET `/album/:songId`](./album) - Fetch associated album

+ 2 - 2
www/docs/routes/album.md

@@ -7,7 +7,7 @@ description: Description of all routes related to searching for a related album
 ## GET `/album/:songId`
 
 This route returns any associated album for a specified song.  
-Get the song ID from one of the [search routes.](#routes)  
+Get the song ID from one of the [search routes.](./search)  
 Example: `/album/1644`
 
 <br>
@@ -23,7 +23,7 @@ The structure of the XML data is similar to the shown JSON data.
 
 <details><summary><b>Successful response (click to view)</b></summary>
 
-```jsonc
+```json
 {
     "error": false,
     "matches": 1,

+ 2 - 2
www/docs/routes/search.md

@@ -37,7 +37,7 @@ The structure of the XML data is similar to the shown JSON data.
 
 <details><summary><b>Successful response (click to view)</b></summary>
 
-```jsonc
+```json
 {
     "error": false,
     "matches": 10,
@@ -145,7 +145,7 @@ The structure of the XML data is similar to the shown JSON data.
 
 <details><summary><b>Successful response (click to view)</b></summary>
 
-```jsonc
+```json
 {
     "error": false,
     "matches": 1,

+ 2 - 2
www/docs/routes/translations.md

@@ -7,7 +7,7 @@ description: Description of all routes related to searching for lyrics translati
 ## GET `/translations/:songId`
 
 This route returns all translations of a certain song.  
-Get the song ID from one of the [search routes.](#routes)  
+Get the song ID from one of the [search routes.](./search)  
 Example: `/translations/1644`
 
 <br>
@@ -23,7 +23,7 @@ The structure of the XML data is similar to the shown JSON data.
 
 <details><summary><b>Successful response (click to view)</b></summary>
 
-```jsonc
+```json
 {
     "error": false,
     "matches": 1,