Skip to content

Commit

Permalink
standardise list descriptions (with rebase fix)
Browse files Browse the repository at this point in the history
  • Loading branch information
Integralist committed Nov 2, 2022
1 parent c4b80df commit 247cd12
Show file tree
Hide file tree
Showing 63 changed files with 75 additions and 76 deletions.
2 changes: 1 addition & 1 deletion fastly/acl.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions fastly/acl_entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 == "" {
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/backend.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/bigquery.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/blobstorage.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/cache_setting.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 == "" {
Expand Down
2 changes: 1 addition & 1 deletion fastly/cloudfiles.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/condition.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/custom_tls_activation.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion fastly/custom_tls_certificate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion fastly/custom_tls_configuration.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion fastly/custom_tls_domain.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion fastly/datadog.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/dictionary.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions fastly/dictionary_item.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/digitalocean.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/director.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/domain.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/elasticsearch.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/erl.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/ftp.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/gcs.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/gzip.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/header.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/health_check.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 == "" {
Expand Down
2 changes: 1 addition & 1 deletion fastly/heroku.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/honeycomb.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/https.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/kafka.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/kinesis.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/logentries.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/loggly.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/logshuttle.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/newrelic.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions fastly/object_store.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,15 +71,15 @@ 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
// Meta is the information for pagination
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"

Expand Down Expand Up @@ -230,15 +230,15 @@ 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
// Meta is the information for pagination
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
Expand Down
2 changes: 1 addition & 1 deletion fastly/openstack.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/papertrail.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion fastly/platform_tls.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down
2 changes: 1 addition & 1 deletion fastly/pool.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 247cd12

Please sign in to comment.