💡 Added missing fields docs

forward_message.go

@@ -4,13 +4,16 @@ import json "github.com/pquerna/ffjson/ffjson"
 
 // ForwardMessageParameters represents data for ForwardMessage method.
 type ForwardMessageParameters struct {
-	// Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+	// Unique identifier for the target chat or username of the target
+	// channel (in the format @channelusername)
 	ChatID int64 `json:"chat_id"`
 
-	// Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
+	// Unique identifier for the chat where the original message was sent
+	// (or channel username in the format @channelusername)
 	FromChatID int64 `json:"from_chat_id"`
 
-	// Sends the message silently. Users will receive a notification with no sound.
+	// Sends the message silently. Users will receive a notification with no
+	// sound.
 	DisableNotification bool `json:"disable_notification,omitempty"`
 
 	// Message identifier in the chat specified in from_chat_id

get_chat_member.go

@@ -7,6 +7,7 @@ type GetChatMemberParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// Unique identifier of the target user
 	UserID int `json:"user_id"`
 }
 

get_file.go

@@ -4,6 +4,7 @@ import json "github.com/pquerna/ffjson/ffjson"
 
 // GetFileParameters represents data for GetFile method.
 type GetFileParameters struct {
+	// File identifier to get info about
 	FileID string `json:"file_id"`
 }
 

get_user_profile_photos.go

@@ -4,9 +4,16 @@ import json "github.com/pquerna/ffjson/ffjson"
 
 // GetUserProfilePhotosParameters represents data for GetUserProfilePhotos method.
 type GetUserProfilePhotosParameters struct {
+	// Unique identifier of the target user
 	UserID int `json:"user_id"`
-	Offset int `json:"offset"`
-	Limit  int `json:"limit"`
+
+	// Sequential number of the first photo to be returned. By default, all
+	// photos are returned.
+	Offset int `json:"offset,omitempty"`
+
+	// Limits the number of photos to be retrieved. Values between 1—100 are
+	// accepted. Defaults to 100.
+	Limit int `json:"limit,omitempty"`
 }
 
 // GetUserProfilePhotos get a list of profile pictures for a user. Returns a UserProfilePhotos object.

kick_chat_member.go

@@ -7,8 +7,13 @@ type KickChatMemberParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// Unique identifier of the target user
+	UserID int `json:"user_id"`
+
+	// Date when the user will be unbanned, unix time. If user is banned for
+	// more than 366 days or less than 30 seconds from the current time they
+	// are considered to be banned forever
 	UntilDate int64 `json:"until_date"`
-	UserID    int   `json:"user_id"`
 }
 
 // KickChatMember kick a user from a group, a supergroup or a channel. In the case of supergroups and

methods_stickers.go

@@ -11,15 +11,28 @@ import (
 type (
 	// SendStickerParameters represents data for SetSticker method.
 	SendStickerParameters struct {
-		ChatID              int64       `json:"chat_id"`
-		Sticker             interface{} `json:"sticker"`
-		DisableNotification bool        `json:"disable_notification,omitempty"`
-		ReplyToMessageID    int         `json:"reply_to_message_id,omitempty"`
-		ReplyMarkup         interface{} `json:"reply_markup,omitempty"`
+		// Unique identifier for the target chat
+		ChatID int64 `json:"chat_id"`
+
+		// Sticker to send
+		Sticker interface{} `json:"sticker"`
+
+		// Sends the message silently. Users will receive a notification
+		// with no sound
+		DisableNotification bool `json:"disable_notification,omitempty"`
+
+		// If the message is a reply, ID of the original message
+		ReplyToMessageID int `json:"reply_to_message_id,omitempty"`
+
+		// Additional interface options. A JSON-serialized object for an
+		// inline keyboard, custom reply keyboard, instructions to remove
+		// reply keyboard or to force a reply from the user.
+		ReplyMarkup interface{} `json:"reply_markup,omitempty"`
 	}
 
 	// GetStickerSetParameters represents data for GetStickerSet method.
 	GetStickerSetParameters struct {
+		// Name of the sticker set
 		Name string `json:"name"`
 	}
 

pin_chat_message.go

@@ -7,7 +7,12 @@ type PinChatMessageParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
-	MessageID           int  `json:"message_id"`
+	// Identifier of a message to pin
+	MessageID int `json:"message_id"`
+
+	// Pass true, if it is not necessary to send a notification to all chat
+	// members about the new pinned message. Notifications are always
+	// disabled in channels.
 	DisableNotification bool `json:"disable_notification"`
 }
 

send_chat_action.go

@@ -7,6 +7,7 @@ type SendChatActionParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// Type of action to broadcast
 	Action string `json:"action"`
 }
 

set_chat_description.go

@@ -7,6 +7,7 @@ type SetChatDescriptionParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// New chat description, 0-255 characters
 	Description string `json:"description"`
 }
 

set_chat_photo.go

@@ -12,6 +12,7 @@ type SetChatPhotoParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// New chat photo, uploaded using multipart/form-data
 	ChatPhoto interface{} `json:"chat_photo"`
 }
 

set_chat_sticker_set.go

@@ -7,6 +7,7 @@ type SetChatStickerSetParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// Name of the sticker set to be set as the group sticker set
 	StickerSetName string `json:"sticker_set_name"`
 }
 

set_chat_title.go

@@ -7,6 +7,7 @@ type SetChatTitleParameters struct {
 	// Unique identifier for the target chat
 	ChatID int64 `json:"chat_id"`
 
+	// New chat title, 1-255 characters
 	Title string `json:"title"`
 }