API docs by Redocly

FastAPI (0.1.0)

Download OpenAPI specification:Download

Get All Todos

自身が作成した全ての ToDo を取得する

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Todo

新しい ToDo を作成する

Request Body schema: application/json
required
title
required
string (Title) [ 1 .. 100 ] characters

ToDo のタイトル

description
string (Description) <= 1000 characters
Default: ""

ToDo の詳細

dueDate
string (Duedate) ^(\\d{4}-\\d{2}-\\d{2})?$
Default: ""

ToDo の期日

status
string (Status)
Default: "backlog"
Enum: "backlog" "upcoming" "inProgress" "completed"

ToDo のステータス

Responses

Request samples

Content type
application/json
{
  • "title": "ToDo title",
  • "description": "ToDo description",
  • "dueDate": "2050-12-31",
  • "status": "backlog"
}

Response samples

Content type
application/json
{
  • "id": "0caa59c1-17f7-404d-94f7-e44fccdaaa41",
  • "title": "ToDo title",
  • "description": "ToDo description",
  • "dueDate": "2050-12-31",
  • "status": "backlog"
}

Update Todo

自身が作成した ToDo を指定して更新する（すべての項目を上書き）

path Parameters
todo_id
required
string (Todo Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

ToDo の ID (UUID v4)

Request Body schema: application/json
required
title
required
string (Title) [ 1 .. 100 ] characters

ToDo のタイトル

description
required
string (Description) <= 1000 characters

ToDo の詳細

dueDate
required
string (Duedate) ^(\\d{4}-\\d{2}-\\d{2})?$

ToDo の期日

status
required
string (Status)
Enum: "backlog" "upcoming" "inProgress" "completed"

ToDo のステータス

Responses

Request samples

Content type
application/json
{
  • "title": "ToDo title",
  • "description": "ToDo description",
  • "dueDate": "2050-12-31",
  • "status": "backlog"
}

Response samples

Content type
application/json
{
  • "id": "0caa59c1-17f7-404d-94f7-e44fccdaaa41",
  • "title": "ToDo title",
  • "description": "ToDo description",
  • "dueDate": "2050-12-31",
  • "status": "backlog"
}

Delete Todo

自身が作成した ToDo を指定して削除する

path Parameters
todo_id
required
string (Todo Id) ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

ToDo の ID (UUID v4)

Responses

Response samples

Content type
application/json
{
  • "detail": "Error detail"
}