Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: 複数のエンドポイントリファレンスのミスを修正 #5

Merged
merged 2 commits into from
Jul 20, 2024
Merged

docs: 複数のエンドポイントリファレンスのミスを修正 #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
743db6e
docs: Fix `/list` endpoint docs
m1sk9 Jul 20, 2024
565b830
docs: fix notion link
m1sk9 Jul 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/endpoint/account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,10 +517,10 @@ body: `application/json`
}
```

| 項目名 | 型 | 制約/説明 | 文字数 | 例 |
| ------------------------------------------------------------------------- | -------- | ------------ | ------ | -- |
| autorization_token | `string` | 認証トークン | | |
| [Untitled](https://www.notion.so/74411becb886427fb512a32d523d6faf) を参照 | | | | |
| 項目名 | 型 | 制約/説明 | 文字数 | 例 |
| -------------------------- | -------- | ------------ | ------ | -- |
| autorization_token | `string` | 認証トークン | | |
| [共通](../model.md) を参照 | | | | |

**`400 Bad Request`**

Expand Down
20 changes: 10 additions & 10 deletions src/endpoint/drive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,16 +104,16 @@
}
```

| 項目名 | 型 | 説明 | 制約 | 例 |
| --------- | --------------------- | ------------------------------------------------------------------ | ------------- | -- |
| id | `snowflake` | ファイルのID | | |
| name | `string` | ファイル名 | 1≤N≤256[文字] | |
| author_id | `snowflake` | アップロードしたアカウントのID | | |
| hash | `string` | 画像のblurhash | | |
| mime | `string` | mimeタイプ | | |
| nsfw | `boolean` | [Untitled](https://www.notion.so/525158aa6a3c4af79b87bff62736f844) | | |
| url | `string` | 画像へのリンク | | |
| thumbnail | `string`, `undefined` | (利用可能な場合のみ) 縮小版のサムネイル画像 | | |
| 項目名 | 型 | 説明 | 制約 | 例 |
| --------- | --------------------- | ------------------------------------------- | ------------- | -- |
| id | `snowflake` | ファイルのID | | |
| name | `string` | ファイル名 | 1≤N≤256[文字] | |
| author_id | `snowflake` | アップロードしたアカウントのID | | |
| hash | `string` | 画像のblurhash | | |
| mime | `string` | mimeタイプ | | |
| nsfw | `boolean` | [NSFWフラグ](../endpoint.md#nsfwフラグ) | | |
| url | `string` | 画像へのリンク | | |
| thumbnail | `string`, `undefined` | (利用可能な場合のみ) 縮小版のサムネイル画像 | | |

**`400 Bad Request`**

Expand Down
6 changes: 4 additions & 2 deletions src/endpoint/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# リストAPI

## `POST /lists/`

リストを作成します

### 入力:
### 入力

- body: `application/json`

Expand All @@ -11,7 +13,7 @@
| title | `string` | リストのタイトル | 1≤N≤100[文字] | |
| public | `boolean` | デフォルト: `false` (非公開) 公開: 　リストにアサインされたアカウントには通知が飛びます. 非公開: 通知は飛ばず、自分以外のアカウントからは見えません | | |

### 入力例:
### 入力例

```json
{
Expand Down
26 changes: 13 additions & 13 deletions src/endpoint/notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@

- body: `application/json`

| 項目名 | 型 | 制約/説明 | 数制約 | 例 |
| ------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------ | ------------- | -- |
| content | `string` | 投稿本文添付ファイルが存在する場合は0文字を許容 | 1≤3000[文字] | |
| visibility | `string`, `undefined` | 投稿の公開範囲 デフォルト: `public` とり得る値: `public` `home` `followers`, `direct` | - | |
| attachment_file_ids | `Array<snowflake>, undefined` | 投稿の添付ファイルID 1つでもファイルが存在しない場合はエラー終了する | 0≤N≤16[個] | |
| cw_comment | `string` | CW時の注釈 [Untitled](https://www.notion.so/bb170e32e67142e79221de90c29c9cd4) 参照デフォルトは空文字列 | 0≤N≤256[文字] | |
| send_to | `snowflake`, `undefined` | ダイレクト投稿の宛先公開範囲が`direct`のときのみ指定可能 | | |
| 項目名 | 型 | 制約/説明 | 数制約 | 例 |
| ------------------- | ----------------------------- | ------------------------------------------------------------------------------------------ | ------------- | -- |
| content | `string` | 投稿本文添付ファイルが存在する場合は0文字を許容 | 1≤3000[文字] | |
| visibility | `string`, `undefined` | 投稿の公開範囲 デフォルト: `public` とり得る値: `public` `home` `followers`, `direct` | - | |
| attachment_file_ids | `Array<snowflake>, undefined` | 投稿の添付ファイルID 1つでもファイルが存在しない場合はエラー終了する | 0≤N≤16[個] | |
| cw_comment | `string` | CW時の注釈. [CW/CWフラグ](../endpoint.md#contentswarningcwフラグ) 参照デフォルトは空文字列 | 0≤N≤256[文字] | |
| send_to | `snowflake`, `undefined` | ダイレクト投稿の宛先公開範囲が`direct`のときのみ指定可能 | | |

### 入力例

Expand Down Expand Up @@ -232,7 +232,7 @@
| blur | `string` | 添付ファイルが画像であるときのサムネイルの [blurhash](https://blurha.sh/) | | |
| nsfw | `boolean` | ToDo | | |

### 入力例:
### 入力例

```json
{
Expand Down Expand Up @@ -502,11 +502,11 @@ NOTICE: 自分以外のノートを削除する場合はモデレータ以上の

body: `application/json`

| 項目名 | 型 | 説明 | 例 |
| ------------------------------------------------------------------------------ | ------------------- | ------ | -- |
| emoji | `string` | 絵文字 | |
| 表記法は [共通](https://www.notion.so/74411becb886427fb512a32d523d6faf) を参照 | `<:alias:11938437>` | | |
| `🎉` | | | |
| 項目名 | 型 | 説明 | 例 |
| --------------------------------------------------------------- | ------------------- | ------ | -- |
| emoji | `string` | 絵文字 | |
| 表記法は [カスタム絵文字](../endpoint.md#カスタム絵文字) を参照 | `<:alias:11938437>` | | |
| `🎉` | | | |

### 入力例

Expand Down