API revision 1

- added missing methods to projects
- fixed other pages typos/missing features/etc.
- added return types table
This commit is contained in:
J-onasJones 2024-08-31 18:25:57 +02:00
parent b512bd20ad
commit 4c0fe127b5
5 changed files with 1645 additions and 226 deletions

View file

@ -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 |
</TabItem>
<TabItem value="500" label="500">
```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 |
</TabItem>
<TabItem value="503" label="503">
```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 |
</TabItem>
</Tabs>
:::
@ -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 |
</TabItem>
<TabItem value="500" label="500">
```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 |
</TabItem>
<TabItem value="503" label="503">
```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 |
</TabItem>
</Tabs>
:::
@ -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 |
</TabItem>
<TabItem value="500" label="500">
```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 |
</TabItem>
<TabItem value="503" label="503">
```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 |
</TabItem>
</Tabs>
:::