API docs by Redocly

Content Publishing Service API (1.0)

Download OpenAPI specification:Download

Content Publishing Service API

v1/asset

Upload asset files

Request Body schema: multipart/form-data
required

Asset files

files
required
Array of strings <binary> [ items <binary > ]

Responses

Response samples

Content type
application/json
{
  • "assetIds": [
    ]
}

v1/content

Create DSNP Broadcast for user

path Parameters
userDsnpId
required
string
Request Body schema: application/json
required
required
object (NoteActivityDto)

Responses

Request samples

Content type
application/json
{
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Create DSNP Reply for user

path Parameters
userDsnpId
required
string
Request Body schema: application/json
required
inReplyTo
required
string
required
object (NoteActivityDto)

Responses

Request samples

Content type
application/json
{
  • "inReplyTo": "string",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Create DSNP Reaction for user

path Parameters
userDsnpId
required
string
Request Body schema: application/json
required
emoji
required
string non-empty DSNP_EMOJI_REGEX
apply
required
number [ 0 .. 255 ]
inReplyTo
required
string

Responses

Request samples

Content type
application/json
{
  • "emoji": "string",
  • "apply": 255,
  • "inReplyTo": "string"
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Update DSNP Content for user

path Parameters
userDsnpId
required
string
Request Body schema: application/json
required
targetContentHash
required
string
targetAnnouncementType
required
string
Enum: "broadcast" "reply"
required
object (NoteActivityDto)

Responses

Request samples

Content type
application/json
{
  • "targetContentHash": "string",
  • "targetAnnouncementType": "broadcast",
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

Delete DSNP Content for user

path Parameters
userDsnpId
required
string
Request Body schema: application/json
required
targetContentHash
required
string
targetAnnouncementType
required
string
Enum: "broadcast" "reply"

Responses

Request samples

Content type
application/json
{
  • "targetContentHash": "string",
  • "targetAnnouncementType": "broadcast"
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

v1/profile

Update a user's Profile

path Parameters
userDsnpId
required
string
Request Body schema: application/json
required
required
object (ProfileActivityDto)

Responses

Request samples

Content type
application/json
{
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "referenceId": "string"
}

health

Check the health status of the service

Responses

Check the live status of the service

Responses

Check the ready status of the service

Responses

dev

Get a Job given a jobId

ONLY enabled when ENVIRONMENT="dev".

path Parameters
jobId
required
string

Responses

Get an Asset given an assetId

ONLY enabled when ENVIRONMENT="dev".

path Parameters
assetId
required
string

Responses

Create dummy announcement data

ONLY enabled when ENVIRONMENT="dev".

path Parameters
count
required
number

Responses