API docs by Redocly

Odyssage API (0.0.0)

Download OpenAPI specification:

License: MIT

Odyssage Backend API

シナリオ一覧全取得

シナリオの一覧を取得

Responses

Response samples

Content type
application/json
[
  • {
    }
]

公開シナリオ一覧取得

公開されているシナリオの一覧のみを取得

Responses

Response samples

Content type
application/json
[
  • {
    }
]

シナリオ取得

指定したユーザを取得

Authorizations:
bearerAuth
path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "overview": "string",
  • "updatedAt": "string"
}

ユーザ取得

指定したユーザを取得

Authorizations:
bearerAuth
path Parameters
uid
required
string

Responses

Response samples

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

ユーザ登録

指定したユーザを登録

Authorizations:
bearerAuth
path Parameters
uid
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

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

Response samples

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

シナリオ作成

指定したユーザのシナリオを作成

Authorizations:
bearerAuth
path Parameters
uid
required
string
Request Body schema: application/json
required
id
required
string
title
required
string
overview
required
string
visibility
string
Enum: "public" "private"

シナリオの公開設定

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "overview": "string",
  • "visibility": "public"
}

Response samples

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

ユーザーシナリオ一覧全取得

シナリオの一覧を取得

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ユーザーがストックしたシナリオ一覧の取得

指定されたユーザーがストックしたシナリオの一覧を返します

Authorizations:
bearerAuth
path Parameters
user_id
required
string

ユーザーID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ユーザーのストックにシナリオを追加

ユーザーが将来参照するためにシナリオをストック（保存）します

Authorizations:
bearerAuth
path Parameters
user_id
required
string

ユーザーID

scenario_id
required
string <uuid>

ストックするシナリオのID

Responses

ユーザーのストックからシナリオを削除

以前にストックしたシナリオをユーザーのコレクションから削除します

Authorizations:
bearerAuth
path Parameters
user_id
required
string

ユーザーID

scenario_id
required
string <uuid>

ストックから削除するシナリオのID

Responses

session

セッション状態更新

GMが自分のセッションの状態を更新するためのエンドポイント。 セッションの状態を「準備中」「進行中」「終了」のいずれかに変更できます。 セッションのGMであるユーザーのみが更新可能です。

Authorizations:
bearerAuth
path Parameters
uid
required
string

GMのユーザーID

id
required
string <uuid>

更新対象のセッションID

Request Body schema: application/json
required
status
required
string
Enum: "準備中" "進行中" "終了"

更新するセッションの状態

Responses

Request samples

Content type
application/json
{
  • "status": "進行中"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "gmId": "user123",
  • "scenarioId": "550e8400-e29b-41d4-a716-446655440001",
  • "title": "未知の洞窟探検",
  • "status": "準備中",
  • "createdAt": "2025-04-01T12:00:00Z",
  • "updatedAt": "2025-04-01T12:00:00Z",
  • "scenarioTitle": "失われた遺跡の秘宝"
}

セッション一覧取得

公開セッションの一覧を取得するエンドポイント。 GMがリクエストする場合は、GM IDをクエリパラメータで指定することで、自分の非公開セッションも含めて取得できます。

query Parameters
gmId
string

GM ID (指定すると、そのGMのセッションのみを取得)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

セッション作成

GMがシナリオを選択して新しいセッションを作成するためのエンドポイント。 作成したセッションはGMが管理し、参加者を招待できます。

Request Body schema: application/json
required
gmId
required
string

セッションを管理するGMのユーザーID

scenarioId
required
string <uuid>

セッションのベースとなるシナリオID

title
required
string

セッションのタイトル

Responses

Request samples

Content type
application/json
{
  • "gmId": "user123",
  • "scenarioId": "550e8400-e29b-41d4-a716-446655440001",
  • "title": "未知の洞窟探検"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "gmId": "user123",
  • "scenarioId": "550e8400-e29b-41d4-a716-446655440001",
  • "title": "未知の洞窟探検",
  • "status": "準備中",
  • "createdAt": "2025-04-01T12:00:00Z"
}

セッション取得

特定のセッションの詳細情報を取得します。 セッションのタイトル、ステータス、関連するシナリオ情報などが含まれます。

path Parameters
id
required
string <uuid>

取得するセッションのID

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "gmId": "user123",
  • "scenarioId": "550e8400-e29b-41d4-a716-446655440001",
  • "title": "未知の洞窟探検",
  • "status": "準備中",
  • "createdAt": "2025-04-01T12:00:00Z",
  • "updatedAt": "2025-04-01T12:00:00Z",
  • "scenarioTitle": "失われた遺跡の秘宝"
}

GM管理セッション一覧

特定のGMが作成・管理しているセッション一覧を取得します。 準備中、進行中、終了などの異なるステータスのセッションがすべて含まれます。

path Parameters
gm_id
required
string

GMのユーザーID

Responses

Response samples

Content type
application/json
[
  • {
    }
]