API docs by Redocly

Zeus Firehose View UI API (0.1.0)

Download OpenAPI specification:

REST API for @zeus/firehose-view-ui corpus browser.

system

Service health

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "service": "string",
  • "timestamp": "string"
}

config

Extended app config (firehose shape)

Responses

Response samples

Content type
application/json
{
  • "theme": null,
  • "discovery": null,
  • "defaultCorpus": "string",
  • "branding": null,
  • "volume": null
}

theme

List available themes

Responses

Response samples

Content type
application/json
{
  • "themes": [
    ],
  • "current": "string"
}

Current theme name

Responses

Response samples

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

Switch active theme

Request Body schema: application/json
required
theme
required
string non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "success": true,
  • "current": "string",
  • "previous": "string"
}

browse

List firehose corpora

Responses

Response samples

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

Corpus metadata by id

path Parameters
corpusId
required
string

Responses

Response samples

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

Browse corpus directory

query Parameters
corpus
required
string
path
string
offset
number
limit
number

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Read corpus file and set focus

query Parameters
corpus
required
string
path
required
string

Responses

Response samples

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

Micropost preview list

query Parameters
corpus
required
string
path
string
recursive
string
limit
number
offset
number

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Triage manifest

Responses

Response samples

Content type
application/json
{
  • "manifest": null
}

Firehose volume stats

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Current focus snapshot

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Service metadata

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}