lint: add docs, lint

Author: trinchan

README.md

@@ -1,7 +1,7 @@
 # sysdig-go #
 
 [![sysdig-go release](https://img.shields.io/github/v/release/trinchan/sysdig-go?sort=semver)](https://github.com/trinchan/sysdig-go/releases)
-[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/trinchan/sysdig-go/github)
+[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/trinchan/sysdig-go/sysdig)
 [![Test Status](https://github.com/trinchan/sysdig-go/workflows/tests/badge.svg)](https://github.com/trinchan/sysdig-go/actions?query=workflow%3Atests)
 [![Test Coverage](https://codecov.io/gh/trinchan/sysdig-go/branch/main/graph/badge.svg)](https://codecov.io/gh/trinchan/sysdig-go)
 
@@ -20,19 +20,19 @@ will resolve and add the package to the current development module, along with i
 Alternatively the same can be achieved if you use import in a package:
 
 ```go
-import "github.com/trinchan/sysdig-go/github"
+import "github.com/trinchan/sysdig-go/sysdig"
 ```
 
 and run `go get` without parameters.
 
 ## Implemented APIs ##
 |       Base              | Get | List | Create | Delete | Update | Other                   | Service                       | Description |
 |:-----------------------:|:---:|:----:|:------:|:------:|:------:|:-----------------------:|:-----------------------------:|-------------|
-| `/team`                 |✓    |✓     |x       |✓       |x       |ListUsers, Infrastructure| `client.Teams`                |Information about teams, users, and usage |
-| `/user/me`              |✓    |x     |x       |x       |x       |x                        | `client.Users`                |Information about the current user |
-| `/token`                |✓    |x     |x       |x       |x       |x                        | `client.Users`                |Retrieves the current user's access token |
-| `/agents/connected`     |✓    |x     |x       |x       |x       |x                        | `client.Users`                |Rerieves the connected Agents for a user
-| `/alerts`               |✓    |✓     |✓       |x       |x       |x                        | `client.Alerts`               |Manage alert configurations |
+| `/team`                 |✓    |✓     |x       |✓       |x       |ListUsers, Infrastructure| `client.Teams`                |[Information about teams, users, and usage](https://docs.sysdig.com/en/docs/administration/administration-settings/user-and-team-administration/manage-teams-and-roles/) |
+| `/user/me`              |✓    |x     |x       |x       |x       |x                        | `client.Users`                |[Information about the current user](https://docs.sysdig.com/en/docs/administration/administration-settings/find-your-customer-id-and-name/) |
+| `/token`                |✓    |x     |x       |x       |x       |x                        | `client.Users`                |[Retrieves the current user's access token](https://docs.sysdig.com/en/docs/administration/administration-settings/find-your-customer-id-and-name/) |
+| `/agents/connected`     |✓    |x     |x       |x       |x       |x                        | `client.Users`                |[Rerieves the connected Agents](https://docs.sysdig.com/en/docs/sysdig-monitor/)
+| `/alerts`               |✓    |✓     |✓       |x       |x       |x                        | `client.Alerts`               |[Manage alert configurations](https://docs.sysdig.com/en/docs/sysdig-monitor/alerts/manage-alerts/) |
 | `/v3/dashboards`        |✓    |✓     |✓       |✓       |✓       |Favorite, Transfer       | `client.Dashboards`           |Manage dashboard configurations |
 | `/v2/events`            |✓    |✓     |✓       |✓       |x       |x                        | `client.Events`               |Manage event notifications |
 | `/notificationChannels` |✓    |✓     |✓       |✓       |x       |x                        | `client.NotificationChannels` |Manage notification channels |
@@ -214,13 +214,7 @@ The Sysdig API (and this client) supports [gzip](https://docs.sysdig.com/en/docs
 sysdig.NewClient(sysdig.WithResponseCompression(true))
 ```
 
-For other options, check the [documentation](https://pkg.go.dev/github.com/trinchan/sysdig-go/github).
-
-## Versioning ##
-
-`sysdig-go` is currently undergoing its initial development and is still incomplete. As new APIs are documented by Sysdig and IBM Cloud, new
-APIs will be added or changed. Since `sysdig-go` is a client library, breaking changes in the upstream API may require updates to the client.
-`sysdig-go` will follow semver as closely as possible to minimize breaking changes.
+For other options, check the [documentation](https://pkg.go.dev/github.com/trinchan/sysdig-go/sysdig).
 
 ## FAQ ##
 
@@ -233,10 +227,20 @@ you can also use the `client.Do()` method to send a custom request.
 
 That's not a question! The client is incomplete as documentation for most of the Sysdig API has not been published. I have had to leave some types as `interface{}` until documentation is released or I receive a sample response. Submit an issue and include the (redacted) client logs with `Debug` mode enabled.
 
+### "The documentation is wrong!" ###
+
+Since there is no official documentation for most of the API, some documentation is bound to be incorrect. Corrections and improvements
+are very welcome -- please file an issue or submit a patch if you find something is inaccurate.
+
 ### "Is this an official client?" ###
 
 Nope. The only official client I know is the [Python SDK](https://github.com/sysdiglabs/sysdig-sdk-python).
 
+## Versioning ##
+
+`sysdig-go` is currently undergoing its initial development and is still incomplete. As new APIs are documented by Sysdig and IBM Cloud, new
+APIs will be added or changed. Since `sysdig-go` is a client library, breaking changes in the upstream API may require updates to the client.
+`sysdig-go` will follow semver as closely as possible to minimize breaking changes.
 
 ## Credits ##
 - Sysdig's [Python SDK](https://github.com/sysdiglabs/sysdig-sdk-python) for API reference.
@@ -246,3 +250,6 @@ Nope. The only official client I know is the [Python SDK](https://github.com/sys
 
 This library is distributed under the MIT license found in the [LICENSE](./LICENSE)
 file.
+
+---
+_"Sysdig" and "IBM Cloud" are registered trademarks of their respective holders. Use of the name does not imply any affiliation with or endorsement by them._

sysdig/alerts.go

@@ -9,13 +9,17 @@ import (
 // AlertService is the Service for communicating with the Sysdig Monitor Alert related API.
 type AlertService service
 
+// AlertType defines the types of Alerts.
 type AlertType string
 
 const (
 	// AlertTypeEvent means the Alert is from an Event.
 	AlertTypeEvent AlertType = "EVENT"
+	// TODO: There must be others.
 )
 
+// Alert defines a Sysdig Alert.
+// See: https://docs.sysdig.com/en/docs/sysdig-monitor/alerts/manage-alerts/
 type Alert struct {
 	ID                 int                     `json:"id,omitempty"`
 	Version            int                     `json:"version,omitempty"`
@@ -44,20 +48,23 @@ type Alert struct {
 	CustomerID     int           `json:"customerId"`
 }
 
+// AlertCustomNotification is the structure for a Custom Notification on an Alert.
 type AlertCustomNotification struct {
 	TitleTemplate  string `json:"titleTemplate"`
 	UseNewTemplate bool   `json:"useNewTemplate"`
 }
 
+// AlertCriteria defines the Criteria for an Alert.
+// TODO: What are the format of the unknown fields?
 type AlertCriteria struct {
-	Text string `json:"text"`
-	// TODO what are the format of these?
+	Text     string      `json:"text"`
 	Source   interface{} `json:"source"`
 	Severity interface{} `json:"severity"`
 	Query    interface{} `json:"query"`
 	Scope    interface{} `json:"scope"`
 }
 
+// AlertResponse is a container for an Alert returned by the Sysdig API.
 type AlertResponse struct {
 	Alert Alert `json:"alert"`
 }

sysdig/dashboards.go

@@ -9,6 +9,8 @@ import (
 // DashboardService is the Service for communicating with the Sysdig Monitor Dashboard related API.
 type DashboardService service
 
+// Dashboard is the structure for a Sysdig Dashboard.
+// See: https://docs.sysdig.com/en/docs/sysdig-monitor/dashboards/
 type Dashboard struct {
 	ID                   int                  `json:"id,omitempty"`
 	TeamID               int                  `json:"teamId"`
@@ -33,17 +35,19 @@ type Dashboard struct {
 	ScopeExpressionList  []ScopeExpression    `json:"scopeExpressionList,omitempty"`
 }
 
-type DashboardResponse struct {
-	Dashboard Dashboard `json:"dashboard"`
-}
-
+// NewDashboard constructs an empty Dashboard with the given name.
 func NewDashboard(name string) *Dashboard {
 	return &Dashboard{
 		Name:   name,
 		Schema: 3,
 	}
 }
 
+// DashboardResponse is a container for a Dashboard returned by the DashboardService API.
+type DashboardResponse struct {
+	Dashboard Dashboard `json:"dashboard"`
+}
+
 // Get retrieves a Dashboard.
 func (s *DashboardService) Get(ctx context.Context, dashboardID int) (*DashboardResponse, *http.Response, error) {
 	u := fmt.Sprintf("api/v3/dashboards/%d", dashboardID)
@@ -56,6 +60,7 @@ func (s *DashboardService) Get(ctx context.Context, dashboardID int) (*Dashboard
 	return c, resp, err
 }
 
+// ListDashboardsResponse is a container for Dashboards returned by the DashboardService.List API.
 type ListDashboardsResponse struct {
 	Dashboards []Dashboard `json:"dashboards"`
 }
@@ -72,6 +77,7 @@ func (s *DashboardService) List(ctx context.Context) (*ListDashboardsResponse, *
 	return c, resp, err
 }
 
+// Create creates a new Dashboard.
 func (s *DashboardService) Create(ctx context.Context, dashboard Dashboard) (*DashboardResponse, *http.Response, error) {
 	type dashboardRequest struct {
 		Dashboard Dashboard `json:"dashboard"`
@@ -135,10 +141,12 @@ func (s *DashboardService) Favorite(ctx context.Context, id int, favorite bool)
 	return c, resp, err
 }
 
+// DashboardTransferResponse is a container for a DashboardTransferResults for the DashboardService.Transfer API.
 type DashboardTransferResponse struct {
 	Results DashboardTransferResults `json:"results"`
 }
 
+// DashboardTransferResults is the response structure for the DashboardService.Transfer API.
 type DashboardTransferResults struct {
 	ID              int              `json:"id"`
 	Name            string           `json:"name"`
@@ -182,18 +190,21 @@ func (s *DashboardService) Transfer(
 	return c, resp, err
 }
 
+// SharingSetting defines a sharing setting for a Dashboard.
 type SharingSetting struct {
 	Role   string        `json:"role"`
 	Member SharingMember `json:"member"`
 }
 
+// SharingMember defines a sharing member for a Dashboard.
 type SharingMember struct {
 	Type      string `json:"type"`
 	ID        int    `json:"id"`
 	Name      string `json:"name"`
 	TeamTheme string `json:"teamTheme"`
 }
 
+// ScopeExpression is a scope expression used in a Dashboard.
 type ScopeExpression struct {
 	Operand     string   `json:"operand"`
 	Operator    string   `json:"operator"`
@@ -204,6 +215,7 @@ type ScopeExpression struct {
 	IsVariable  bool     `json:"isVariable"`
 }
 
+// Layout defines the Layout of Panels a Dashboard.
 type Layout struct {
 	PanelID int `json:"panelId"`
 	X       int `json:"x"`
@@ -212,6 +224,7 @@ type Layout struct {
 	H       int `json:"h"`
 }
 
+// Panel is the structure of a Panel in a Dashboard.
 type Panel struct {
 	ID                     int                 `json:"id"`
 	Type                   string              `json:"type"`
@@ -230,6 +243,7 @@ type Panel struct {
 	TextAutosized          bool                `json:"textAutosized,omitempty"`
 }
 
+// BasicQuery is a basic query type used in a Dashboard.
 type BasicQuery struct {
 	Enabled      bool                   `json:"enabled"`
 	DisplayInfo  BasicQueryDisplayInfo  `json:"displayInfo"`
@@ -240,17 +254,20 @@ type BasicQuery struct {
 	Segmentation BasicQuerySegmentation `json:"segmentation,omitempty"`
 }
 
+// BasicQueryCompareTo is used in a BasicQuery on a Dashboard.
 type BasicQueryCompareTo struct {
 	Enabled    bool   `json:"enabled"`
 	Delta      int    `json:"delta"`
 	TimeFormat string `json:"timeFormat"`
 }
 
+// BasicQueryScope is a scope used in a BasicQuery on a Dashboard.
 type BasicQueryScope struct {
 	Expressions           []string `json:"expressions"`
 	ExtendsDashboardScope bool     `json:"extendsDashboardScope"`
 }
 
+// BasicQueryMetric is a metric used in a BasicQuery on a Dashboard.
 type BasicQueryMetric struct {
 	ID               string      `json:"id"`
 	TimeAggregation  string      `json:"timeAggregation"`
@@ -259,12 +276,14 @@ type BasicQueryMetric struct {
 	Sorting          interface{} `json:"sorting"`
 }
 
+// BasicQueryDisplayInfo is the display info used in a BasicQuery on a Dashboard.
 type BasicQueryDisplayInfo struct {
 	DisplayName                   string `json:"displayName"`
 	TimeSeriesDisplayNameTemplate string `json:"timeSeriesDisplayNameTemplate"`
 	Type                          string `json:"type"`
 }
 
+// BasicQueryFormat is the metric format used in a BasicQuery on a Dashboard.
 type BasicQueryFormat struct {
 	Unit                 string `json:"unit"`
 	InputFormat          string `json:"inputFormat"`
@@ -274,37 +293,43 @@ type BasicQueryFormat struct {
 	NullValueDisplayMode string `json:"nullValueDisplayMode"`
 }
 
+// BasicQuerySegmentation is the segmentation used in a BasicQuery on a Dashboard.
 type BasicQuerySegmentation struct {
 	Labels    []BasicQuerySegmentationLabel `json:"labels"`
 	Limit     int                           `json:"limit"`
 	Direction string                        `json:"direction"`
 }
 
+// BasicQuerySegmentationLabel is a segmentation label used in a BasicQuerySegmentation of a BasicQuery on a Dashboard.
 type BasicQuerySegmentationLabel struct {
 	ID          string  `json:"id"`
 	Descriptor  *string `json:"descriptor,omitempty"`
 	DisplayName *string `json:"displayName,omitempty"`
 	Sorting     *string `json:"sorting,omitempty"`
 }
 
+// Thresholds are the threshold for a Panel on a Dashboard.
 type Thresholds struct {
 	Values      []ThresholdValue `json:"values"`
 	Base        ThresholdBase    `json:"base"`
 	UseDefaults *bool            `json:"useDefaults"`
 }
 
+// ThresholdValue is a threshold value for a Thresholds on a Panel in a Dashboard.
 type ThresholdValue struct {
 	Severity    string  `json:"severity"`
 	Value       float64 `json:"value"`
 	InputFormat string  `json:"inputFormat"`
 	DisplayText string  `json:"displayText"`
 }
 
+// ThresholdBase is a threshold base for a Thresholds on a Panel in a Dashboard.
 type ThresholdBase struct {
 	Severity    string `json:"severity"`
 	DisplayText string `json:"displayText"`
 }
 
+// LegendConfiguration is the configuration for a legend on a Panel in a Dashboard.
 type LegendConfiguration struct {
 	Enabled     bool     `json:"enabled"`
 	Position    string   `json:"position"`
@@ -314,6 +339,7 @@ type LegendConfiguration struct {
 	Height      *float64 `json:"height"`
 }
 
+// AxesConfiguration is the configuration for the axes of a Panel in a Dashboard.
 type AxesConfiguration struct {
 	Bottom struct {
 		Enabled bool `json:"enabled"`
@@ -322,6 +348,7 @@ type AxesConfiguration struct {
 	Right Axis `json:"right"`
 }
 
+// Axis is an axis configuration used in an AxesConfiguration for the axes of a Panel in a Dashboard.
 type Axis struct {
 	Enabled        bool        `json:"enabled"`
 	DisplayName    *string     `json:"displayName"`
@@ -335,11 +362,13 @@ type Axis struct {
 	Scale          string      `json:"scale"`
 }
 
+// EventDisplaySettings are the event display settings for a Dashboard.
 type EventDisplaySettings struct {
 	Enabled     bool                            `json:"enabled"`
 	QueryParams EventDisplaySettingsQueryParams `json:"queryParams"`
 }
 
+// EventDisplaySettingsQueryParams are the query parameters used in an EventDisplaySettings for a Dashboard.
 type EventDisplaySettingsQueryParams struct {
 	Severities    []Severity `json:"severities"`
 	AlertStatuses []Status   `json:"alertStatuses"`

sysdig/sysdig_test.go

@@ -25,7 +25,8 @@ const (
 // setup sets up a test HTTP server along with a sysdig.Client that is
 // configured to talk to that test server. Tests should register handlers on
 // mux which provide mock responses for the API method being tested.
-func setup(authenticator authentication.Authenticator, options ...ClientOption) (client *Client, mux *http.ServeMux, serverURL string, teardown func()) {
+func setup(authenticator authentication.Authenticator) (
+	client *Client, mux *http.ServeMux, serverURL string, teardown func()) {
 	// mux is the HTTP request multiplexer used with the test server.
 	mux = http.NewServeMux()
 
@@ -48,9 +49,6 @@ func setup(authenticator authentication.Authenticator, options ...ClientOption)
 	// client is the Sysdig client being tested and is
 	// configured to use test server.
 	client, _ = NewClient(authenticator, WithDebug(true))
-	for _, o := range options {
-		_ = o(client)
-	}
 	url, _ := url.Parse(server.URL + baseURLPath + "/")
 	client.BaseURL = url