diff --git a/fastly/acl.go b/fastly/acl.go index 2b849e846..9a9c93ea2 100644 --- a/fastly/acl.go +++ b/fastly/acl.go @@ -44,7 +44,7 @@ type ListACLsInput struct { ServiceVersion int } -// ListACLs returns the list of ACLs for the configuration version. +// ListACLs retrieves all resources. func (c *Client) ListACLs(i *ListACLsInput) ([]*ACL, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/acl_entry.go b/fastly/acl_entry.go index 3d545af32..7da758849 100644 --- a/fastly/acl_entry.go +++ b/fastly/acl_entry.go @@ -52,7 +52,7 @@ type ListACLEntriesInput struct { Sort string } -// ListACLEntries return a list of entries for an ACL +// ListACLEntries retrieves all resources. // FIXME: The query parameters aren't being processed (e.g. Params: i.formatFilters()). func (c *Client) ListACLEntries(i *ListACLEntriesInput) ([]*ACLEntry, error) { if i.ServiceID == "" { @@ -81,7 +81,7 @@ func (c *Client) ListACLEntries(i *ListACLEntriesInput) ([]*ACLEntry, error) { return es, nil } -// ListACLEntriesPaginator implements PaginatorACLEntries. +// ListACLEntriesPaginator implements the PaginatorACLEntries interface. type ListACLEntriesPaginator struct { CurrentPage int LastPage int diff --git a/fastly/backend.go b/fastly/backend.go index b232950b0..df415fbec 100644 --- a/fastly/backend.go +++ b/fastly/backend.go @@ -67,7 +67,7 @@ type ListBackendsInput struct { ServiceVersion int } -// ListBackends returns the list of backends for the configuration version. +// ListBackends retrieves all resources. func (c *Client) ListBackends(i *ListBackendsInput) ([]*Backend, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/bigquery.go b/fastly/bigquery.go index e2ce9de53..2b41cd319 100644 --- a/fastly/bigquery.go +++ b/fastly/bigquery.go @@ -54,7 +54,7 @@ type ListBigQueriesInput struct { ServiceVersion int } -// ListBigQueries returns the list of BigQueries for the configuration version. +// ListBigQueries retrieves all resources. func (c *Client) ListBigQueries(i *ListBigQueriesInput) ([]*BigQuery, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/blobstorage.go b/fastly/blobstorage.go index 92816623d..1d64e2ec3 100644 --- a/fastly/blobstorage.go +++ b/fastly/blobstorage.go @@ -58,7 +58,7 @@ type ListBlobStoragesInput struct { ServiceVersion int } -// ListBlobStorages returns the list of blob storages for the configuration version. +// ListBlobStorages retrieves all resources. func (c *Client) ListBlobStorages(i *ListBlobStoragesInput) ([]*BlobStorage, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/cache_setting.go b/fastly/cache_setting.go index 10a8d2658..28c6de7c4 100644 --- a/fastly/cache_setting.go +++ b/fastly/cache_setting.go @@ -61,7 +61,7 @@ type ListCacheSettingsInput struct { ServiceVersion int } -// ListCacheSettings returns the list of cache settings for the configuration +// ListCacheSettings retrieves all resources. // version. func (c *Client) ListCacheSettings(i *ListCacheSettingsInput) ([]*CacheSetting, error) { if i.ServiceID == "" { diff --git a/fastly/cloudfiles.go b/fastly/cloudfiles.go index 1280b1cb8..69d99e48c 100644 --- a/fastly/cloudfiles.go +++ b/fastly/cloudfiles.go @@ -58,7 +58,7 @@ type ListCloudfilesInput struct { ServiceVersion int } -// ListCloudfiles returns the list of Cloudfiles for the configuration version. +// ListCloudfiles retrieves all resources. func (c *Client) ListCloudfiles(i *ListCloudfilesInput) ([]*Cloudfiles, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/condition.go b/fastly/condition.go index 54320998d..4eeb7d91a 100644 --- a/fastly/condition.go +++ b/fastly/condition.go @@ -47,7 +47,7 @@ type ListConditionsInput struct { ServiceVersion int } -// ListConditions returns the list of conditions for the configuration version. +// ListConditions retrieves all resources. func (c *Client) ListConditions(i *ListConditionsInput) ([]*Condition, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/custom_tls_activation.go b/fastly/custom_tls_activation.go index bd244df99..69c9268a3 100644 --- a/fastly/custom_tls_activation.go +++ b/fastly/custom_tls_activation.go @@ -56,7 +56,7 @@ func (i *ListTLSActivationsInput) formatFilters() map[string]string { return result } -// ListTLSActivations list all activations. +// ListTLSActivations retrieves all resources. func (c *Client) ListTLSActivations(i *ListTLSActivationsInput) ([]*TLSActivation, error) { p := "/tls/activations" filters := &RequestOptions{ diff --git a/fastly/custom_tls_certificate.go b/fastly/custom_tls_certificate.go index dce0cb83f..e16729755 100644 --- a/fastly/custom_tls_certificate.go +++ b/fastly/custom_tls_certificate.go @@ -63,7 +63,7 @@ func (i *ListCustomTLSCertificatesInput) formatFilters() map[string]string { return result } -// ListCustomTLSCertificates list all certificates. +// ListCustomTLSCertificates retrieves all resources. func (c *Client) ListCustomTLSCertificates(i *ListCustomTLSCertificatesInput) ([]*CustomTLSCertificate, error) { p := "/tls/certificates" filters := &RequestOptions{ diff --git a/fastly/custom_tls_configuration.go b/fastly/custom_tls_configuration.go index 170691b55..0be744374 100644 --- a/fastly/custom_tls_configuration.go +++ b/fastly/custom_tls_configuration.go @@ -63,7 +63,7 @@ func (i *ListCustomTLSConfigurationsInput) formatFilters() map[string]string { return result } -// ListCustomTLSConfigurations list all TLS configurations. +// ListCustomTLSConfigurations retrieves all resources. func (c *Client) ListCustomTLSConfigurations(i *ListCustomTLSConfigurationsInput) ([]*CustomTLSConfiguration, error) { p := "/tls/configurations" ro := &RequestOptions{ diff --git a/fastly/custom_tls_domain.go b/fastly/custom_tls_domain.go index 2efc05149..7948ee4f9 100644 --- a/fastly/custom_tls_domain.go +++ b/fastly/custom_tls_domain.go @@ -59,7 +59,7 @@ func (l *ListTLSDomainsInput) formatFilters() map[string]string { return result } -// ListTLSDomains retrieves a page of TLS domains. +// ListTLSDomains retrieves all resources. func (c *Client) ListTLSDomains(i *ListTLSDomainsInput) ([]*TLSDomain, error) { p := "/tls/domains" filters := &RequestOptions{ diff --git a/fastly/datadog.go b/fastly/datadog.go index 421589b49..364547779 100644 --- a/fastly/datadog.go +++ b/fastly/datadog.go @@ -50,7 +50,7 @@ type ListDatadogInput struct { ServiceVersion int } -// ListDatadog returns the list of Datadog for the configuration version. +// ListDatadog retrieves all resources. func (c *Client) ListDatadog(i *ListDatadogInput) ([]*Datadog, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/dictionary.go b/fastly/dictionary.go index 7f5e1c68e..1174be8bb 100644 --- a/fastly/dictionary.go +++ b/fastly/dictionary.go @@ -45,7 +45,7 @@ type ListDictionariesInput struct { ServiceVersion int } -// ListDictionaries returns the list of dictionaries for the configuration version. +// ListDictionaries retrieves all resources. func (c *Client) ListDictionaries(i *ListDictionariesInput) ([]*Dictionary, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/dictionary_item.go b/fastly/dictionary_item.go index d71e8eebd..a1b512328 100644 --- a/fastly/dictionary_item.go +++ b/fastly/dictionary_item.go @@ -51,7 +51,7 @@ type ListDictionaryItemsInput struct { Sort string } -// ListDictionaryItems returns a list of items for a dictionary +// ListDictionaryItems retrieves all resources. func (c *Client) ListDictionaryItems(i *ListDictionaryItemsInput) ([]*DictionaryItem, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID @@ -76,8 +76,7 @@ func (c *Client) ListDictionaryItems(i *ListDictionaryItemsInput) ([]*Dictionary return bs, nil } -// ListDictionaryItemsPaginator implements the PaginatorDictionaryItems -// interface. +// ListDictionaryItemsPaginator implements the PaginatorDictionaryItems interface. type ListDictionaryItemsPaginator struct { CurrentPage int LastPage int diff --git a/fastly/digitalocean.go b/fastly/digitalocean.go index c4028515a..f7f090891 100644 --- a/fastly/digitalocean.go +++ b/fastly/digitalocean.go @@ -58,7 +58,7 @@ type ListDigitalOceansInput struct { ServiceVersion int } -// ListDigitalOceans returns the list of DigitalOceans for the configuration version. +// ListDigitalOceans retrieves all resources. func (c *Client) ListDigitalOceans(i *ListDigitalOceansInput) ([]*DigitalOcean, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/director.go b/fastly/director.go index b9807daac..9cfaa2c33 100644 --- a/fastly/director.go +++ b/fastly/director.go @@ -67,7 +67,7 @@ type ListDirectorsInput struct { ServiceVersion int } -// ListDirectors returns the list of directors for the configuration version. +// ListDirectors retrieves all resources. func (c *Client) ListDirectors(i *ListDirectorsInput) ([]*Director, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/domain.go b/fastly/domain.go index 282540b16..be40473bc 100644 --- a/fastly/domain.go +++ b/fastly/domain.go @@ -46,7 +46,7 @@ type ListDomainsInput struct { ServiceVersion int } -// ListDomains returns the list of domains for this Service. +// ListDomains retrieves all resources. func (c *Client) ListDomains(i *ListDomainsInput) ([]*Domain, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/elasticsearch.go b/fastly/elasticsearch.go index 3ba0e296f..4a23cd8b8 100644 --- a/fastly/elasticsearch.go +++ b/fastly/elasticsearch.go @@ -58,7 +58,7 @@ type ListElasticsearchInput struct { ServiceVersion int } -// ListElasticsearch returns the list of Elasticsearch logs for the configuration version. +// ListElasticsearch retrieves all resources. func (c *Client) ListElasticsearch(i *ListElasticsearchInput) ([]*Elasticsearch, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/erl.go b/fastly/erl.go index 233c8319e..3b8d4ce20 100644 --- a/fastly/erl.go +++ b/fastly/erl.go @@ -153,7 +153,7 @@ type ListERLsInput struct { ServiceVersion int // required } -// ListERLs returns the list of ERLs for the specified service version. +// ListERLs retrieves all resources. func (c *Client) ListERLs(i *ListERLsInput) ([]*ERL, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/ftp.go b/fastly/ftp.go index 428789619..edaf2c6b9 100644 --- a/fastly/ftp.go +++ b/fastly/ftp.go @@ -58,7 +58,7 @@ type ListFTPsInput struct { ServiceVersion int } -// ListFTPs returns the list of ftps for the configuration version. +// ListFTPs retrieves all resources. func (c *Client) ListFTPs(i *ListFTPsInput) ([]*FTP, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/gcs.go b/fastly/gcs.go index c339731ca..abb8a6355 100644 --- a/fastly/gcs.go +++ b/fastly/gcs.go @@ -57,7 +57,7 @@ type ListGCSsInput struct { ServiceVersion int } -// ListGCSs returns the list of gcses for the configuration version. +// ListGCSs retrieves all resources. func (c *Client) ListGCSs(i *ListGCSsInput) ([]*GCS, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/gzip.go b/fastly/gzip.go index d1d5b38d7..8103eecab 100644 --- a/fastly/gzip.go +++ b/fastly/gzip.go @@ -46,7 +46,7 @@ type ListGzipsInput struct { ServiceVersion int } -// ListGzips returns the list of gzips for the configuration version. +// ListGzips retrieves all resources. func (c *Client) ListGzips(i *ListGzipsInput) ([]*Gzip, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/header.go b/fastly/header.go index f076c97cf..cacfcb154 100644 --- a/fastly/header.go +++ b/fastly/header.go @@ -109,7 +109,7 @@ type ListHeadersInput struct { ServiceVersion int } -// ListHeaders returns the list of headers for the configuration version. +// ListHeaders retrieves all resources. func (c *Client) ListHeaders(i *ListHeadersInput) ([]*Header, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/health_check.go b/fastly/health_check.go index 85574e5a0..456b46dcb 100644 --- a/fastly/health_check.go +++ b/fastly/health_check.go @@ -55,7 +55,7 @@ type ListHealthChecksInput struct { ServiceVersion int } -// ListHealthChecks returns the list of health checks for the configuration +// ListHealthChecks retrieves all resources. // version. func (c *Client) ListHealthChecks(i *ListHealthChecksInput) ([]*HealthCheck, error) { if i.ServiceID == "" { diff --git a/fastly/heroku.go b/fastly/heroku.go index 948f76ddd..af87bb91a 100644 --- a/fastly/heroku.go +++ b/fastly/heroku.go @@ -49,7 +49,7 @@ type ListHerokusInput struct { ServiceVersion int } -// ListHerokus returns the list of herokus for the configuration version. +// ListHerokus retrieves all resources. func (c *Client) ListHerokus(i *ListHerokusInput) ([]*Heroku, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/honeycomb.go b/fastly/honeycomb.go index 5e6ea8100..e43d09d11 100644 --- a/fastly/honeycomb.go +++ b/fastly/honeycomb.go @@ -49,7 +49,7 @@ type ListHoneycombsInput struct { ServiceVersion int } -// ListHoneycombs returns the list of honeycombs for the configuration version. +// ListHoneycombs retrieves all resources. func (c *Client) ListHoneycombs(i *ListHoneycombsInput) ([]*Honeycomb, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/https.go b/fastly/https.go index 72c9c944d..43400e523 100644 --- a/fastly/https.go +++ b/fastly/https.go @@ -60,7 +60,7 @@ type ListHTTPSInput struct { ServiceVersion int } -// ListHTTPS returns the list of HTTPS logs for the configuration version. +// ListHTTPS retrieves all resources. func (c *Client) ListHTTPS(i *ListHTTPSInput) ([]*HTTPS, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/kafka.go b/fastly/kafka.go index aa399366a..bea569e99 100644 --- a/fastly/kafka.go +++ b/fastly/kafka.go @@ -61,7 +61,7 @@ type ListKafkasInput struct { ServiceVersion int } -// ListKafkas returns the list of kafkas for the configuration version. +// ListKafkas retrieves all resources. func (c *Client) ListKafkas(i *ListKafkasInput) ([]*Kafka, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/kinesis.go b/fastly/kinesis.go index 693159f24..58d1d01ee 100644 --- a/fastly/kinesis.go +++ b/fastly/kinesis.go @@ -52,7 +52,7 @@ type ListKinesisInput struct { ServiceVersion int } -// ListKinesis returns the list of Kinesis for the configuration version. +// ListKinesis retrieves all resources. func (c *Client) ListKinesis(i *ListKinesisInput) ([]*Kinesis, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/logentries.go b/fastly/logentries.go index c1699dafd..12fc0278c 100644 --- a/fastly/logentries.go +++ b/fastly/logentries.go @@ -51,7 +51,7 @@ type ListLogentriesInput struct { ServiceVersion int } -// ListLogentries returns the list of logentries for the configuration version. +// ListLogentries retrieves all resources. func (c *Client) ListLogentries(i *ListLogentriesInput) ([]*Logentries, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/loggly.go b/fastly/loggly.go index 154ad5f6c..40612e96e 100644 --- a/fastly/loggly.go +++ b/fastly/loggly.go @@ -48,7 +48,7 @@ type ListLogglyInput struct { ServiceVersion int } -// ListLoggly returns the list of loggly for the configuration version. +// ListLoggly retrieves all resources. func (c *Client) ListLoggly(i *ListLogglyInput) ([]*Loggly, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/logshuttle.go b/fastly/logshuttle.go index 3f47e5bb8..3397f673f 100644 --- a/fastly/logshuttle.go +++ b/fastly/logshuttle.go @@ -49,7 +49,7 @@ type ListLogshuttlesInput struct { ServiceVersion int } -// ListLogshuttles returns the list of logshuttles for the configuration version. +// ListLogshuttles retrieves all resources. func (c *Client) ListLogshuttles(i *ListLogshuttlesInput) ([]*Logshuttle, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/newrelic.go b/fastly/newrelic.go index 548c57ab7..a646d9e0d 100644 --- a/fastly/newrelic.go +++ b/fastly/newrelic.go @@ -49,7 +49,7 @@ type ListNewRelicInput struct { ServiceVersion int } -// ListNewRelic returns the list of newrelic for the configuration version. +// ListNewRelic retrieves all resources. func (c *Client) ListNewRelic(i *ListNewRelicInput) ([]*NewRelic, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/object_store.go b/fastly/object_store.go index ecd0632d4..95e8874d2 100644 --- a/fastly/object_store.go +++ b/fastly/object_store.go @@ -71,7 +71,7 @@ func (l *ListObjectStoresInput) formatFilters() map[string]string { return m } -// ListObjectStoresResponse is the return type for the ListObjectStores function. +// ListObjectStoresResponse retrieves all resources. type ListObjectStoresResponse struct { // Data is the list of returned object stores Data []ObjectStore @@ -79,7 +79,7 @@ type ListObjectStoresResponse struct { Meta map[string]string } -// ListObjectStores lists the object stores for the current customer. +// ListObjectStores retrieves all resources. func (c *Client) ListObjectStores(i *ListObjectStoresInput) (*ListObjectStoresResponse, error) { const path = "/resources/stores/object" @@ -230,7 +230,7 @@ func (l *ListObjectStoreKeysInput) formatFilters() map[string]string { return m } -// ListObjectStoreKeysResponse is the response to the ListObjectStoreKeys function. +// ListObjectStoreKeysResponse retrieves all resources. type ListObjectStoreKeysResponse struct { // Data is the list of keys Data []string @@ -238,7 +238,7 @@ type ListObjectStoreKeysResponse struct { Meta map[string]string } -// ListObjectStoreKeys lists the keys for the given object store. +// ListObjectStoreKeys retrieves all resources. func (c *Client) ListObjectStoreKeys(i *ListObjectStoreKeysInput) (*ListObjectStoreKeysResponse, error) { if i.ID == "" { return nil, ErrMissingID diff --git a/fastly/openstack.go b/fastly/openstack.go index a6b159fd4..627550dff 100644 --- a/fastly/openstack.go +++ b/fastly/openstack.go @@ -58,7 +58,7 @@ type ListOpenstackInput struct { ServiceVersion int } -// ListOpenstack returns the list of Openstack for the configuration version. +// ListOpenstack retrieves all resources. func (c *Client) ListOpenstack(i *ListOpenstackInput) ([]*Openstack, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/papertrail.go b/fastly/papertrail.go index 21c14edbb..7b6d25a35 100644 --- a/fastly/papertrail.go +++ b/fastly/papertrail.go @@ -49,7 +49,7 @@ type ListPapertrailsInput struct { ServiceVersion int } -// ListPapertrails returns the list of papertrails for the configuration version. +// ListPapertrails retrieves all resources. func (c *Client) ListPapertrails(i *ListPapertrailsInput) ([]*Papertrail, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/platform_tls.go b/fastly/platform_tls.go index d27b44bd0..dc7284c02 100644 --- a/fastly/platform_tls.go +++ b/fastly/platform_tls.go @@ -68,7 +68,7 @@ func (i *ListBulkCertificatesInput) formatFilters() map[string]string { return result } -// ListBulkCertificates list all certificates. +// ListBulkCertificates retrieves all resources. func (c *Client) ListBulkCertificates(i *ListBulkCertificatesInput) ([]*BulkCertificate, error) { p := "/tls/bulk/certificates" filters := &RequestOptions{ diff --git a/fastly/pool.go b/fastly/pool.go index 0bcb0769b..cef4fe664 100644 --- a/fastly/pool.go +++ b/fastly/pool.go @@ -84,7 +84,7 @@ type ListPoolsInput struct { ServiceVersion int } -// ListPools lists all pools for a particular service and version. +// ListPools retrieves all resources. func (c *Client) ListPools(i *ListPoolsInput) ([]*Pool, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/pubsub.go b/fastly/pubsub.go index b3e26421d..17e00eddb 100644 --- a/fastly/pubsub.go +++ b/fastly/pubsub.go @@ -52,7 +52,7 @@ type ListPubsubsInput struct { ServiceVersion int } -// ListPubsubs returns the list of pubsubs for the configuration version. +// ListPubsubs retrieves all resources. func (c *Client) ListPubsubs(i *ListPubsubsInput) ([]*Pubsub, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/request_setting.go b/fastly/request_setting.go index 5f10ae112..b756ae755 100644 --- a/fastly/request_setting.go +++ b/fastly/request_setting.go @@ -87,7 +87,7 @@ type ListRequestSettingsInput struct { ServiceVersion int } -// ListRequestSettings returns the list of request settings for the +// ListRequestSettings retrieves all resources. // configuration version. func (c *Client) ListRequestSettings(i *ListRequestSettingsInput) ([]*RequestSetting, error) { if i.ServiceID == "" { diff --git a/fastly/response_object.go b/fastly/response_object.go index c1d3b5837..527fb6568 100644 --- a/fastly/response_object.go +++ b/fastly/response_object.go @@ -50,7 +50,7 @@ type ListResponseObjectsInput struct { ServiceVersion int } -// ListResponseObjects returns the list of response objects for the +// ListResponseObjects retrieves all resources. // configuration version. func (c *Client) ListResponseObjects(i *ListResponseObjectsInput) ([]*ResponseObject, error) { if i.ServiceID == "" { diff --git a/fastly/s3.go b/fastly/s3.go index 344e33e64..04ff00ae1 100644 --- a/fastly/s3.go +++ b/fastly/s3.go @@ -126,7 +126,7 @@ type ListS3sInput struct { ServiceVersion int } -// ListS3s returns the list of S3s for the configuration version. +// ListS3s retrieves all resources. func (c *Client) ListS3s(i *ListS3sInput) ([]*S3, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/scalyr.go b/fastly/scalyr.go index f41c3b634..ac702976d 100644 --- a/fastly/scalyr.go +++ b/fastly/scalyr.go @@ -49,7 +49,7 @@ type ListScalyrsInput struct { ServiceVersion int } -// ListScalyrs returns the list of scalyrs for the configuration version. +// ListScalyrs retrieves all resources. func (c *Client) ListScalyrs(i *ListScalyrsInput) ([]*Scalyr, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/secret_store.go b/fastly/secret_store.go index 03045ea69..2e9860483 100644 --- a/fastly/secret_store.go +++ b/fastly/secret_store.go @@ -86,7 +86,7 @@ type ListSecretStoresInput struct { Limit int } -// ListSecretStores returns a paginated list of Secret Stores. +// ListSecretStores retrieves all resources. // The returned next cursor, if non-blank, can be used as input to a subsequent // request for the next page of results. func (c *Client) ListSecretStores(i *ListSecretStoresInput) (*SecretStores, error) { @@ -266,7 +266,7 @@ type ListSecretsInput struct { Limit int } -// ListSecrets returns a list of Secrets for the given Secret Store. +// ListSecrets retrieves all resources. // The returned next cursor, if non-blank, can be used as input to a subsequent // request for the next page of results. func (c *Client) ListSecrets(i *ListSecretsInput) (*Secrets, error) { diff --git a/fastly/server.go b/fastly/server.go index 1314d5eff..b1ac3efe8 100644 --- a/fastly/server.go +++ b/fastly/server.go @@ -49,7 +49,7 @@ type ListServersInput struct { ServiceID string } -// ListServers lists all servers for a particular service and pool. +// ListServers retrieves all resources. func (c *Client) ListServers(i *ListServersInput) ([]*Server, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/service.go b/fastly/service.go index 2fd310ebc..f67f77b3c 100644 --- a/fastly/service.go +++ b/fastly/service.go @@ -80,7 +80,7 @@ type ListServicesInput struct { Sort string } -// ListServices returns the full list of services for the current account. +// ListServices retrieves all resources. // FIXME: input isn't used at all (e.g. Params: i.formatFilters()). func (c *Client) ListServices(i *ListServicesInput) ([]*Service, error) { resp, err := c.Get("/service", nil) @@ -388,7 +388,7 @@ type ListServiceDomainInput struct { ID string } -// ListServiceDomains lists all domains associated with a given service +// ListServiceDomains retrieves all resources. func (c *Client) ListServiceDomains(i *ListServiceDomainInput) (ServiceDomainsList, error) { if i.ID == "" { return nil, ErrMissingID diff --git a/fastly/sftp.go b/fastly/sftp.go index 8b24d4e70..a322da1da 100644 --- a/fastly/sftp.go +++ b/fastly/sftp.go @@ -60,7 +60,7 @@ type ListSFTPsInput struct { ServiceVersion int } -// ListSFTPs returns the list of sftps for the configuration version. +// ListSFTPs retrieves all resources. func (c *Client) ListSFTPs(i *ListSFTPsInput) ([]*SFTP, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/splunk.go b/fastly/splunk.go index 59698667e..300113cf4 100644 --- a/fastly/splunk.go +++ b/fastly/splunk.go @@ -56,7 +56,7 @@ type ListSplunksInput struct { ServiceVersion int } -// ListSplunks returns the list of splunks for the configuration version. +// ListSplunks retrieves all resources. func (c *Client) ListSplunks(i *ListSplunksInput) ([]*Splunk, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/sumologic.go b/fastly/sumologic.go index e8918a33d..2ff1c265c 100644 --- a/fastly/sumologic.go +++ b/fastly/sumologic.go @@ -50,7 +50,7 @@ type ListSumologicsInput struct { ServiceVersion int } -// ListSumologics returns the list of sumologics for the configuration version. +// ListSumologics retrieves all resources. func (c *Client) ListSumologics(i *ListSumologicsInput) ([]*Sumologic, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/syslog.go b/fastly/syslog.go index 7a0f60862..7aa01d60e 100644 --- a/fastly/syslog.go +++ b/fastly/syslog.go @@ -58,7 +58,7 @@ type ListSyslogsInput struct { ServiceVersion int } -// ListSyslogs returns the list of syslogs for the configuration version. +// ListSyslogs retrieves all resources. func (c *Client) ListSyslogs(i *ListSyslogsInput) ([]*Syslog, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/tls.go b/fastly/tls.go index 046121351..d1bf6516f 100644 --- a/fastly/tls.go +++ b/fastly/tls.go @@ -57,7 +57,7 @@ func (i *ListPrivateKeysInput) formatFilters() map[string]string { return result } -// ListPrivateKeys list all TLS private keys. +// ListPrivateKeys retrieves all resources. func (c *Client) ListPrivateKeys(i *ListPrivateKeysInput) ([]*PrivateKey, error) { p := "/tls/private_keys" filters := &RequestOptions{ diff --git a/fastly/tls_subscription.go b/fastly/tls_subscription.go index c0a4ec3b0..410377f66 100644 --- a/fastly/tls_subscription.go +++ b/fastly/tls_subscription.go @@ -105,7 +105,7 @@ func (s *ListTLSSubscriptionsInput) formatFilters() map[string]string { return result } -// ListTLSSubscriptions lists all managed TLS subscriptions +// ListTLSSubscriptions retrieves all resources. func (c *Client) ListTLSSubscriptions(i *ListTLSSubscriptionsInput) ([]*TLSSubscription, error) { resp, err := c.Get("/tls/subscriptions", &RequestOptions{ Params: i.formatFilters(), diff --git a/fastly/token.go b/fastly/token.go index 422a360bc..385e81071 100644 --- a/fastly/token.go +++ b/fastly/token.go @@ -54,7 +54,7 @@ func (s tokensByName) Less(i, j int) bool { return s[i].Name < s[j].Name } -// ListTokens returns the full list of tokens belonging to the currently +// ListTokens retrieves all resources. // authenticated user. func (c *Client) ListTokens() ([]*Token, error) { resp, err := c.Get("/tokens", nil) @@ -76,7 +76,7 @@ type ListCustomerTokensInput struct { CustomerID string } -// ListCustomerTokens returns the full list of tokens belonging to a specific +// ListCustomerTokens retrieves all resources. // customer. func (c *Client) ListCustomerTokens(i *ListCustomerTokensInput) ([]*Token, error) { if i.CustomerID == "" { diff --git a/fastly/user.go b/fastly/user.go index 9502d9623..f71c32562 100644 --- a/fastly/user.go +++ b/fastly/user.go @@ -48,7 +48,7 @@ type ListCustomerUsersInput struct { CustomerID string } -// ListCustomerUsers returns the full list of users belonging to a specific +// ListCustomerUsers retrieves all resources. // customer. func (c *Client) ListCustomerUsers(i *ListCustomerUsersInput) ([]*User, error) { if i.CustomerID == "" { diff --git a/fastly/vcl.go b/fastly/vcl.go index 09bea4fc6..5765ac125 100644 --- a/fastly/vcl.go +++ b/fastly/vcl.go @@ -45,7 +45,7 @@ type ListVCLsInput struct { ServiceVersion int } -// ListVCLs returns the list of VCLs for the configuration version. +// ListVCLs retrieves all resources. func (c *Client) ListVCLs(i *ListVCLsInput) ([]*VCL, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/vcl_snippets.go b/fastly/vcl_snippets.go index 39355a3b8..ce7973240 100644 --- a/fastly/vcl_snippets.go +++ b/fastly/vcl_snippets.go @@ -277,7 +277,7 @@ func (s snippetsByName) Less(i, j int) bool { return s[i].Name < s[j].Name } -// ListSnippets returns the list of Snippets for the configuration version. Content is not displayed for Dynmanic Snippets due to them being +// ListSnippets retrieves all resources. // versionless, use the GetDynamicSnippet function to show current content. func (c *Client) ListSnippets(i *ListSnippetsInput) ([]*Snippet, error) { if i.ServiceID == "" { diff --git a/fastly/version.go b/fastly/version.go index 2b26d6190..1a8b66ad5 100644 --- a/fastly/version.go +++ b/fastly/version.go @@ -46,7 +46,7 @@ type ListVersionsInput struct { ServiceID string } -// ListVersions returns the full list of all versions of the given service. +// ListVersions retrieves all resources. func (c *Client) ListVersions(i *ListVersionsInput) ([]*Version, error) { if i.ServiceID == "" { return nil, ErrMissingServiceID diff --git a/fastly/waf.go b/fastly/waf.go index a6db0f4c8..7455d028b 100644 --- a/fastly/waf.go +++ b/fastly/waf.go @@ -85,7 +85,7 @@ func (i *ListWAFsInput) formatFilters() map[string]string { return result } -// ListWAFs returns the list of wafs for the configuration version. +// ListWAFs retrieves all resources. func (c *Client) ListWAFs(i *ListWAFsInput) (*WAFResponse, error) { resp, err := c.Get("/waf/firewalls", &RequestOptions{ Params: i.formatFilters(), diff --git a/fastly/waf_active_rule.go b/fastly/waf_active_rule.go index 13dec449e..330435e60 100644 --- a/fastly/waf_active_rule.go +++ b/fastly/waf_active_rule.go @@ -79,7 +79,7 @@ func (i *ListWAFActiveRulesInput) formatFilters() map[string]string { return result } -// ListWAFActiveRules returns the list of active rules for a given WAF ID. +// ListWAFActiveRules retrieves all resources. func (c *Client) ListWAFActiveRules(i *ListWAFActiveRulesInput) (*WAFActiveRuleResponse, error) { if i.WAFID == "" { return nil, ErrMissingWAFID @@ -141,7 +141,7 @@ type ListAllWAFActiveRulesInput struct { WAFVersionNumber int } -// ListAllWAFActiveRules returns the complete list of WAF active rules for a given WAF ID. It iterates through +// ListAllWAFActiveRules retrieves all resources. // all existing pages to ensure all WAF active rules are returned at once. func (c *Client) ListAllWAFActiveRules(i *ListAllWAFActiveRulesInput) (*WAFActiveRuleResponse, error) { if i.WAFID == "" { diff --git a/fastly/waf_rule_exclusion.go b/fastly/waf_rule_exclusion.go index fc92d69a4..4735a17ea 100644 --- a/fastly/waf_rule_exclusion.go +++ b/fastly/waf_rule_exclusion.go @@ -141,7 +141,7 @@ func (i *ListWAFRuleExclusionsInput) formatFilters() map[string]string { return result } -// ListWAFRuleExclusions returns the list of exclusions for a given WAF ID. +// ListWAFRuleExclusions retrieves all resources. func (c *Client) ListWAFRuleExclusions(i *ListWAFRuleExclusionsInput) (*WAFRuleExclusionResponse, error) { if i.WAFID == "" { return nil, ErrMissingWAFID @@ -187,7 +187,7 @@ func (c *Client) ListWAFRuleExclusions(i *ListWAFRuleExclusionsInput) (*WAFRuleE }, nil } -// ListAllWAFRuleExclusions returns the complete list of WAF rule exclusions for a given WAF ID. It iterates through +// ListAllWAFRuleExclusions retrieves all resources. // all existing pages to ensure all WAF rule exclusions are returned at once. func (c *Client) ListAllWAFRuleExclusions(i *ListAllWAFRuleExclusionsInput) (*WAFRuleExclusionResponse, error) { if i.WAFID == "" { diff --git a/fastly/waf_rules.go b/fastly/waf_rules.go index 1cd92f1ab..d3be1844d 100644 --- a/fastly/waf_rules.go +++ b/fastly/waf_rules.go @@ -100,7 +100,7 @@ func (i *ListWAFRulesInput) formatFilters() map[string]string { return result } -// ListWAFRules returns the list of VAF versions for a given WAF ID. +// ListWAFRules retrieves all resources. func (c *Client) ListWAFRules(i *ListWAFRulesInput) (*WAFRuleResponse, error) { resp, err := c.Get("/waf/rules", &RequestOptions{ Params: i.formatFilters(), @@ -151,7 +151,7 @@ type ListAllWAFRulesInput struct { Include string } -// ListAllWAFRules returns the complete list of WAF rules for the given filters. It iterates through +// ListAllWAFRules retrieves all resources. // all existing pages to ensure all WAF rules are returned at once. func (c *Client) ListAllWAFRules(i *ListAllWAFRulesInput) (*WAFRuleResponse, error) { currentPage := 1 diff --git a/fastly/waf_version.go b/fastly/waf_version.go index 024297d8f..b0aa3e164 100644 --- a/fastly/waf_version.go +++ b/fastly/waf_version.go @@ -125,7 +125,7 @@ func (i *ListWAFVersionsInput) formatFilters() map[string]string { return result } -// ListWAFVersions returns the list of VAF versions for a given WAF ID. +// ListWAFVersions retrieves all resources. func (c *Client) ListWAFVersions(i *ListWAFVersionsInput) (*WAFVersionResponse, error) { if i.WAFID == "" { return nil, ErrMissingWAFID @@ -175,7 +175,7 @@ type ListAllWAFVersionsInput struct { WAFID string } -// ListAllWAFVersions returns the complete list of WAF versions for a given WAF ID. It iterates through +// ListAllWAFVersions retrieves all resources. // all existing pages to ensure all WAF versions are returned at once. func (c *Client) ListAllWAFVersions(i *ListAllWAFVersionsInput) (*WAFVersionResponse, error) { if i.WAFID == "" {