diff --git a/docs/API/v1-routes/basic.mdx b/docs/API/v1-routes/basic.mdx
index 1866529..84b453d 100644
--- a/docs/API/v1-routes/basic.mdx
+++ b/docs/API/v1-routes/basic.mdx
@@ -17,6 +17,18 @@ Get a help message.
```json
Please refer to the wiki at https://wiki.jonasjones.dev/Api/
```
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -26,6 +38,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -40,6 +56,18 @@ Get a ping back from the API
```json
pong
```
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -49,6 +77,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -62,6 +94,18 @@ Get the version of the Rust api back-end
```json
["0.0.1+alpha-build01"]
```
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -71,6 +115,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -89,6 +137,18 @@ Get the incoming headers of the request
"...": "..."
}
```
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -98,6 +158,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
\ No newline at end of file
diff --git a/docs/API/v1-routes/k-comebacks-database.mdx b/docs/API/v1-routes/k-comebacks-database.mdx
index b19ca2f..df5eeca 100644
--- a/docs/API/v1-routes/k-comebacks-database.mdx
+++ b/docs/API/v1-routes/k-comebacks-database.mdx
@@ -30,6 +30,18 @@ Get the date and time of the last update made to the comeback database
```json
"2024-08-16 12:05:04 UTC"
```
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -39,6 +51,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -82,6 +98,39 @@ If the entry-count is fetched using [GET /v1/kcomebacks/filter/getinfo](#get-v1k
"count": 1
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -91,6 +140,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -142,6 +195,39 @@ Get all the comeback entries limited by limit
"count": 2
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -151,12 +237,16 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
## GET /v1/kcomebacks/filter/daterange
-→ /v1/kcomebacks/filter/daterange?start=*start*&end=*end*&limit=*offset*&limit=*limit*
+→ /v1/kcomebacks/filter/daterange?start=*start*&end=*end*&limit=*limit*&offset=*offset*
Get all comeback entries within a given timeframe
@@ -204,6 +294,39 @@ Get all comeback entries within a given timeframe
"count": 2
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -213,6 +336,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -245,6 +372,27 @@ Get the first (oldest) comeback entry
"count": 1
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -254,6 +402,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -286,6 +438,27 @@ Get the last (most recent) comeback entry
"count": 1
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -295,14 +468,18 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
## GET /v1/kcomebacks/filter/artist
-→ /v1/kcomebacks/filter/daterange?artist=*artist*&limit=*offset*&limit=*limit*
+→ /v1/kcomebacks/filter/artist?artist=*artist*&limit=*limit*&offset=*offset*
-Get all comeback entries where the provided artist string exists within an entrie's artist name
+Get all comeback entries where the provided artist string exists within an entry's artist name
| Parameter | Type | Description | Example | Required | Default Value (if optional) |
| --------- | ------------------- | ---------------------------------------------------- | ---------- | -------- | --------------------------- |
@@ -347,6 +524,39 @@ Get all comeback entries where the provided art
"count": 2
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -356,14 +566,18 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
## GET /v1/kcomebacks/filter/title
-→ /v1/kcomebacks/filter/title?title=*title*&limit=*offset*&limit=*limit*
+→ /v1/kcomebacks/filter/title?title=*title*&limit=*limit*&offset=*offset*
-Get all comeback entries where the provided title string exists within an entrie's song title
+Get all comeback entries where the provided title string exists within an entry's song title
| Parameter | Type | Description | Example | Required | Default Value (if optional) |
| --------- | ------------------- | --------------------------------------------------- | ---------- | -------- | --------------------------- |
@@ -408,6 +622,39 @@ Get all comeback entries where the provided tit
"count": 2
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -417,14 +664,18 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
## GET /v1/kcomebacks/filter/type
-→ /v1/kcomebacks/filter/type?type=*type*&limit=*offset*&limit=*limit*
+→ /v1/kcomebacks/filter/type?type=*type*&limit=*limit*&offset=*offset*
-Get all comeback entries where the provided type string equals to an entrie's type. All entry types can be fetched using [GET /v1/kcomebacks/filter/gettypes](#get-v1kcomebacksfiltergettypes)
+Get all comeback entries where the provided type string matches an entry's type. All entry types can be fetched using [GET /v1/kcomebacks/filter/gettypes](#get-v1kcomebacksfiltergettypes)
| Parameter | Type | Description | Example | Required | Default Value (if optional) |
| --------- | ------------------- | --------------------------------------------------- | ---------- | -------- | --------------------------- |
@@ -469,6 +720,39 @@ Get all comeback entries where the provided typ
"count": 2
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -478,6 +762,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -501,6 +789,22 @@ Get a list of the different types of all comeback entries
"total_results": 127
}
```
+| Parameter | Type | Description |
+| ------------- | -------- | --------------------------------------------------- |
+| results | [String] | List of all the different types of comeback entries |
+| total_results | Number | Amount of different types of comeback entries |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -510,6 +814,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -529,6 +837,24 @@ Get the entry-count,
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -538,6 +864,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -576,6 +906,27 @@ The timezone used for this query is `CEST UTC+02:00` while the timezone used for
"count": 1
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -585,6 +936,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -623,6 +978,27 @@ The timezone used for this query is `CEST UTC+02:00` while the timezone used for
"count": 1
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -632,6 +1008,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -670,6 +1050,27 @@ The timezone used for this query is `CEST UTC+02:00` while the timezone used for
"count": 1
}
```
+| Parameter | Type | Description |
+| --------- | ----------- | -------------------------------------------------------------------------- |
+| date | Date String | The date of the comeback in KST (UTC+09:00) |
+| time | Time String | The date of the comeback in KST (UTC+09:00) |
+| artist | String | The Artist name(s) |
+| title | String | The comeback name |
+| types | [String] | List of the types |
+| links | [String] | List of Links to Platforms like Spotify, Youtube and Reddit (if available) |
+| count | Number | Amount of matching comeback entries that were found |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -679,6 +1080,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
\ No newline at end of file
diff --git a/docs/API/v1-routes/minecraft-mod-update-checker.mdx b/docs/API/v1-routes/minecraft-mod-update-checker.mdx
index 4ecc4c4..7d6c093 100644
--- a/docs/API/v1-routes/minecraft-mod-update-checker.mdx
+++ b/docs/API/v1-routes/minecraft-mod-update-checker.mdx
@@ -31,6 +31,36 @@ A simple way for a mod to check if it is up to date
"telemetry_enabled": false
}
```
+| Parameter | Type | Description |
+| ----------------- | -------------- | ----------------------------------------------------------------------------- |
+| latest | Version Number | The version number of the latest version for the given Minecraft Version |
+| recommended | Version Number | The version number of the recommended version for the given Minecraft Version |
+| upToDate | Boolean | Wether the mod is up to date or not |
+| telemetry_enabled | Boolean | Wether telemetry is enabled or not |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -40,16 +70,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-
-
-:::danger[//TODO]
-
-- Projects Database only `last_update` is done. others have been copied from kcomebacks as tamplates but didnt replace the shit yet.
-
-- Missing Tabs for other error messages in ALL routes like BAD REQUEST and INTERNAL SERVER ERROR
-- Response variables types tables missing for ALL routes inside the individual resonse code tabs
-
-:::
\ No newline at end of file
diff --git a/docs/API/v1-routes/projects-database.mdx b/docs/API/v1-routes/projects-database.mdx
index a074bd0..b09b31c 100644
--- a/docs/API/v1-routes/projects-database.mdx
+++ b/docs/API/v1-routes/projects-database.mdx
@@ -6,7 +6,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Projects Database
-A database of all my public projects that are also visible on my [projects site](https://jonasjones.dev/projects)
+A database of all my public projects including some metadata that are also visible on my [projects site](https://jonasjones.dev/projects)
:::note
@@ -25,6 +25,18 @@ Get the date and time of the last update made to the projects database
```json
"2024-08-30 00:22:59 UTC"
```
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -34,6 +46,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -41,7 +57,7 @@ API is down
## GET /v1/projects/filter/getall
→ /v1/projects/filter/getall?limit=*limit*&offset=*offset*
-Get all the comeback entries limited by limit and offset
+Get all the project entries limited by limit and offset
| Parameter | Type | Description | Example | Required | Default Value (if optional) |
| --------- | ------------------- | ----------------------------------- | ------- | -------- | --------------------------- |
@@ -88,7 +104,7 @@ Get all the comeback entries limited by limit
"api",
"tools"
],
- "languages": {
+ "languages": {
"Rust": 73113
},
"gh_api": "JonasunderscoreJones/jonas_jones-api",
@@ -105,6 +121,45 @@ Get all the comeback entries limited by limit
"count": 2
}
```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -114,14 +169,18 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-## GET /v1/kcomebacks/filter/daterange
-→ /v1/kcomebacks/filter/daterange?start=*start*&end=*end*&limit=*offset*&limit=*limit*
+## GET /v1/projects/filter/lastupdaterange
+→ /v1/projects/filter/lastupdaterange?start=*start*&end=*end*&limit=*limit*&offset=*offset*
-Get all comeback entries within a given timeframe
+Get all projects that were last updated within a given timeframe
| Parameter | Type | Description | Example | Required | Default Value (if optional) |
| --------- | ------------------- | ----------------------------------- | ---------- | -------- | --------------------------- |
@@ -137,36 +196,95 @@ Get all comeback entries within a given timeframe
{
"results": [
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "Lim Heo Nil",
- "title": "Heart For Someone",
- "types": [
- "single",
- "digital"
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
],
- "links": [
- "https://play.spotify.com…m/7lIMFbUB5tV8vqJT0gH40W",
- "https://www.reddit.com/5wsn0p"
- ]
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
},
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "PENOMECO",
- "title": "FILM",
- "types": [
- "single"
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
],
- "links": [
- "https://play.spotify.com/album/2FwUxt5jYvcQc3ZgZRaeEL",
- "https://www.reddit.com/5wsn0p"
- ]
- },
+ "languages": {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
],
"count": 2
}
```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -176,100 +294,22 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-## GET /v1/kcomebacks/filter/first
+## GET /v1/projects/filter/title
+→ /v1/projects/filter/title?title=*title*&limit=*limit*&offset=*offset*
-Get the first (oldest) comeback entry
-
-:::tip[**Example** Response]
-
-
-```json
-{
- "results": [
- {
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "Lim Heo Nil",
- "title": "Heart For Someone",
- "types": [
- "single",
- "digital"
- ],
- "links": [
- "https://play.spotify.com…m/7lIMFbUB5tV8vqJT0gH40W",
- "https://www.reddit.com/5wsn0p"
- ]
- }
- ],
- "count": 1
-}
-```
-
-
-```json
-API is down
-{
- "status": 503,
- "statusText": "Service Unavailable"
-}
-```
-
-
-:::
-
-## GET /v1/kcomebacks/filter/last
-
-Get the last (most recent) comeback entry
-
-:::tip[**Example** Response]
-
-
-```json
-{
- "results": [
- {
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "Lim Heo Nil",
- "title": "Heart For Someone",
- "types": [
- "single",
- "digital"
- ],
- "links": [
- "https://play.spotify.com…m/7lIMFbUB5tV8vqJT0gH40W",
- "https://www.reddit.com/5wsn0p"
- ]
- }
- ],
- "count": 1
-}
-```
-
-
-```json
-API is down
-{
- "status": 503,
- "statusText": "Service Unavailable"
-}
-```
-
-
-:::
-
-## GET /v1/kcomebacks/filter/artist
-→ /v1/kcomebacks/filter/daterange?artist=*artist*&limit=*offset*&limit=*limit*
-
-Get all comeback entries where the provided artist string exists within an entrie's artist name
+Get all project entries where the provided title string exists within an entry's title
| Parameter | Type | Description | Example | Required | Default Value (if optional) |
| --------- | ------------------- | ---------------------------------------------------- | ---------- | -------- | --------------------------- |
-| artist | String | Partial or full artist name (letter case irrelevant) | "Ateez" | Yes | - |
+| title | String | Partial or full title (letter case irrelevant) | "API" | Yes | - |
| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
@@ -280,36 +320,95 @@ Get all comeback entries where the provided art
{
"results": [
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "Lim Heo Nil",
- "title": "Heart For Someone",
- "types": [
- "single",
- "digital"
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
],
- "links": [
- "https://play.spotify.com…m/7lIMFbUB5tV8vqJT0gH40W",
- "https://www.reddit.com/5wsn0p"
- ]
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
},
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "PENOMECO",
- "title": "FILM",
- "types": [
- "single"
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
],
- "links": [
- "https://play.spotify.com/album/2FwUxt5jYvcQc3ZgZRaeEL",
- "https://www.reddit.com/5wsn0p"
- ]
- },
+ "languages": {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
],
"count": 2
}
```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -319,20 +418,24 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-## GET /v1/kcomebacks/filter/title
-→ /v1/kcomebacks/filter/title?title=*title*&limit=*offset*&limit=*limit*
+## GET /v1/projects/filter/description
+→ /v1/projects/filter/description?description=*description*&limit=*limit*&offset=*offset*
-Get all comeback entries where the provided title string exists within an entrie's song title
+Get all project entries where the provided description string exists within an entry's description
-| Parameter | Type | Description | Example | Required | Default Value (if optional) |
-| --------- | ------------------- | --------------------------------------------------- | ---------- | -------- | --------------------------- |
-| title | String | Partial or full song title (letter case irrelevant) | "Sneakers" | Yes | - |
-| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
-| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
+| Parameter | Type | Description | Example | Required | Default Value (if optional) |
+| ----------- | ------------------- | ---------------------------------------------------- | ---------- | -------- | --------------------------- |
+| description | String | Partial or full description (letter case irrelevant) | "Sneakers" | Yes | - |
+| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
+| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
:::tip[**Example** Response]
@@ -341,36 +444,95 @@ Get all comeback entries where the provided tit
{
"results": [
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "Lim Heo Nil",
- "title": "Heart For Someone",
- "types": [
- "single",
- "digital"
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
],
- "links": [
- "https://play.spotify.com…m/7lIMFbUB5tV8vqJT0gH40W",
- "https://www.reddit.com/5wsn0p"
- ]
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
},
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "PENOMECO",
- "title": "FILM",
- "types": [
- "single"
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
],
- "links": [
- "https://play.spotify.com/album/2FwUxt5jYvcQc3ZgZRaeEL",
- "https://www.reddit.com/5wsn0p"
- ]
- },
+ "languages" {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
],
"count": 2
}
```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -380,20 +542,24 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-## GET /v1/kcomebacks/filter/type
-→ /v1/kcomebacks/filter/type?type=*type*&limit=*offset*&limit=*limit*
+## GET /v1/projects/filter/search
+→ /v1/projects/filter/search?search=*search*&limit=*limit*&offset=*offset*
-Get all comeback entries where the provided type string equals to an entrie's type. All entry types can be fetched using [GET /v1/v1/kcomebacks/filter/gettypes](#get-kcomebacksfiltergettypes)
+Get all project entries where the provided search string exists in a project entry's title or description.
-| Parameter | Type | Description | Example | Required | Default Value (if optional) |
-| --------- | ------------------- | --------------------------------------------------- | ---------- | -------- | --------------------------- |
-| type | String | Full comeback type (letter case **RELEVANT**) | "single" | Yes | - |
-| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
-| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
+| Parameter | Type | Description | Example | Required | Default Value (if optional) |
+| --------- | ------------------- | ------------------------------------------------------------ | ------- | -------- | --------------------------- |
+| search | String | partial or full name of description (letter case irrelevant) | "the" | Yes | - |
+| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
+| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
:::tip[**Example** Response]
@@ -402,36 +568,95 @@ Get all comeback entries where the provided typ
{
"results": [
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "Lim Heo Nil",
- "title": "Heart For Someone",
- "types": [
- "single",
- "digital"
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
],
- "links": [
- "https://play.spotify.com…m/7lIMFbUB5tV8vqJT0gH40W",
- "https://www.reddit.com/5wsn0p"
- ]
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
},
{
- "date": "2017-03-1",
- "time": "--:--",
- "artist": "PENOMECO",
- "title": "FILM",
- "types": [
- "single"
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
],
- "links": [
- "https://play.spotify.com/album/2FwUxt5jYvcQc3ZgZRaeEL",
- "https://www.reddit.com/5wsn0p"
- ]
- },
+ "languages" {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
],
"count": 2
}
```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -441,13 +666,24 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-## GET /v1/kcomebacks/filter/gettypes
+## GET /v1/projects/filter/status
+→ /v1/projects/filter/status?status=*status*&limit=*limit*&offset=*offset*
-Get a list of the different types of all comeback entries
+Get all project entries where the provided status string matches an entry's status. All entry statuses can be fetched using [GET /v1/projects/filter/getstatuses](#get-v1projectsfiltergetstatuses)
+
+| Parameter | Type | Description | Example | Required | Default Value (if optional) |
+| --------- | ------------------- | -------------------------------------------- | ------- | -------- | --------------------------- |
+| status | String | full project status (letter case irrelevant) | "alpha" | Yes | - |
+| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
+| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
:::tip[**Example** Response]
@@ -455,15 +691,519 @@ Get a list of the different types of all comeback entries
```json
{
"results": [
- "album",
- "signle",
- "digital",
- "japanese",
+ {
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
+ ],
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
+ },
+ {
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
+ ],
+ "languages" {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
+ ],
+ "count": 2
+}
+```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+API is down
+{
+ "status": 503,
+ "statusText": "Service Unavailable"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+:::
+
+## GET /v1/projects/filter/statuscolor
+→ /v1/projects/filter/statuscolor?statuscolor=*statuscolor*&limit=*limit*&offset=*offset*
+
+Get all project entries where the provided statuscolor string matches an entry's statuscolor. All entry statuscolors can be fetched using [GET /v1/projects/filter/getcolors](#get-v1projectsfiltergetcolors)
+
+| Parameter | Type | Description | Example | Required | Default Value (if optional) |
+| ----------- | ------------------- | ------------------------------------------------- | ------- | -------- | --------------------------- |
+| statuscolor | String | full project statuscolor (letter case irrelevant) | "green" | Yes | - |
+| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
+| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
+
+:::tip[**Example** Response]
+
+
+```json
+{
+ "results": [
+ {
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
+ ],
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
+ },
+ {
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
+ ],
+ "languages" {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
+ ],
+ "count": 2
+}
+```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+API is down
+{
+ "status": 503,
+ "statusText": "Service Unavailable"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+:::
+
+## GET /v1/projects/filter/category
+→ /v1/projects/filter/category?category=*category*&limit=*limit*&offset=*offset*
+
+Get all project entries where the provided category string matches an entry's category. All entry categories can be fetched using [GET /v1/projects/filter/getcategories](#get-v1projectsfiltergetcategories)
+
+| Parameter | Type | Description | Example | Required | Default Value (if optional) |
+| --------- | ------------------- | ------------------------------------------------ | -------- | -------- | --------------------------- |
+| category | String | full project category (letter case **RELEVANT**) | "webdev" | Yes | - |
+| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
+| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
+
+:::tip[**Example** Response]
+
+
+```json
+{
+ "results": [
+ {
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
+ ],
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
+ },
+ {
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
+ ],
+ "languages" {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
+ ],
+ "count": 2
+}
+```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+API is down
+{
+ "status": 503,
+ "statusText": "Service Unavailable"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+:::
+
+## GET /v1/projects/filter/language
+→ /v1/projects/filter/language?language=*language*&limit=*limit*&offset=*offset*
+
+Get all project entries where the provided language string matches an entry's language. All entry languages can be fetched using [GET /v1/projects/filter/getlangs](#get-v1projectsfiltergetlangs)
+
+| Parameter | Type | Description | Example | Required | Default Value (if optional) |
+| --------- | ------------------- | ------------------------------------------------ | ------- | -------- | --------------------------- |
+| language | String | full project language (letter case **RELEVANT**) | "Java" | Yes | - |
+| limit | Number (0 ≤ n ≤ 50) | maximum amount of entries to select | 2 | Yes | - |
+| offset | Number (*posirive*) | offset from *id* `0` | 5 | Yes | - |
+
+:::tip[**Example** Response]
+
+
+```json
+{
+ "results": [
+ {
+ "title": "Website",
+ "description": "My website at https://jonasjones.dev",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "webdev",
+ "website"
+ ],
+ "languages": {
+ "Svelte": 39242,
+ "CSS": 5297,
+ "JavaScript": 2652,
+ "TypeScript": 1272,
+ "HTML": 406
+ },
+ "gh_api": "JonasunderscoreJones/jonasjones.dev",
+ "version": "1.2.3",
+ "backgroud": "/homepage.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonasjones.dev"
+ },
+ "visible": true,
+ "last_update": 1723941271
+ },
+ {
+ "title": "Jonas_Jones API",
+ "description": "api used for my website",
+ "status": "release",
+ "statuscolor": "green",
+ "categories": [
+ "api",
+ "tools"
+ ],
+ "languages" {
+ "Rust": 73113
+ },
+ "gh_api": "JonasunderscoreJones/jonas_jones-api",
+ "version": "0.4.1",
+ "backgroud": "/jjapi.png",
+ "links": {
+ "GH": "https://github.com/JonasunderscoreJones/jonas_jones-api",
+ "WB": "https://api.jonasjones.dev/v1/help"
+ },
+ "visible": true,
+ "last_update": 1719693295
+ }
+ ],
+ "count": 2
+}
+```
+| Parameter | Type | Description |
+| ----------- | ------------------ | ---------------------------------------------------------------------------------------------------- |
+| title | String | The name of the project |
+| description | String | The description of the project |
+| status | String | The status of the project |
+| statuscolor | String | The color of the status |
+| categories | [String] | The categories of the project |
+| languages | [String: String] | The languages used in the project and the amount of code written in them |
+| gh_api | String | The GitHub repository of the project |
+| version | String | The version of the project |
+| backgroud | String | The background image of the project |
+| links | [String: String] | The links of the project. These include GH (Github), WB (Website), MR (Modrinth) and CF (Curseforge) |
+| visible | Boolean | Wether the project is visible on the projects site |
+| last_update | Unix Timestamp | The last time the project was updated |
+| count | Number | The amount of projects returned |
+
+
+```json
+{
+ "status": 400,
+ "statusText": "Bad Request"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+API is down
+{
+ "status": 503,
+ "statusText": "Service Unavailable"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+:::
+
+## GET /v1/projects/filter/getstatuses
+
+Get a list of the different statuses of all project entries
+
+:::tip[**Example** Response]
+
+
+```json
+{
+ "results": [
+ "alpha",
+ "beta",
+ "release",
"..."
],
"total_results": 127
}
```
+| Parameter | Type | Description |
+| ------------- | -------- | -------------------------------------- |
+| results | [String] | The different statuses of the projects |
+| total_results | Number | The amount of different statuses |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -473,25 +1213,48 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
-## GET /v1/kcomebacks/filter/getinfo
+## GET /v1/projects/filter/getcolors
-Get the entry-count, artist-count, start date and end date
+Get a list of the different status colors of all project entries
:::tip[**Example** Response]
```json
{
- "num_items": 143,
- "num_artists": 127,
- "start_date": "2017-3-1",
- "end_date": "2024-8-30"
+ "results": [
+ "red",
+ "orange",
+ "green",
+ "..."
+ ],
+ "total_results": 127
}
```
+| Parameter | Type | Description |
+| ------------- | -------- | ------------------------------------------- |
+| results | [String] | The different status colors of the projects |
+| total_results | Number | The amount of different status colors |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -501,6 +1264,112 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
-:::
\ No newline at end of file
+:::
+
+## GET /v1/projects/filter/getcategories
+
+Get a list of the different categories of all project entries
+
+:::tip[**Example** Response]
+
+
+```json
+{
+ "results": [
+ "tool",
+ "mcmodding",
+ "minecraft",
+ "..."
+ ],
+ "total_results": 127
+}
+```
+| Parameter | Type | Description |
+| ------------- | -------- | ---------------------------------------- |
+| results | [String] | The different categories of the projects |
+| total_results | Number | The amount of different categories |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+API is down
+{
+ "status": 503,
+ "statusText": "Service Unavailable"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+:::
+
+## GET /v1/projects/filter/getlangs
+
+Get a list of the different languages of all project entries
+
+:::tip[**Example** Response]
+
+
+```json
+{
+ "results": [
+ "Svelte",
+ "Java",
+ "CSS",
+ "..."
+ ],
+ "total_results": 127
+}
+```
+| Parameter | Type | Description |
+| ------------- | -------- | --------------------------------------- |
+| results | [String] | The different languages of the projects |
+| total_results | Number | The amount of different languages |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+```json
+API is down
+{
+ "status": 503,
+ "statusText": "Service Unavailable"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
+
+
+:::
diff --git a/docs/API/v1-routes/run-scipts.mdx b/docs/API/v1-routes/run-scipts.mdx
index 971593c..5dfb767 100644
--- a/docs/API/v1-routes/run-scipts.mdx
+++ b/docs/API/v1-routes/run-scipts.mdx
@@ -26,6 +26,21 @@ Run the [rpopfetch.py Script](https://github.com/JonasunderscoreJones/turbo-octo
"status": "udating..."
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | -------------------------------- |
+| status | String | The status message of the script |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -35,6 +50,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -51,6 +70,21 @@ Run the [update_projects.py Script](https://github.com/JonasunderscoreJones/turb
"status": "udating..."
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | -------------------------------- |
+| status | String | The status message of the script |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -60,6 +94,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
@@ -76,6 +114,21 @@ Run the [likedsongsync2.py Script](https://github.com/JonasunderscoreJones/turbo
"status": "udating..."
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | -------------------------------- |
+| status | String | The status message of the script |
+
+
+```json
+{
+ "status": 500,
+ "statusText": "Internal Server Error"
+}
+```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
```json
@@ -85,6 +138,10 @@ API is down
"statusText": "Service Unavailable"
}
```
+| Parameter | Type | Description |
+| ---------- | ------ | ---------------------------- |
+| status | Number | The status code of the error |
+| statusText | String | The status text of the error |
:::
\ No newline at end of file