diff --git a/album.proto b/album.proto index 797bc55..9199072 100644 --- a/album.proto +++ b/album.proto @@ -21,35 +21,35 @@ service AlbumService { // アルバム作成リクエスト message CreateAlbumRequest { - // アルバム名 + // アルバム名 [required, max=200] string title = 1; } // アルバム1件取得用リクエスト message GetAlbumRequest { - // アルバムを特定するためのID + // アルバムを特定するためのID [required] int64 album_id = 1; } // アルバム一覧（ID, title)取得用リクエスト message GetMyAlbumsRequest { - // 取得開始位置を知らせるためのアルバムID + // 取得開始位置を知らせるためのアルバムID [required] int64 album_id = 1; - // 最大取得件数 + // 最大取得件数 [default=1, max=20] int64 limit = 2; } // アルバムタイトル変更用リクエスト message UpdateAlbumTitleRequest { - // 変更したいアルバムのID + // 変更したいアルバムのID [required] int64 album_id = 1; - // 変更したいアルバムタイトル + // 変更したいアルバムタイトル [required, max=200] string title = 2; } // アルバム削除用リクエスト message DeleteAlbumRequest { - // 削除したいアルバムのID + // 削除したいアルバムのID [required] int64 album_id = 1; } diff --git a/index.html b/index.html index 922e518..dae3df2 100644 --- a/index.html +++ b/index.html @@ -599,7 +599,7 @@

CreateAlbumRequest

title string -

アルバム名

+

アルバム名 [required, max=200]

@@ -623,7 +623,7 @@

DeleteAlbumRequest

album_id int64 -

削除したいアルバムのID

+

削除したいアルバムのID [required]

@@ -647,7 +647,7 @@

GetAlbumRequest

album_id int64 -

アルバムを特定するためのID

+

アルバムを特定するためのID [required]

@@ -671,14 +671,14 @@

GetMyAlbumsRequest

album_id int64 -

取得開始位置を知らせるためのアルバムID

+

取得開始位置を知らせるためのアルバムID [required]

limit int64 -

最大取得件数

+

最大取得件数 [default=1, max=20]

@@ -702,14 +702,14 @@

UpdateAlbumTitleRequest

album_id int64 -

変更したいアルバムのID

+

変更したいアルバムのID [required]

title string -

変更したいアルバムタイトル

+

変更したいアルバムタイトル [required, max=200]

@@ -837,14 +837,14 @@

AddMemoryTagsRequest

memory_id int64 -

タグを追加する思い出のID

+

タグを追加する思い出のID [required]

tag_names string repeated -

追加したいタグの名前一覧（配列）

+

追加したいタグの名前一覧（配列） [required, max_len=20]

@@ -868,14 +868,14 @@

CreateMemoryPhotosRequest

memory_id int64 -

画像を追加する思い出のID

+

画像を追加する思い出のID [required]

photo_file bytes repeated -

アップロードしたい画像ファイル(配列)

+

アップロードしたい画像ファイル(配列) [required, max_len=5]

@@ -899,21 +899,21 @@

CreateMemoryRequest

album_id int64 -

投稿した思い出を保存するアルバムのID

+

投稿した思い出を保存するアルバムのID [required]

activity string -

やったこと

+

やったこと [required, max=50]

date int64 -

日付(UNIX)

+

日付(UNIX) [required]

@@ -927,7 +927,7 @@

CreateMemoryRequest

place string -

場所

+

場所 [required, max=200]

@@ -965,14 +965,14 @@

DeleteMemoryPhotosRequest

memory_id int64 -

画像を削除する思い出のID

+

画像を削除する思い出のID [required]

photo_ids int64 repeated -

削除したい画像のID一覧（配列）

+

削除したい画像のID一覧（配列） [required]

@@ -996,7 +996,7 @@

DeleteMemoryRequest

memory_id int64 -

削除する思い出のID

+

削除する思い出のID [required]

@@ -1020,14 +1020,14 @@

DeleteMemoryTagsRequest

memory_id int64 -

タグを削除する思い出のID

+

タグを削除する思い出のID [required]

tag_ids int64 repeated -

削除したいタグのID一覧（配列）

+

削除したいタグのID一覧（配列） [required]

@@ -1051,7 +1051,7 @@

GetMemoryRequest

memory_id int64 -

思い出1件を特定するための思い出ID

+

思い出1件を特定するための思い出ID [required]

@@ -1075,7 +1075,7 @@

GetUserMemoriesRequest

user_name string -

ユーザー名

+

ユーザー名 [required, max=20]

@@ -1234,35 +1234,35 @@

UpdateMemoryRequest

memory_id int64 -

更新する思い出のID

+

更新する思い出のID [required]

activity string -

やったこと

+

やったこと [required] ← ユーザー入力がない場合は現在の値を埋め込むこと

date int64 -

日付(UNIX)

+

日付(UNIX) [required] ← ユーザー入力がない場合は現在の値を埋め込むこと

description string -

思い出の説明

+

思い出の説明 ← ユーザー入力がない場合は現在の値を埋め込むこと

place string -

場所

+

場所 [required, max=200] ← ユーザー入力がない場合は現在の値を埋め込むこと

@@ -1522,14 +1522,14 @@

CreateUserRequest

name string -

表示名

+

表示名 [required, max=50]

user_name string -

ユーザ名

+

ユーザ名 [required, max=20]

@@ -1543,28 +1543,28 @@

CreateUserRequest

bio string -

ひとこと

+

ひとこと [max=100]

gender proto_enums.GenderType -

性別（1: man, 2: woman, 3: unknown）

+

性別（1: man, 2: woman, 3: unknown） [required]

phone string -

電話番号

+

電話番号 [max=15]

place string -

現在地的な。Twitterの真似

+

現在地的な。Twitterの真似 [max=30]

@@ -1595,7 +1595,7 @@

GetUserRequest

user_name string -

ユーザー名

+

ユーザー名 [required, max=20]

@@ -1619,56 +1619,58 @@

UpdateUserProfileRequest

user_id int64 -

更新したいユーザーのID

+

更新したいユーザーのID [required]

name string -

表示名

+

表示名 [required, max=50] ← ユーザー入力がない場合は現在の値を埋め込むこと

user_name string -

ユーザ名

+

ユーザ名 [required, max=20, 他ユーザーと重複していない] +←ユーザー入力がない場合は現在の値を埋め込むこと

thumbnail bytes -

アイコンのURL

+

アイコン画像

bio string -

ひとこと

+

ひとこと [max=100]

gender proto_enums.GenderType -

性別（1: man, 2: woman, 3: unknown）

+

性別（1: man, 2: woman, 3: unknown） [required] +←ユーザー入力がない場合は現在の値を埋め込むこと

phone string -

電話番号

+

電話番号 [max=15]

place string -

現在地的な。Twitterの真似

+

現在地的な。Twitterの真似 [max=30]

@@ -1826,7 +1828,14 @@

CreateWishBoardRequest

title string -

やりたいことボード名

+

やりたいことボード名 [required, max=30]

+ + + + background_image + bytes + +

新しい背景画像ファイル [空の場合はサーバー側でデフォルトの画像をセット]

@@ -1850,7 +1859,7 @@

DeleteWishBoardRequest

wish_board_id int64 -

削除したいやりたいことボードのID

+

削除したいやりたいことボードのID [required]

@@ -1874,14 +1883,14 @@

GetWishBoardListRequest

wish_board_id int64 -

取得開始位置を知らせるためのやりたいことボードID

+

取得開始位置を知らせるためのやりたいことボードID [required]

limit int64 -

最大取得件数

+

最大取得件数 [default=1, max=20]

@@ -1905,7 +1914,7 @@

GetWishBoardRequest

wish_board_id int64 -

やりたいことボードを特定するためのID

+

やりたいことボードを特定するためのID [required]

@@ -1929,14 +1938,14 @@

UpdateWishBoardBa wish_board_id int64 -

やりたいことボードID

+

やりたいことボードID [required]

background_image bytes -

新しい背景画像ファイル

+

新しい背景画像ファイル [required]

@@ -1960,14 +1969,14 @@

UpdateWishBoardNameRequestwish_board_id int64 -

やりたいことボードID

+

やりたいことボードID [required]

title string -

新しいやりたいことボード名

+

新しいやりたいことボード名 [required, max=30]

@@ -1991,14 +2000,14 @@

UpdateWishCate wish_board_id int64 -

やりたいことボードID

+

やりたいことボードID [required]

position WishCategoryAndCardPosition repeated -

やりたいことカテゴリーの並び順（IDの配列）

+

やりたいことカテゴリーの並び順（IDの配列） [required]

@@ -2105,7 +2114,7 @@

WishCategoryAndCardPosition wish_category_id int64 -

やりたいことカテゴリーID

+

やりたいことカテゴリーID [max_len=1]

@@ -2211,14 +2220,14 @@

AddWishCardTagsRequest

wish_card_id int64 -

タグを追加するやりたいことカードのID

+

タグを追加するやりたいことカードのID [required]

tag_names string repeated -

追加したいタグの名前一覧（配列）

+

追加したいタグの名前一覧（配列） [required, max=20]

@@ -2242,35 +2251,35 @@

CreateWishCardRequest

wish_category_id int64 -

やりたいことカテゴリーID

+

やりたいことカテゴリーID [required]

activity string -

何をしたいのか

+

何をしたいのか [required, max=50]

description string -

やりたいことの説明

+

やりたいことの説明 [max=100]

date int64 -

いつやりたいか（UNIX）

+

いつやりたいか（UNIX） [過去の日付ではない]

place string -

どこでそれをしたいのか

+

どこでそれをしたいのか [required, max=200]

@@ -2294,7 +2303,7 @@

DeleteWishCardRequest

wish_card_id int64 -

削除したいやりたいことカードのID

+

削除したいやりたいことカードのID [required]

@@ -2318,14 +2327,14 @@

DeleteWishCardTagsRequest

wish_card_id int64 -

タグを削除するやりたいことカードのID

+

タグを削除するやりたいことカードのID [required]

tag_ids int64 repeated -

削除したいタグのID一覧（配列）

+

削除したいタグのID一覧（配列） [required]

@@ -2349,14 +2358,14 @@

UpdateWishCardActivityRequ wish_card_id int64 -

カードのID

+

カードのID [required]

activity string -

アクティビティ名

+

アクティビティ名 [required, max=50]

@@ -2380,14 +2389,14 @@

UpdateWishCardDateRequest

wish_card_id int64 -

カードのID

+

カードのID [required]

date int64 -

日付

+

日付 [required, 過去の日付ではない]

@@ -2411,14 +2420,14 @@

UpdateWishCardDescripti wish_card_id int64 -

カードのID

+

カードのID [required]

description string -

説明

+

説明 [required, max=100]

@@ -2442,14 +2451,14 @@

UpdateWishCardPlaceRequestwish_card_id int64 -

カードのID

+

カードのID [required]

place string -

場所

+

場所 [required, max=200]

@@ -2618,17 +2627,17 @@

CreateWishCategoryRequest< - wish_list_id + wish_board_id int64 -

やりたいことリストID

+

やりたいことボードID [required]

title string -

やりたいことカテゴリー名

+

やりたいことカテゴリー名 [required, max=30]

@@ -2652,7 +2661,7 @@

DeleteWishCategoryRequest< wish_category_id int64 -

削除したいやりたいことカテゴリーのID

+

削除したいやりたいことカテゴリーのID [required]

@@ -2676,14 +2685,14 @@

UpdateWishCategoryTit wish_category_id int64 -

やりたいことカテゴリーID

+

やりたいことカテゴリーID [required]

title string -

新規やりたいことカテゴリータイトル

+

新規やりたいことカテゴリータイトル [required, max=30]

diff --git a/memory.proto b/memory.proto index 152b004..7a108ff 100644 --- a/memory.proto +++ b/memory.proto @@ -31,27 +31,27 @@ service MemoryService { // 思い出情報取得用リクエスト message GetMemoryRequest { - // 思い出1件を特定するための思い出ID + // 思い出1件を特定するための思い出ID [required] int64 memory_id = 1; } // ユーザーに紐づく思い出一覧取得用リクエスト message GetUserMemoriesRequest { - // ユーザー名 + // ユーザー名 [required, max=20] string user_name = 1; } // 思い出新規作成リクエスト message CreateMemoryRequest { - // 投稿した思い出を保存するアルバムのID + // 投稿した思い出を保存するアルバムのID [required] int64 album_id = 1; - // やったこと + // やったこと [required, max=50] string activity = 2; - // 日付(UNIX) + // 日付(UNIX) [required] int64 date = 3; // 思い出の説明 string description = 4; - // 場所 + // 場所 [required, max=200] string place = 5; // アップロードしたい画像一覧（配列） repeated proto_photo.Photo photos = 6; @@ -61,53 +61,53 @@ message CreateMemoryRequest { // 思い出削除リクエスト message DeleteMemoryRequest { - // 削除する思い出のID + // 削除する思い出のID [required] int64 memory_id = 1; } // 思い出の基本情報更新用リクエスト message UpdateMemoryRequest { - // 更新する思い出のID + // 更新する思い出のID [required] int64 memory_id = 1; - // やったこと + // やったこと [required] ← ユーザー入力がない場合は現在の値を埋め込むこと string activity = 2; - // 日付(UNIX) + // 日付(UNIX) [required] ← ユーザー入力がない場合は現在の値を埋め込むこと int64 date = 3; - // 思い出の説明 + // 思い出の説明 ← ユーザー入力がない場合は現在の値を埋め込むこと string description = 4; - // 場所 + // 場所 [required, max=200] ← ユーザー入力がない場合は現在の値を埋め込むこと string place = 5; } // 思い出に新規画像を追加するためのリクエスト message CreateMemoryPhotosRequest { - // 画像を追加する思い出のID + // 画像を追加する思い出のID [required] int64 memory_id = 1; - // アップロードしたい画像ファイル(配列) + // アップロードしたい画像ファイル(配列) [required, max_len=5] repeated bytes photo_file = 2; } // 思い出に紐づく画像のうちから指定したものを削除するためのリクエスト message DeleteMemoryPhotosRequest { - // 画像を削除する思い出のID + // 画像を削除する思い出のID [required] int64 memory_id = 1; - // 削除したい画像のID一覧（配列） + // 削除したい画像のID一覧（配列） [required] repeated int64 photo_ids = 2; } // 思い出にタグを追加するためのリクエスト message AddMemoryTagsRequest { - // タグを追加する思い出のID + // タグを追加する思い出のID [required] int64 memory_id = 1; - // 追加したいタグの名前一覧（配列） + // 追加したいタグの名前一覧（配列） [required, max_len=20] repeated string tag_names = 2; } // 思い出のタグを削除するためのリクエスト message DeleteMemoryTagsRequest { - // タグを削除する思い出のID + // タグを削除する思い出のID [required] int64 memory_id = 1; - // 削除したいタグのID一覧（配列） + // 削除したいタグのID一覧（配列） [required] repeated int64 tag_ids = 2; } diff --git a/user.proto b/user.proto index 0280aa0..2f57b49 100644 --- a/user.proto +++ b/user.proto @@ -19,19 +19,19 @@ service UserService { // 新規ユーザ作成リクエスト message CreateUserRequest { - // 表示名 + // 表示名 [required, max=50] string name = 1; - // ユーザ名 + // ユーザ名 [required, max=20] string user_name = 2; // アイコン画像ファイル bytes thumbnail = 3; - // ひとこと + // ひとこと [max=100] string bio = 4; - // 性別（1: man, 2: woman, 3: unknown） + // 性別（1: man, 2: woman, 3: unknown） [required] proto_enums.GenderType gender = 5; - // 電話番号 + // 電話番号 [max=15] string phone = 6; - // 現在地的な。Twitterの真似 + // 現在地的な。Twitterの真似 [max=30] string place = 7; // 生年月日(UNIX) int64 birth = 8; @@ -39,27 +39,29 @@ message CreateUserRequest { // ユーザー情報取得リクエスト（ユーザーを特定するためのID情報） message GetUserRequest { - // ユーザー名 + // ユーザー名 [required, max=20] string user_name = 1; } // ユーザー情報更新リクエスト message UpdateUserProfileRequest { - // 更新したいユーザーのID + // 更新したいユーザーのID [required] int64 user_id = 1; - // 表示名 + // 表示名 [required, max=50] ← ユーザー入力がない場合は現在の値を埋め込むこと string name = 2; - // ユーザ名 + // ユーザ名 [required, max=20, 他ユーザーと重複していない] + // ←ユーザー入力がない場合は現在の値を埋め込むこと string user_name = 3; - // アイコンのURL + // アイコン画像 bytes thumbnail = 4; - // ひとこと + // ひとこと [max=100] string bio = 5; - // 性別（1: man, 2: woman, 3: unknown） + // 性別（1: man, 2: woman, 3: unknown） [required] + // ←ユーザー入力がない場合は現在の値を埋め込むこと proto_enums.GenderType gender = 6; - // 電話番号 + // 電話番号 [max=15] string phone = 7; - // 現在地的な。Twitterの真似 + // 現在地的な。Twitterの真似 [max=30] string place = 8; // 生年月日(UNIX) int64 birth = 9; diff --git a/wish_board.proto b/wish_board.proto index c2cb7e0..add33fd 100644 --- a/wish_board.proto +++ b/wish_board.proto @@ -30,51 +30,53 @@ service WishBoardService { // やりたいことボード新規作成リクエスト message CreateWishBoardRequest { - // やりたいことボード名 + // やりたいことボード名 [required, max=30] string title = 1; + // 新しい背景画像ファイル [空の場合はサーバー側でデフォルトの画像をセット] + bytes background_image = 2; } // やりたいことボード（ID, titleのみ）の配列を取得するためのリクエスト message GetWishBoardListRequest { - // 取得開始位置を知らせるためのやりたいことボードID + // 取得開始位置を知らせるためのやりたいことボードID [required] int64 wish_board_id = 1; - // 最大取得件数 + // 最大取得件数 [default=1, max=20] int64 limit = 2; } // IDをもとにやりたいことボードを1件取得するためのリクエスト message GetWishBoardRequest { - // やりたいことボードを特定するためのID + // やりたいことボードを特定するためのID [required] int64 wish_board_id = 1; } // やりたいことボード名変更リクエスト message UpdateWishBoardNameRequest { - // やりたいことボードID + // やりたいことボードID [required] int64 wish_board_id = 1; - // 新しいやりたいことボード名 + // 新しいやりたいことボード名 [required, max=30] string title = 2; } // やりたいことボード背景画像変更リクエスト message UpdateWishBoardBackgroundImageRequest { - // やりたいことボードID + // やりたいことボードID [required] int64 wish_board_id = 1; - // 新しい背景画像ファイル + // 新しい背景画像ファイル [required] bytes background_image = 2; } // やりたいことカテゴリーの並び替えリクエスト message UpdateWishCategoryAndCardPositionRequest { - // やりたいことボードID + // やりたいことボードID [required] int64 wish_board_id = 1; - // やりたいことカテゴリーの並び順（IDの配列） + // やりたいことカテゴリーの並び順（IDの配列） [required] repeated WishCategoryAndCardPosition position = 2; } // やりたいことカテゴリーとカードのポジションを表したもの message WishCategoryAndCardPosition { - // やりたいことカテゴリーID + // やりたいことカテゴリーID [max_len=1] int64 wish_category_id = 1; // やりたいことカテゴリーに所属するカードのID一覧（並び順を表す配列） repeated int64 wish_card_ids = 2; @@ -82,7 +84,7 @@ message WishCategoryAndCardPosition { // やりたいことボード削除用リクエスト message DeleteWishBoardRequest { - // 削除したいやりたいことボードのID + // 削除したいやりたいことボードのID [required] int64 wish_board_id = 1; } diff --git a/wish_card.proto b/wish_card.proto index 7e60521..3ec68e9 100644 --- a/wish_card.proto +++ b/wish_card.proto @@ -33,69 +33,69 @@ service WishCardService { // やりたいことカード新規作成リクエスト message CreateWishCardRequest { - // やりたいことカテゴリーID + // やりたいことカテゴリーID [required] int64 wish_category_id = 1; - // 何をしたいのか + // 何をしたいのか [required, max=50] string activity = 2; - // やりたいことの説明 + // やりたいことの説明 [max=100] string description = 3; - // いつやりたいか（UNIX） + // いつやりたいか（UNIX） [過去の日付ではない] int64 date = 4; - // どこでそれをしたいのか + // どこでそれをしたいのか [required, max=200] string place = 5; } // やりたいことカードのアクティビティ更新リクエスト message UpdateWishCardActivityRequest { - // カードのID + // カードのID [required] int64 wish_card_id = 1; - // アクティビティ名 + // アクティビティ名 [required, max=50] string activity = 2; } // やりたいことカードの説明更新リクエスト message UpdateWishCardDescriptionRequest { - // カードのID + // カードのID [required] int64 wish_card_id = 1; - // 説明 + // 説明 [required, max=100] string description = 2; } // やりたいことカードの日付変更リクエスト message UpdateWishCardDateRequest { - // カードのID + // カードのID [required] int64 wish_card_id = 1; - // 日付 + // 日付 [required, 過去の日付ではない] int64 date = 2; } // やりたいことカードの場所変更リクエスト message UpdateWishCardPlaceRequest { - // カードのID + // カードのID [required] int64 wish_card_id = 1; - // 場所 + // 場所 [required, max=200] string place = 2; } // やりたいことカードに新規タグの追加リクエスト message AddWishCardTagsRequest { - // タグを追加するやりたいことカードのID + // タグを追加するやりたいことカードのID [required] int64 wish_card_id = 1; - // 追加したいタグの名前一覧（配列） + // 追加したいタグの名前一覧（配列） [required, max=20] repeated string tag_names = 2; } // やりたいことカードからタグを削除 message DeleteWishCardTagsRequest { - // タグを削除するやりたいことカードのID + // タグを削除するやりたいことカードのID [required] int64 wish_card_id = 1; - // 削除したいタグのID一覧（配列） + // 削除したいタグのID一覧（配列） [required] repeated int64 tag_ids = 2; } // やりたいことカード削除用リクエスト message DeleteWishCardRequest { - // 削除したいやりたいことカードのID + // 削除したいやりたいことカードのID [required] int64 wish_card_id = 1; } diff --git a/wish_category.proto b/wish_category.proto index 5d8c6af..3728500 100644 --- a/wish_category.proto +++ b/wish_category.proto @@ -20,23 +20,23 @@ service WishCategoryService { // やりたいことカテゴリー新規作成リクエスト message CreateWishCategoryRequest { - // やりたいことリストID - int64 wish_list_id = 1; - // やりたいことカテゴリー名 + // やりたいことボードID [required] + int64 wish_board_id = 1; + // やりたいことカテゴリー名 [required, max=30] string title = 2; } // やりたいことカテゴリータイトル更新リクエスト message UpdateWishCategoryTitleRequest { - // やりたいことカテゴリーID + // やりたいことカテゴリーID [required] int64 wish_category_id = 1; - // 新規やりたいことカテゴリータイトル + // 新規やりたいことカテゴリータイトル [required, max=30] string title = 2; } // やりたいことカテゴリー削除用リクエスト message DeleteWishCategoryRequest { - // 削除したいやりたいことカテゴリーのID + // 削除したいやりたいことカテゴリーのID [required] int64 wish_category_id = 1; }