Initial commit
This commit is contained in:
Diogo Cordeiro
commit
7696c8db31
|
|
@ -0,0 +1,107 @@
|
|||
ActivityPub Plugin for GNU Social Doc
|
||||
=====================================
|
||||
|
||||
## Contents
|
||||
|
||||
- [Methods](#methods)
|
||||
- [Profiles](#profiles)
|
||||
- [Liked Collection](#liked-collection)
|
||||
- [Entities](#entities)
|
||||
- [Profile](#profile)
|
||||
- [Notice](#notice)
|
||||
- [Image](#image)
|
||||
|
||||
###### Selecting ranges
|
||||
|
||||
For most `GET` operations that return arrays, the query parameters `max_id` and `since_id` can be used to specify the range of IDs to return.
|
||||
API methods that return collections of items can return a `Link` header containing URLs for the `next` and `prev` pages.
|
||||
See the [Link header RFC](https://tools.ietf.org/html/rfc5988) for more information.
|
||||
|
||||
###### Errors
|
||||
|
||||
If the request you make doesn't go through, the plugin will usually respond with an [Error](#error).
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### Profiles
|
||||
|
||||
#### Fetching an Actor's profile:
|
||||
|
||||
GET :username/profile.json
|
||||
|
||||
Query parameters:
|
||||
|
||||
| Field | Description | Optional |
|
||||
| ---------- | -------------------------------------------------------------- | ---------- |
|
||||
| `pretty` | If set it generates a formated output | yes |
|
||||
|
||||
Returns a [Profile](#profile).
|
||||
|
||||
|
||||
#### Getting an Actor's Liked Collection:
|
||||
|
||||
GET :username/liked.json
|
||||
|
||||
Query parameters:
|
||||
|
||||
| Field | Description | Optional |
|
||||
| ---------- | -------------------------------------------------------------- | ---------- |
|
||||
| `pretty` | If set it generates a formated output | yes |
|
||||
| `since` | Starts from nth entry | yes |
|
||||
| `limit` | Maximum number of followers to get (Default 40, Max 80) | yes |
|
||||
|
||||
Returns an array of [Notices](#notice).
|
||||
|
||||
|
||||
## Entities
|
||||
|
||||
> **Note:** Some attributes in the entity payload can have ``null`` value and are marked as _nullable_ on the tables below. Attributes that are not nullable are guaranteed to return a valid value.
|
||||
|
||||
### Profile
|
||||
|
||||
| Attribute | Description | Nullable |
|
||||
| ------------------------ | ---------------------------------------------------------------------------------- | -------- |
|
||||
| `@context` | Standard compliance | no |
|
||||
| `id` | The ID of the Actor | no |
|
||||
| `type` | Person | no |
|
||||
| `nickname` | The username of the account | no |
|
||||
| `inbox` | URL to Actor's inbox endpoint | no |
|
||||
| `outbox` | URL to Actor's outbox endpoint | no |
|
||||
| `acct` | Equals `username` for local users, includes `@domain` for remote ones | no |
|
||||
| `display_name` | The Actor's display name | no |
|
||||
| `followers` | URL to Actor's followers endpoint | no |
|
||||
| `followers` | URL to Actor's following endpoint | no |
|
||||
| `liked` | URL to Actor's Liked collection endpoint | no |
|
||||
| `summary` | Actor's biography | no |
|
||||
| `url` | URL of the Actor's profile page (can be remote) | no |
|
||||
| `avatar` | [Image](#image) object with the Actor's avatar | no |
|
||||
|
||||
### Notice
|
||||
|
||||
| Attribute | Description | Nullable |
|
||||
| ------------------------ | -------------------------------------------- | -------- |
|
||||
| `id` | Notice's id | no |
|
||||
| `actor_id` | Notice owner's id | no |
|
||||
| `uri` | Notice's URI | no |
|
||||
| `content` | Notice's Content in plain text | no |
|
||||
| `rendered` | Notice's Content in HTML | no |
|
||||
| `url` | Notice's URL | no |
|
||||
| `created` | DateTime of notice creation | no |
|
||||
| `reply_to` | ID of the notice this replies | yes |
|
||||
| `is_local` | Equals 1 for local notices, 0 otherwise | no |
|
||||
| `source` | Not sure of what it is | no |
|
||||
| `conversation` | Homepage URL of the app | no |
|
||||
| `repeat_of` | Not sure of what it is | yes |
|
||||
| `verb` | Standard compliance | no |
|
||||
| `object_type` | Standard compliance | no |
|
||||
|
||||
### Image
|
||||
|
||||
| Attribute | Description | Nullable |
|
||||
| ------------------------ | ----------------------- | -------- |
|
||||
| `type` | Image | no |
|
||||
| `width` | Image's width | no |
|
||||
| `height` | Image's height | no |
|
||||
| `url` | Image URL | no |
|
||||
Reference in New Issue