Documentation Powered by Redocly

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 Papers Handler

query Parameters
private
boolean (Private)
Default: false
title
string (Title)
Default: ""

Responses

Response samples

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

Create Paper Handler

Request Body schema: application/json
author_uuid
required
Array of strings <uuid> (Author Uuid)
title
required
string (Title)
label
required
string (Label)
is_public
required
boolean (Is Public)
created_at
required
string <date-time> (Created At)
updated_at
string <date-time> (Updated At)
Default: "2022-11-27T08:58:21.895499"

Responses

Request samples

Content type
application/json
{
  • "author_uuid": [
    ],
  • "title": "string",
  • "label": "string",
  • "is_public": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2022-11-27T08:58:21.895499"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "author_uuid": [
    ],
  • "title": "string",
  • "label": "string",
  • "is_public": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2022-11-27T08:58:21.896650"
}

Read Paper Handler

path Parameters
paper_uuid
required
string <uuid> (Paper Uuid)

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "author_uuid": [
    ],
  • "title": "string",
  • "label": "string",
  • "is_public": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2022-11-27T08:58:21.896650"
}

Upload Paper File Handler

path Parameters
paper_uuid
required
string <uuid> (Paper Uuid)
Request Body schema: multipart/form-data
file
required
string <binary> (File)

Responses

Response samples

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

Download Paper Handler

path Parameters
paper_uuid
required
string <uuid> (Paper Uuid)

Responses

Response samples

Content type
application/json
application/json
application/pdf
null

Delete Paper Handler

Responses

Response samples

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