API docs by Redocly

Octo Deck API (1.0.0)

Download OpenAPI specification:

カード一覧取得

自分のデッキを取得

Authorizations:
BearerAuth

Responses

Response samples

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

カードをデッキに追加

Authorizations:
BearerAuth
Request Body schema: text/plain
required
string

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

自分のカード取得

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

データベース内のカードすべてを更新

Authorizations:
BearerAuth

Responses

Response samples

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

指定したカード取得

デッキにないカードも取得できる

Authorizations:
BearerAuth
path Parameters
githubId
required
string

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

カードをデッキから削除

Authorizations:
BearerAuth
path Parameters
githubId
required
string

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

コミュニティ一覧取得

自分が入っているコミュニティ一覧取得

Authorizations:
BearerAuth

Responses

Response samples

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

コミュニティを作成

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string
startDateTime
required
string <date-time>
endDateTime
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "community": {
    }
}

指定したコミュニティ取得

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "community": {
    },
  • "highlightedCard": {
    }
}

コミュニティを削除

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "community": {
    }
}

指定したコミュニティのカード一覧取得

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

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

指定したコミュニティに自分のカードを追加

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

指定したコミュニティの自分のカードを削除

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

コミュニティのHighlightedCardを更新

GitHub APIを呼び出してHighlightedCardを再計算し、データベースに保存する

Authorizations:
BearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "community": {
    },
  • "highlightedCard": {
    }
}

自分の統計情報取得

Authorizations:
BearerAuth

Responses

Response samples

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

ユーザーの統計情報取得

Authorizations:
BearerAuth
path Parameters
githubId
required
string

Responses

Response samples

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