feat(api): OpenAPI spec update

cloudflare · Feb 1, 2024 · fce499f · fce499f
1 parent 59dc389
commit fce499f
Show file tree

Hide file tree

Showing 59 changed files with 246 additions and 119 deletions.
diff --git a/README.md b/README.md
@@ -39,8 +39,9 @@ import (
 
 func main() {
 	client := cloudflare.NewClient(
-		option.WithAPIKey("my-cloudflare-api-key"), // defaults to os.LookupEnv("CLOUDFLARE_API_KEY")
-		option.WithEmail("dev@cloudflare.com"),     // defaults to os.LookupEnv("CLOUDFLARE_EMAIL")
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),           // defaults to os.LookupEnv("CLOUDFLARE_API_KEY")
+		option.WithEmail("dev@cloudflare.com"),                          // defaults to os.LookupEnv("CLOUDFLARE_EMAIL")
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), // defaults to os.LookupEnv("CLOUDFLARE_API_TOKEN")
 	)
 	zoneNewResponse, err := client.Zones.New(context.TODO(), cloudflare.ZoneNewParams{
 		Account: cloudflare.F(cloudflare.ZoneNewParamsAccount{

diff --git a/client.go b/client.go
@@ -18,9 +18,9 @@ type Client struct {
 }
 
 // NewClient generates a new client with the default option read from the
-// environment (CLOUDFLARE_API_KEY, CLOUDFLARE_EMAIL). The option passed in as
-// arguments are applied after these default arguments, and all option will be
-// passed down to the services and requests that this client makes.
+// environment (CLOUDFLARE_API_KEY, CLOUDFLARE_EMAIL, CLOUDFLARE_API_TOKEN). The
+// option passed in as arguments are applied after these default arguments, and all
+// option will be passed down to the services and requests that this client makes.
 func NewClient(opts ...option.RequestOption) (r *Client) {
 	defaults := []option.RequestOption{option.WithEnvironmentProduction()}
 	if o, ok := os.LookupEnv("CLOUDFLARE_API_KEY"); ok {
@@ -29,6 +29,9 @@ func NewClient(opts ...option.RequestOption) (r *Client) {
 	if o, ok := os.LookupEnv("CLOUDFLARE_EMAIL"); ok {
 		defaults = append(defaults, option.WithEmail(o))
 	}
+	if o, ok := os.LookupEnv("CLOUDFLARE_API_TOKEN"); ok {
+		defaults = append(defaults, option.WithAPIToken(o))
+	}
 	opts = append(defaults, opts...)
 
 	r = &Client{Options: opts}

diff --git a/internal/requestconfig/requestconfig.go b/internal/requestconfig/requestconfig.go
@@ -148,6 +148,7 @@ type RequestConfig struct {
 	Middlewares    []middleware
 	APIKey         string
 	Email          string
+	APIToken       string
 	// If ResponseBodyInto not nil, then we will attempt to deserialize into
 	// ResponseBodyInto. If Destination is a []byte, then it will return the body as
 	// is.

diff --git a/option/requestoption.go b/option/requestoption.go
@@ -202,3 +202,11 @@ func WithEmail(value string) RequestOption {
 		return r.Apply(WithHeader("x-auth-email", value))
 	}
 }
+
+// WithAPIToken returns a RequestOption that sets the client setting "api_token".
+func WithAPIToken(value string) RequestOption {
+	return func(r *requestconfig.RequestConfig) error {
+		r.APIToken = value
+		return r.Apply(WithHeader("authoriazaion", value))
+	}
+}
diff --git a/usage_test.go b/usage_test.go
@@ -22,8 +22,9 @@ func TestUsage(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	zoneNewResponse, err := client.Zones.New(context.TODO(), cloudflare.ZoneNewParams{
 		Account: cloudflare.F(cloudflare.ZoneNewParamsAccount{

diff --git a/zone_test.go b/zone_test.go
@@ -23,8 +23,9 @@ func TestZoneNewWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.New(context.TODO(), cloudflare.ZoneNewParams{
 		Account: cloudflare.F(cloudflare.ZoneNewParamsAccount{
@@ -52,8 +53,9 @@ func TestZoneGet(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Get(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {
@@ -75,8 +77,9 @@ func TestZoneUpdateWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Update(
 		context.TODO(),
@@ -108,8 +111,9 @@ func TestZoneListWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.List(context.TODO(), cloudflare.ZoneListParams{
 		Account: cloudflare.F(cloudflare.ZoneListParamsAccount{
@@ -144,8 +148,9 @@ func TestZoneDelete(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Delete(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonednssec_test.go b/zonednssec_test.go
@@ -23,8 +23,9 @@ func TestZoneDnssecGet(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Dnssecs.Get(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {
@@ -46,8 +47,9 @@ func TestZoneDnssecUpdateWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Dnssecs.Update(
 		context.TODO(),

diff --git a/zoneloadbalancer_test.go b/zoneloadbalancer_test.go
@@ -23,8 +23,9 @@ func TestZoneLoadBalancerNewWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.LoadBalancers.New(
 		context.TODO(),
@@ -333,8 +334,9 @@ func TestZoneLoadBalancerGet(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.LoadBalancers.Get(
 		context.TODO(),
@@ -360,8 +362,9 @@ func TestZoneLoadBalancerUpdateWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.LoadBalancers.Update(
 		context.TODO(),
@@ -672,8 +675,9 @@ func TestZoneLoadBalancerList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.LoadBalancers.List(context.TODO(), "699d98642c564d2e855e9661899b7252")
 	if err != nil {
@@ -695,8 +699,9 @@ func TestZoneLoadBalancerDelete(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.LoadBalancers.Delete(
 		context.TODO(),

diff --git a/zoneratelimit_test.go b/zoneratelimit_test.go
@@ -23,8 +23,9 @@ func TestZoneRateLimitGet(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.RateLimits.Get(
 		context.TODO(),
@@ -50,8 +51,9 @@ func TestZoneRateLimitListWithOptionalParams(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.RateLimits.List(
 		context.TODO(),

diff --git a/zonesetting_test.go b/zonesetting_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {
@@ -47,8 +48,9 @@ func TestZoneSettingEdit(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.Edit(
 		context.TODO(),

diff --git a/zonesettingadvancedddo_test.go b/zonesettingadvancedddo_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingAdvancedDdoList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AdvancedDdos.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonesettingalwaysonline_test.go b/zonesettingalwaysonline_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingAlwaysOnlineUpdate(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AlwaysOnlines.Update(
 		context.TODO(),
@@ -52,8 +53,9 @@ func TestZoneSettingAlwaysOnlineList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AlwaysOnlines.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonesettingalwaysusehttp_test.go b/zonesettingalwaysusehttp_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingAlwaysUseHTTPUpdate(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AlwaysUseHTTPs.Update(
 		context.TODO(),
@@ -52,8 +53,9 @@ func TestZoneSettingAlwaysUseHTTPList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AlwaysUseHTTPs.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonesettingautomatichttpsrewrite_test.go b/zonesettingautomatichttpsrewrite_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingAutomaticHTTPsRewriteUpdate(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AutomaticHTTPsRewrites.Update(
 		context.TODO(),
@@ -52,8 +53,9 @@ func TestZoneSettingAutomaticHTTPsRewriteList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AutomaticHTTPsRewrites.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonesettingautomaticplatformoptimization_test.go b/zonesettingautomaticplatformoptimization_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingAutomaticPlatformOptimizationUpdate(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AutomaticPlatformOptimizations.Update(
 		context.TODO(),
@@ -59,8 +60,9 @@ func TestZoneSettingAutomaticPlatformOptimizationList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.AutomaticPlatformOptimizations.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonesettingbrotli_test.go b/zonesettingbrotli_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingBrotliUpdate(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.Brotli.Update(
 		context.TODO(),
@@ -52,8 +53,9 @@ func TestZoneSettingBrotliList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.Brotli.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {

diff --git a/zonesettingbrowsercachettls_test.go b/zonesettingbrowsercachettls_test.go
@@ -23,8 +23,9 @@ func TestZoneSettingBrowserCacheTTLSUpdate(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.BrowserCacheTTLS.Update(
 		context.TODO(),
@@ -52,8 +53,9 @@ func TestZoneSettingBrowserCacheTTLSList(t *testing.T) {
 	}
 	client := cloudflare.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAPIKey("my-cloudflare-api-key"),
+		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
 		option.WithEmail("dev@cloudflare.com"),
+		option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
 	)
 	_, err := client.Zones.Settings.BrowserCacheTTLS.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353")
 	if err != nil {