opentofu/vendor/github.com/DreamItGetIT/statuscake/doc.go
Paul Hinze 6fe2703665 Vendor all dependencies w/ Godep
* Remove `make updatedeps` from Travis build. We'll follow up with more
   specific plans around dependency updating in subsequent PRs.
 * Update all `make` targets to set `GO15VENDOREXPERIMENT=1` and to
   filter out `/vendor/` from `./...` where appropriate.
 * Temporarily remove `vet` from the `make test` target until we can
   figure out how to get it to not vet `vendor/`. (Initial
   experimentation failed to yield the proper incantation.)

Everything is pinned to current master, with the exception of:

 * Azure/azure-sdk-for-go which is pinned before the breaking change today
 * aws/aws-sdk-go which is pinned to the most recent tag

The documentation still needs to be updated, which we can do in a follow
up PR. The goal here is to unblock release.
2016-01-29 15:08:48 -06:00

35 lines
770 B
Go

// Package statuscake implements a client for statuscake.com API.
//
// // list all `Tests`
// c, err := statuscake.New(statuscake.Auth{Username: username, Apikey: apikey})
// if err != nil {
// log.Fatal(err)
// }
//
// tests, err := c.Tests().All()
// if err != nil {
// log.Fatal(err)
// }
//
// // delete a `Test`
// err = c.Tests().Delete(TestID)
//
// // create a test
// t := &statuscake.Test{
// WebsiteName: "Foo",
// WebsiteURL: "htto://example.com",
// ... other required args...
// }
//
// if err = t.Validate(); err != nil {
// log.Fatal(err)
// }
//
// t2 := c.Tests().Update(t)
// fmt.Printf("New Test created with id: %d\n", t2.TestID)
//
// // get Tests details
// t, err := tt.Detail(id)
// ...
package statuscake