Documentation Powered by ReDoc

Django Activity Streams API (1.0.0)

Download OpenAPI specification:Download

Your project description

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

cookieAuth

Security Scheme Type API Key
Cookie parameter name: sessionid

actions

actions_list

Authorizations:
cookieAuthbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

actions_retrieve

Authorizations:
cookieAuthbasicAuth
path Parameters
id
required
integer

A unique integer value identifying this action.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "verb": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "actor": "string",
  • "target": "string",
  • "action_object": "string"
}

actions_me_retrieve

Returns the actor_stream for the current user

Authorizations:
cookieAuthbasicAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "verb": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "actor": "string",
  • "target": "string",
  • "action_object": "string"
}

actions_model_retrieve

Returns all actions for a given content type. See model_stream

Authorizations:
cookieAuthbasicAuth
path Parameters
content_type_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "verb": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "actor": "string",
  • "target": "string",
  • "action_object": "string"
}

actions_object_retrieve

Returns all actions for a given object. See any_stream

Authorizations:
cookieAuthbasicAuth
path Parameters
content_type_id
required
string
object_id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "verb": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "actor": "string",
  • "target": "string",
  • "action_object": "string"
}

actions_send_create

Sends the action signal on POST Must have a verb and optional target/action_object with content_type_id/object_id pairs Actor is set as current logged in user

Authorizations:
cookieAuthbasicAuth
Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data
verb
required
string <= 255 characters
description
string or null
timestamp
string <date-time>
actor
required
string
target
required
string
action_object
required
string

Responses

Request samples

Content type
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data
{
  • "verb": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "actor": "string",
  • "target": "string",
  • "action_object": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "verb": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "actor": "string",
  • "target": "string",
  • "action_object": "string"
}

follows

follows_list

Authorizations:
cookieAuthbasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

follows_retrieve

Authorizations:
cookieAuthbasicAuth
path Parameters
id
required
integer

A unique integer value identifying this follow.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "flag": "string",
  • "user": "string",
  • "follow_object": "string",
  • "started": "2019-08-24T14:15:22Z",
  • "actor_only": true
}

follows_follow_create

Creates the follow relationship. The current user is set as user and the target is passed with content_type_id/object_id pair

Authorizations:
cookieAuthbasicAuth
Request Body schema:
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data
flag
string <= 255 characters
user
required
string
follow_object
required
string
started
string <date-time>
actor_only
boolean (Only follow actions where the object is the target.)

Responses

Request samples

Content type
application/json
application/json
application/x-www-form-urlencoded
multipart/form-data
{
  • "flag": "string",
  • "user": "string",
  • "follow_object": "string",
  • "started": "2019-08-24T14:15:22Z",
  • "actor_only": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "flag": "string",
  • "user": "string",
  • "follow_object": "string",
  • "started": "2019-08-24T14:15:22Z",
  • "actor_only": true
}