Skip to content

Commit

Permalink
standardise update descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
Integralist committed Nov 2, 2022
1 parent 247cd12 commit a508562
Show file tree
Hide file tree
Showing 56 changed files with 57 additions and 57 deletions.
2 changes: 1 addition & 1 deletion fastly/acl.go
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ type UpdateACLInput struct {
ServiceVersion int
}

// UpdateACL updates the specified ACL.
// UpdateACL updates the specified resource.
func (c *Client) UpdateACL(i *UpdateACLInput) (*ACL, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/acl_entry.go
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ type UpdateACLEntryInput struct {
Subnet *int `url:"subnet,omitempty"`
}

// UpdateACLEntry updates an ACL entry
// UpdateACLEntry updates the specified resource.
func (c *Client) UpdateACLEntry(i *UpdateACLEntryInput) (*ACLEntry, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/backend.go
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ type UpdateBackendInput struct {
Weight *uint `url:"weight,omitempty"`
}

// UpdateBackend updates a specific backend.
// UpdateBackend updates the specified resource.
func (c *Client) UpdateBackend(i *UpdateBackendInput) (*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 @@ -183,7 +183,7 @@ type UpdateBigQueryInput struct {
User *string `url:"user,omitempty"`
}

// UpdateBigQuery updates a specific BigQuery.
// UpdateBigQuery updates the specified resource.
func (c *Client) UpdateBigQuery(i *UpdateBigQueryInput) (*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 @@ -195,7 +195,7 @@ type UpdateBlobStorageInput struct {
TimestampFormat *string `url:"timestamp_format,omitempty"`
}

// UpdateBlobStorage updates a specific blob storage.
// UpdateBlobStorage updates the specified resource.
func (c *Client) UpdateBlobStorage(i *UpdateBlobStorageInput) (*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 @@ -178,7 +178,7 @@ type UpdateCacheSettingInput struct {
TTL *uint `url:"ttl,omitempty"`
}

// UpdateCacheSetting updates a specific cache setting.
// UpdateCacheSetting updates the specified resource.
func (c *Client) UpdateCacheSetting(i *UpdateCacheSettingInput) (*CacheSetting, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/cloudfiles.go
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ type UpdateCloudfilesInput struct {
User *string `url:"user,omitempty"`
}

// UpdateCloudfiles updates a specific Cloudfiles.
// UpdateCloudfiles updates the specified resource.
func (c *Client) UpdateCloudfiles(i *UpdateCloudfilesInput) (*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 @@ -160,7 +160,7 @@ type UpdateConditionInput struct {
Type *string `url:"type,omitempty"`
}

// UpdateCondition updates a specific condition.
// UpdateCondition updates the specified resource.
func (c *Client) UpdateCondition(i *UpdateConditionInput) (*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 @@ -163,7 +163,7 @@ type UpdateTLSActivationInput struct {
ID string `jsonapi:"primary,tls_activation"`
}

// UpdateTLSActivation updates the certificate used to terminate TLS traffic for the domain associated with this TLS activation.
// UpdateTLSActivation updates the specified resource.
func (c *Client) UpdateTLSActivation(i *UpdateTLSActivationInput) (*TLSActivation, error) {
if i.ID == "" {
return nil, ErrMissingID
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 @@ -156,7 +156,7 @@ type UpdateCustomTLSCertificateInput struct {
Name string `jsonapi:"attr,name,omitempty"`
}

// UpdateCustomTLSCertificate replace a certificate with a newly reissued certificate.
// UpdateCustomTLSCertificate updates the specified resource.
// By using this endpoint, the original certificate will cease to be used for future TLS handshakes.
// Thus, only SAN entries that appear in the replacement certificate will become TLS enabled.
// Any SAN entries that are missing in the replacement certificate will become disabled.
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 @@ -138,7 +138,7 @@ type UpdateCustomTLSConfigurationInput struct {
Name string `jsonapi:"attr,name"`
}

// UpdateCustomTLSConfiguration can only be used to change the name of the configuration
// UpdateCustomTLSConfiguration updates the specified resource.
func (c *Client) UpdateCustomTLSConfiguration(i *UpdateCustomTLSConfigurationInput) (*CustomTLSConfiguration, error) {
if i.ID == "" {
return nil, ErrMissingID
Expand Down
2 changes: 1 addition & 1 deletion fastly/datadog.go
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ type UpdateDatadogInput struct {
Token *string `url:"token,omitempty"`
}

// UpdateDatadog updates a Datadog logging endpoint on a Fastly service version.
// UpdateDatadog updates the specified resource.
func (c *Client) UpdateDatadog(i *UpdateDatadogInput) (*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 @@ -154,7 +154,7 @@ type UpdateDictionaryInput struct {
WriteOnly *Compatibool `url:"write_only,omitempty"`
}

// UpdateDictionary updates a specific dictionary.
// UpdateDictionary updates the specified resource.
func (c *Client) UpdateDictionary(i *UpdateDictionaryInput) (*Dictionary, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/dictionary_item.go
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ type UpdateDictionaryItemInput struct {
ServiceID string
}

// UpdateDictionaryItem updates a specific dictionary item.
// UpdateDictionaryItem updates the specified resource.
func (c *Client) UpdateDictionaryItem(i *UpdateDictionaryItemInput) (*DictionaryItem, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/digitalocean.go
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ type UpdateDigitalOceanInput struct {
TimestampFormat *string `url:"timestamp_format,omitempty"`
}

// UpdateDigitalOcean updates a specific DigitalOcean.
// UpdateDigitalOcean updates the specified resource.
func (c *Client) UpdateDigitalOcean(i *UpdateDigitalOceanInput) (*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 @@ -186,7 +186,7 @@ type UpdateDirectorInput struct {
Type DirectorType `url:"type,omitempty"`
}

// UpdateDirector updates a specific director.
// UpdateDirector updates the specified resource.
func (c *Client) UpdateDirector(i *UpdateDirectorInput) (*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 @@ -159,7 +159,7 @@ type UpdateDomainInput struct {
ServiceVersion int
}

// UpdateDomain updates a single domain for the current service. The only allowed
// UpdateDomain updates the specified resource.
// parameters are `Name` and `Comment`.
func (c *Client) UpdateDomain(i *UpdateDomainInput) (*Domain, error) {
if i.ServiceID == "" {
Expand Down
2 changes: 1 addition & 1 deletion fastly/ftp.go
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ type UpdateFTPInput struct {
Username *string `url:"user,omitempty"`
}

// UpdateFTP updates a specific FTP.
// UpdateFTP updates the specified resource.
func (c *Client) UpdateFTP(i *UpdateFTPInput) (*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 @@ -191,7 +191,7 @@ type UpdateGCSInput struct {
User *string `url:"user,omitempty"`
}

// UpdateGCS updates a specific GCS.
// UpdateGCS updates the specified resource.
func (c *Client) UpdateGCS(i *UpdateGCSInput) (*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 @@ -159,7 +159,7 @@ type UpdateGzipInput struct {
ServiceVersion int
}

// UpdateGzip updates a specific Gzip.
// UpdateGzip updates the specified resource.
func (c *Client) UpdateGzip(i *UpdateGzipInput) (*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 @@ -237,7 +237,7 @@ type UpdateHeaderInput struct {
Type *HeaderType `url:"type,omitempty"`
}

// UpdateHeader updates a specific header.
// UpdateHeader updates the specified resource.
func (c *Client) UpdateHeader(i *UpdateHeaderInput) (*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 @@ -189,7 +189,7 @@ type UpdateHealthCheckInput struct {
Window *uint `url:"window,omitempty"`
}

// UpdateHealthCheck updates a specific health check.
// UpdateHealthCheck updates the specified resource.
func (c *Client) UpdateHealthCheck(i *UpdateHealthCheckInput) (*HealthCheck, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/heroku.go
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ type UpdateHerokuInput struct {
URL *string `url:"url,omitempty"`
}

// UpdateHeroku updates a specific heroku.
// UpdateHeroku updates the specified resource.
func (c *Client) UpdateHeroku(i *UpdateHerokuInput) (*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 @@ -172,7 +172,7 @@ type UpdateHoneycombInput struct {
Token *string `url:"token,omitempty"`
}

// UpdateHoneycomb updates a specific honeycomb.
// UpdateHoneycomb updates the specified resource.
func (c *Client) UpdateHoneycomb(i *UpdateHoneycombInput) (*Honeycomb, 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 @@ -204,7 +204,7 @@ type UpdateKafkaInput struct {
User *string `url:"user,omitempty"`
}

// UpdateKafka updates a specific kafka.
// UpdateKafka updates the specified resource.
func (c *Client) UpdateKafka(i *UpdateKafkaInput) (*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 @@ -177,7 +177,7 @@ type UpdateKinesisInput struct {
StreamName *string `url:"topic,omitempty"`
}

// UpdateKinesis updates a specific Kinesis.
// UpdateKinesis updates the specified resource.
func (c *Client) UpdateKinesis(i *UpdateKinesisInput) (*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 @@ -174,7 +174,7 @@ type UpdateLogentriesInput struct {
UseTLS *Compatibool `url:"use_tls,omitempty"`
}

// UpdateLogentries updates a specific logentries.
// UpdateLogentries updates the specified resource.
func (c *Client) UpdateLogentries(i *UpdateLogentriesInput) (*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 @@ -165,7 +165,7 @@ type UpdateLogglyInput struct {
Token *string `url:"token,omitempty"`
}

// UpdateLoggly updates a specific loggly.
// UpdateLoggly updates the specified resource.
func (c *Client) UpdateLoggly(i *UpdateLogglyInput) (*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 @@ -168,7 +168,7 @@ type UpdateLogshuttleInput struct {
URL *string `url:"url,omitempty"`
}

// UpdateLogshuttle updates a specific logshuttle.
// UpdateLogshuttle updates the specified resource.
func (c *Client) UpdateLogshuttle(i *UpdateLogshuttleInput) (*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 @@ -172,7 +172,7 @@ type UpdateNewRelicInput struct {
Token *string `url:"token,omitempty"`
}

// UpdateNewRelic updates a specific newrelic.
// UpdateNewRelic updates the specified resource.
func (c *Client) UpdateNewRelic(i *UpdateNewRelicInput) (*NewRelic, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/openstack.go
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ type UpdateOpenstackInput struct {
User *string `url:"user,omitempty"`
}

// UpdateOpenstack updates a specific Openstack.
// UpdateOpenstack updates the specified resource.
func (c *Client) UpdateOpenstack(i *UpdateOpenstackInput) (*Openstack, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/package.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ type UpdatePackageInput struct {
ServiceVersion int `mapstructure:"version"`
}

// UpdatePackage updates a package for a specific version.
// UpdatePackage updates the specified resource.
func (c *Client) UpdatePackage(i *UpdatePackageInput) (*Package, error) {
urlPath, err := MakePackagePath(i.ServiceID, i.ServiceVersion)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion fastly/papertrail.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ type UpdatePapertrailInput struct {
UpdatedAt *time.Time `url:"updated_at,omitempty"`
}

// UpdatePapertrail updates a specific papertrail.
// UpdatePapertrail updates the specified resource.
func (c *Client) UpdatePapertrail(i *UpdatePapertrailInput) (*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 @@ -169,7 +169,7 @@ type UpdateBulkCertificateInput struct {
IntermediatesBlob string `jsonapi:"attr,intermediates_blob,omitempty"`
}

// UpdateBulkCertificate replace a certificate with a newly reissued certificate.
// UpdateBulkCertificate updates the specified resource.
// By using this endpoint, the original certificate will cease to be used for future TLS handshakes.
// Thus, only SAN entries that appear in the replacement certificate will become TLS enabled.
// Any SAN entries that are missing in the replacement certificate will become disabled.
Expand Down
2 changes: 1 addition & 1 deletion fastly/pool.go
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ type UpdatePoolInput struct {
UseTLS *Compatibool `url:"use_tls,omitempty"`
}

// UpdatePool updates a specufic pool for a particular service and version.
// UpdatePool updates the specified resource.
func (c *Client) UpdatePool(i *UpdatePoolInput) (*Pool, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/pubsub.go
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ type UpdatePubsubInput struct {
User *string `url:"user,omitempty"`
}

// UpdatePubsub updates a specific Pubsub.
// UpdatePubsub updates the specified resource.
func (c *Client) UpdatePubsub(i *UpdatePubsubInput) (*Pubsub, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/request_setting.go
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ type UpdateRequestSettingInput struct {
XForwardedFor RequestSettingXFF `url:"xff,omitempty"`
}

// UpdateRequestSetting updates a specific request settings.
// UpdateRequestSetting updates the specified resource.
func (c *Client) UpdateRequestSetting(i *UpdateRequestSettingInput) (*RequestSetting, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/response_object.go
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ type UpdateResponseObjectInput struct {
Status *uint `url:"status,omitempty"`
}

// UpdateResponseObject updates a specific response object.
// UpdateResponseObject updates the specified resource.
func (c *Client) UpdateResponseObject(i *UpdateResponseObjectInput) (*ResponseObject, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/s3.go
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ type UpdateS3Input struct {
TimestampFormat *string `url:"timestamp_format,omitempty"`
}

// UpdateS3 updates a specific S3.
// UpdateS3 updates the specified resource.
func (c *Client) UpdateS3(i *UpdateS3Input) (*S3, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/scalyr.go
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ type UpdateScalyrInput struct {
Token *string `url:"token,omitempty"`
}

// UpdateScalyr updates a specific scalyr.
// UpdateScalyr updates the specified resource.
func (c *Client) UpdateScalyr(i *UpdateScalyrInput) (*Scalyr, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ type UpdateServerInput struct {
Weight *uint `url:"weight,omitempty"`
}

// UpdateServer updates a single server for a particular service and pool.
// UpdateServer updates the specified resource.
func (c *Client) UpdateServer(i *UpdateServerInput) (*Server, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ type UpdateServiceInput struct {
ServiceID string
}

// UpdateService updates the service with the given input.
// UpdateService updates the specified resource.
func (c *Client) UpdateService(i *UpdateServiceInput) (*Service, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
2 changes: 1 addition & 1 deletion fastly/service_authorization.go
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ type UpdateServiceAuthorizationInput struct {
Permission string `jsonapi:"attr,permission,omitempty"`
}

// UpdateServiceAuthorization updates an exisitng service authorization. The ID must be known.
// UpdateServiceAuthorization updates the specified resource.
func (c *Client) UpdateServiceAuthorization(i *UpdateServiceAuthorizationInput) (*ServiceAuthorization, error) {
if i.ID == "" {
return nil, ErrMissingID
Expand Down
2 changes: 1 addition & 1 deletion fastly/settings.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ type UpdateSettingsInput struct {
StaleIfErrorTTL *uint `url:"general.stale_if_error_ttl,omitempty"`
}

// UpdateSettings updates a specific backend.
// UpdateSettings updates the specified resource.
func (c *Client) UpdateSettings(i *UpdateSettingsInput) (*Settings, error) {
if i.ServiceID == "" {
return nil, ErrMissingServiceID
Expand Down
Loading

0 comments on commit a508562

Please sign in to comment.