Module notedealer::http_api

HTTP API responders for ActivityPub objects, plus some endpoints specific to this server (like a registration endpoint, users::register).

ActivityPub endpoints:

• POSTs to inboxes (/u/<user>/inbox.json): users::post_inbox
• POSTs to outboxes (/u/<user>/outbox.json): users::post_outbox
• GETs to any local ActivityPub id: get_ap_object

WebFinger endpoints:

• /.well-known/webfinger: webfinger::get

Other:

• Registration endpoint (POST to /u/<user>): users::register

This module also contains the Activity Streams Content-Type and Accept guards, and the media type itself, in activity_json.

Modules

activity_json

Types and helpers for using the Activity Streams 2.0 media type when sending and receiving ActivityPub objects over HTTP.

users

Actor-based endpoints, i.e. responders for all of the ActivityPub ids created by this server.

webfinger

Webfinger (RFC 7033) endpoint for discovering Actor objects by more human readable handles (“username@server.domain”).

Structs

ApRetrievalParams

Query parameters for queries fetching ActivityPub objects by their id.

CanonicalServerUrl

A string containing the base url for the running server. This is the url used in ActivityPub id’s created by this server.

Functions

activity_id

Returns a new ActivityPub id for activities created by the given actor.

actor_id

Returns the id of an actor named username on this server.

collection_page_id

Returns the ActivityPub id for a CollectionPage belonging to the given Collection, with the given page number.

get_ap_object

Http responder for GETs to ActivityPub ids.

note_id

Returns a new ActivityPub id for notes created by the given actor.