FastAPI (0.1.0)

Download OpenAPI specification:Download

Root Handler

Responses

Response samples

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

Healthz Handler

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "message": ""
}

Topz Handler

Responses

Response samples

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

Read Stats Handler

Responses

Response samples

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

Create Stats Handler

Request Body schema: application/json
paper_uuid
required
string <uuid> (Paper Uuid)
ip_v4_addr
required
string <ipv4> (Ip V4 Addr)
timestamp
required
string <date-time> (Timestamp)

Responses

Request samples

Content type
application/json
{
  • "paper_uuid": "f36e2ef5-fb4b-4bc7-8388-fbab5279defe",
  • "ip_v4_addr": "192.168.0.1",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "message": ""
}

Read Stat Handler

path Parameters
paper_id
required
string <uuid> (Paper Id)

Responses

Response samples

Content type
application/json
{
  • "paper_uuid": "f36e2ef5-fb4b-4bc7-8388-fbab5279defe",
  • "total_downloads": 0
}