tubearchivist/docs
1
0
Fork 0
mirror of https://github.com/tubearchivist/docs.git synced 2025-04-05 03:30:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

move content type header to intro

Browse Source
This commit is contained in:
Simon 2024-10-21 21:38:55 +07:00
parent 1e97457ad6
commit 29df8c2a68
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mkdocs/docs/api/download.md
View File

@ -21,8 +21,6 @@ Parameter:
- autostart: true
This value must be posted with the header `"Content-Type: application/json"`
Delete download queue items by filter:
**DELETE** `/api/download/?filter=ignore`
**DELETE** `/api/download/?filter=pending`

3
mkdocs/docs/api/introduction.md
View File

@ -11,6 +11,9 @@ This page has a generic overview with how the Tube Archivist API functions. This
!!! note
Not all endpoints will return expected status codes for errors, e.g. sometimes you'll see an error **500 Server Error** even though it should be **400 Bad request**. If you encounter any such cases, [please fix them](https://github.com/tubearchivist/tubearchivist/blob/master/CONTRIBUTING.md#how-to-make-a-pull-request) as you find them, no need to clutter up the issue queue.
!!! note
If you are sending POST requests to the API, you'll have to specify the content type as json like so: `"Content-Type: application/json"`.
## Context
- All changes to the API are marked with a `[API]` keyword for easy searching, for example search for [commits](https://github.com/tubearchivist/tubearchivist/search?o=desc&q=%5Bapi%5D&s=committer-date&type=commits). You'll find the same in the [release notes](https://github.com/tubearchivist/tubearchivist/releases).
- Check the commit history and release notes to see if a documented feature is already in your release. The documentation might be ahead of the regular release schedule.