add godoc comment to exported structs

Author: mdb

dashboard.go

@@ -14,6 +14,7 @@ type DashboardMeta struct {
 	Folder    int64  `json:"folderId"`
 }
 
+// DashboardSaveResponse represents the Grafana API response to creating or saving a dashboard.
 type DashboardSaveResponse struct {
 	Slug    string `json:"slug"`
 	Id      int64  `json:"id"`
@@ -22,6 +23,7 @@ type DashboardSaveResponse struct {
 	Version int64  `json:"version"`
 }
 
+// DashboardSearchResponse represents the Grafana API dashboard search response.
 type DashboardSearchResponse struct {
 	Id          uint     `json:"id"`
 	Uid         string   `json:"uid"`
@@ -38,6 +40,7 @@ type DashboardSearchResponse struct {
 	FolderUrl   string   `json:"folderUrl"`
 }
 
+// Dashboard represents a Grafana dashboard.
 type Dashboard struct {
 	Meta      DashboardMeta          `json:"meta"`
 	Model     map[string]interface{} `json:"dashboard"`

datasource.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 )
 
+// DataSource represents a Grafana data source.
 type DataSource struct {
 	Id     int64  `json:"id,omitempty"`
 	Name   string `json:"name"`

folder.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 )
 
+// Folder represents a Grafana folder.
 type Folder struct {
 	Id    int64  `json:"id"`
 	Uid   string `json:"uid"`

folder_permissions.go

@@ -27,10 +27,12 @@ type FolderPermission struct {
 	DashboardId int64 `json:"dashboardId,omitempty"`
 }
 
+// PermissionItems represents Grafana folder permission items.
 type PermissionItems struct {
 	Items []*PermissionItem `json:"items"`
 }
 
+// PermissionItem represents a Grafana folder permission item.
 type PermissionItem struct {
 	// As you can see the docs, each item has a pair of [Role|TeamId|UserId] and Permission.
 	// unnecessary fields are omitted.

org_users.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 )
 
+// OrgUser represents a Grafana org user.
 type OrgUser struct {
 	OrgId  int64  `json:"orgId"`
 	UserId int64  `json:"userId"`

orgs.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 )
 
+// Org represents a Grafana org.
 type Org struct {
 	Id   int64  `json:"id"`
 	Name string `json:"name"`

playlist.go

@@ -6,13 +6,15 @@ import (
 	"fmt"
 )
 
+// PlaylistItem represents a Grafana playlist item.
 type PlaylistItem struct {
 	Type  string `json:"type"`
 	Value string `json:"value"`
 	Order int    `json:"order"`
 	Title string `json:"title"`
 }
 
+// PlaylistItem represents a Grafana playlist.
 type Playlist struct {
 	Id       int            `json:"id"`
 	Name     string         `json:"name"`

team.go

@@ -7,6 +7,7 @@ import (
 	"net/url"
 )
 
+// SearchTeam represents a search for a Grafana team.
 type SearchTeam struct {
 	TotalCount int64   `json:"totalCount,omitempty"`
 	Teams      []*Team `json:"teams,omitempty"`
@@ -26,7 +27,7 @@ type Team struct {
 	Permission  int64  `json:"permission,omitempty"`
 }
 
-// TeamMember
+// TeamMember represents a Grafana team member.
 type TeamMember struct {
 	OrgId      int64  `json:"orgId,omitempty"`
 	TeamId     int64  `json:"teamId,omitempty"`
@@ -37,6 +38,7 @@ type TeamMember struct {
 	Permission int64  `json:"permission,omitempty"`
 }
 
+// Preferences represents Grafana preferences.
 type Preferences struct {
 	Theme           string `json:"theme"`
 	HomeDashboardId int64  `json:"homeDashboardId"`

user.go

@@ -4,6 +4,7 @@ import (
 	"net/url"
 )
 
+// User represents a Grafana user.
 type User struct {
 	Id       int64  `json:"id,omitempty"`
 	Email    string `json:"email,omitempty"`