Skip to content

Commit c14bd81

Browse files
m1sk9m1sk9
authored
Merge pull request #5 from pulsate-dev/fix-spec-missing
docs: 複数のエンドポイントリファレンスのミスを修正
2 parents 0012485 + 565b830 commit c14bd81

File tree

4 files changed

+31
-29
lines changed

4 files changed

+31
-29
lines changed

‎src/endpoint/account.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -517,10 +517,10 @@ body: `application/json`
517517
}
518518
```
519519

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

525525
**`400 Bad Request`**
526526

‎src/endpoint/drive.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -104,16 +104,16 @@
104104
}
105105
```
106106

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

118118
**`400 Bad Request`**
119119

‎src/endpoint/list.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
# リストAPI
2+
13
## `POST /lists/`
24

35
リストを作成します
46

5-
### 入力:
7+
### 入力
68

79
- body: `application/json`
810

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

14-
### 入力例:
16+
### 入力例
1517

1618
```json
1719
{

‎src/endpoint/notes.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414

1515
- body: `application/json`
1616

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

2525
### 入力例
2626

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

235-
### 入力例:
235+
### 入力例
236236

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

503503
body: `application/json`
504504

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

511511
### 入力例
512512

0 commit comments

Comments
 (0)