Skip to content

Commit

Permalink
docs: Fix README (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikuroXina authored Aug 16, 2023
1 parent 4545031 commit 1fc6fb0
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@

## コンセプト

メンバーに専用なアイデンティを割り当てて, これを Discord サーバーへの参加状態と同期させます. そして, メンバーの認証情報それぞれに対する SNS アカウント情報などを関連付けます.
メンバーに専用なアイデンティティを割り当てて, これを Discord サーバーへの参加状態と同期させます. そして, メンバーの認証情報それぞれに対する SNS アカウント情報などを関連付けます.

## フロントエンド

API とは別に登録処理用の簡易的な画面を `/` (ルート) で用意しています. これにより OAuth 2.0 のフローを用いて, Discord の OAuth API 経由で Discord に関連付けてあるアカウント情報 (GitHub と X のみ) を自動登録できます.

:::note
これより下は執筆中であり, 情報が不完全です. 大きく変更される可能性もあります.
:::

## エンドポイント
## バックエンド

以上のコンセプトを実現するための, 以下の HTTP API エンドポイントを設けています. エンドポイントのスキーマは OpenAPI として [openapi.yaml](./openapi.yaml) にも記述してあります. 開発の際にはぜひご利用ください.
以下の HTTP API エンドポイントを設けています. エンドポイントのスキーマは OpenAPI として [openapi.yaml](./openapi.yaml) にも記述してあります. 開発の際にはぜひご利用ください.

### メンバー情報

Expand Down

0 comments on commit 1fc6fb0

Please sign in to comment.