This commit is contained in:
+6
-6
@@ -30,7 +30,7 @@ All endpoints are under `/api/v1`.
|
|||||||
### Sources
|
### Sources
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
|--------|------|-------------|
|
| ------ | --------------------------------------------------- | ------------------------------------ |
|
||||||
| GET | `/api/v1/sources` | List all sources |
|
| GET | `/api/v1/sources` | List all sources |
|
||||||
| GET | `/api/v1/sources/:id` | Get a source with its pending tasks |
|
| GET | `/api/v1/sources/:id` | Get a source with its pending tasks |
|
||||||
| POST | `/api/v1/sources` | Create a new source |
|
| POST | `/api/v1/sources` | Create a new source |
|
||||||
@@ -45,7 +45,7 @@ All endpoints are under `/api/v1`.
|
|||||||
### Media Items
|
### Media Items
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
|--------|------|-------------|
|
| ------ | --------------------------------------------- | ----------------------------------------------------- |
|
||||||
| GET | `/api/v1/media` | List all media items (optional `?source_id=X` filter) |
|
| GET | `/api/v1/media` | List all media items (optional `?source_id=X` filter) |
|
||||||
| GET | `/api/v1/media/search?q=query` | Search media items |
|
| GET | `/api/v1/media/search?q=query` | Search media items |
|
||||||
| GET | `/api/v1/media/:id` | Get a media item |
|
| GET | `/api/v1/media/:id` | Get a media item |
|
||||||
@@ -56,7 +56,7 @@ All endpoints are under `/api/v1`.
|
|||||||
### Media Profiles
|
### Media Profiles
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
|--------|------|-------------|
|
| ------ | ---------------------------- | ----------------------- |
|
||||||
| GET | `/api/v1/media_profiles` | List all media profiles |
|
| GET | `/api/v1/media_profiles` | List all media profiles |
|
||||||
| GET | `/api/v1/media_profiles/:id` | Get a media profile |
|
| GET | `/api/v1/media_profiles/:id` | Get a media profile |
|
||||||
| POST | `/api/v1/media_profiles` | Create a media profile |
|
| POST | `/api/v1/media_profiles` | Create a media profile |
|
||||||
@@ -66,7 +66,7 @@ All endpoints are under `/api/v1`.
|
|||||||
### Settings
|
### Settings
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
|--------|------|-------------|
|
| ------ | ------------------ | ----------------------------------------- |
|
||||||
| GET | `/api/v1/settings` | Get settings (route_token excluded) |
|
| GET | `/api/v1/settings` | Get settings (route_token excluded) |
|
||||||
| PUT | `/api/v1/settings` | Update settings |
|
| PUT | `/api/v1/settings` | Update settings |
|
||||||
| GET | `/api/v1/app_info` | Get app info (version, environment, etc.) |
|
| GET | `/api/v1/app_info` | Get app info (version, environment, etc.) |
|
||||||
@@ -74,7 +74,7 @@ All endpoints are under `/api/v1`.
|
|||||||
### Tasks
|
### Tasks
|
||||||
|
|
||||||
| Method | Path | Description |
|
| Method | Path | Description |
|
||||||
|--------|------|-------------|
|
| ------ | ------------------- | ----------------------------------------------- |
|
||||||
| GET | `/api/v1/tasks` | List all tasks (optional `?source_id=X` filter) |
|
| GET | `/api/v1/tasks` | List all tasks (optional `?source_id=X` filter) |
|
||||||
| GET | `/api/v1/tasks/:id` | Get a task |
|
| GET | `/api/v1/tasks/:id` | Get a task |
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ All responses are JSON. Successful responses use:
|
|||||||
Error responses use:
|
Error responses use:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{"errors": {"field": "error message"}}
|
{ "errors": { "field": "error message" } }
|
||||||
```
|
```
|
||||||
|
|
||||||
## Example: Create a Source
|
## Example: Create a Source
|
||||||
|
|||||||
Reference in New Issue
Block a user