Commit 8258abd6 authored by Eugen Rochko's avatar Eugen Rochko

Add media API and split API docs in two menu items

parent f028cfde
Pipeline #303 passed with stages
in 17 seconds
......@@ -31,7 +31,12 @@ enableGitInfo = true
identifier = "development"
url = "/development/"
[[menu.docs]]
name = "API"
name = "API Overview"
weight = 4
identifier = "api"
url = "/api/"
[[menu.docs]]
name = "REST API"
weight = 5
identifier = "rest-api"
url = "/api/rest/"
---
title: Apps API
title: Apps
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Blocks API
title: Blocks
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Custom emoji API
title: Custom emoji
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Endorsements API
title: Endorsements
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Favourites API
title: Favourites
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Follow suggestions API
title: Follow suggestions
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Instances API
title: Instances
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Media attachments API
title: Media attachments
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
## POST /api/v1/media
Upload a media attachment that can be used with a new status.
Returns [Attachment]({{< relref "entities.md#attachment" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:media" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `file` | Media to be uploaded (encoded using `multipart/form-data`) | Required ||
| `description` | A plain-text description of the media for accessibility (max 420 chars) | Optional ||
| `focus` | Two floating points, comma-delimited. See [focal points](#focal-points) | Optional ||
## PUT /api/v1/media/:id
Update a media attachment. Can only be done before the media is attached to a status.
Returns [Attachment]({{< relref "entities.md#attachment" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="write write:media" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `description` | A plain-text description of the media for accessibility (max 420 chars) | Optional ||
| `focus` | Two floating points, comma-delimited. See [focal points](#focal-points) | Optional ||
## Focal points
Server-side preview images are never cropped, to support a variety of apps and user interfaces. Therefore, the cropping must be done by those apps. To crop intelligently, focal points can be used to ensure a certain section of the image is always within the cropped viewport. [See this for how to let users select focal point coordinates](https://github.com/jonom/jquery-focuspoint#1-calculate-your-images-focus-point).
---
title: Mutes API
title: Mutes
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Reports API
title: Reports
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Search API
title: Search
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
---
title: Timelines API
title: Timelines
menu:
docs:
parent: api
parent: rest-api
weight: 10
---
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment