APISHI-2358 resource/cloudflare_api_shield_schema: add API Shield Sch…

…ema resource

.changelog/2784.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/cloudflare_api_shield_schema: add API Shield Schema resource
+```

docs/resources/api_shield_schema.md

@@ -0,0 +1,41 @@
+---
+page_title: "cloudflare_api_shield_schema Resource - Cloudflare"
+subcategory: ""
+description: |-
+  Provides a resource to manage a schema in API Shield Schema Validation 2.0.
+---
+
+# cloudflare_api_shield_schema (Resource)
+
+Provides a resource to manage a schema in API Shield Schema Validation 2.0.
+
+## Example Usage
+
+```terraform
+resource "cloudflare_api_shield_schema" "petstore_schema" {
+  zone_id = "0da42c8d2132a9ddaf714f9e7c920711"
+  name = "myschema"
+  kind = "openapi_v3" # optional
+  validation_enabled = true # optional, default false
+  source = file("./schemas/petstore.json")
+}
+```
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) Name of the schema. **Modifying this attribute will force creation of a new resource.**
+- `source` (String) Schema file bytes. **Modifying this attribute will force creation of a new resource.**
+- `zone_id` (String) The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
+
+### Optional
+
+- `kind` (String) Kind of schema. Defaults to `openapi_v3`. **Modifying this attribute will force creation of a new resource.**
+- `validation_enabled` (Boolean) Flag whether schema is enabled for validation.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+

examples/resources/cloudflare_api_shield_schema/resource.tf

@@ -0,0 +1,7 @@
+resource "cloudflare_api_shield_schema" "petstore_schema" {
+  zone_id = "0da42c8d2132a9ddaf714f9e7c920711"
+  name = "myschema"
+  kind = "openapi_v3" # optional
+  validation_enabled = true # optional, default false
+  source = file("./schemas/petstore.json")
+}

internal/sdkv2provider/provider.go

@@ -188,6 +188,7 @@ func New(version string) func() *schema.Provider {
 				"cloudflare_account":                                resourceCloudflareAccount(),
 				"cloudflare_address_map":                            resourceCloudflareAddressMap(),
 				"cloudflare_api_shield":                             resourceCloudflareAPIShield(),
+				"cloudflare_api_shield_schema":                      resourceCloudflareAPIShieldSchemas(),
 				"cloudflare_api_token":                              resourceCloudflareApiToken(),
 				"cloudflare_argo":                                   resourceCloudflareArgo(),
 				"cloudflare_authenticated_origin_pulls_certificate": resourceCloudflareAuthenticatedOriginPullsCertificate(),

internal/sdkv2provider/resource_cloudflare_api_shield_schema.go

@@ -0,0 +1,134 @@
+package sdkv2provider
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/MakeNowJust/heredoc/v2"
+	"github.com/cloudflare/cloudflare-go"
+	"github.com/cloudflare/terraform-provider-cloudflare/internal/consts"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/pkg/errors"
+)
+
+func resourceCloudflareAPIShieldSchemas() *schema.Resource {
+	return &schema.Resource{
+		Schema:        resourceCloudflareAPIShieldSchemaSchema(),
+		CreateContext: resourceCloudflareAPIShieldSchemaCreate,
+		ReadContext:   resourceCloudflareAPIShieldSchemaRead,
+		DeleteContext: resourceCloudflareAPIShieldSchemaDelete,
+		UpdateContext: resourceCloudflareAPIShieldSchemaUpdate,
+		Importer: &schema.ResourceImporter{
+			StateContext: nil,
+		},
+		Description: heredoc.Doc(`
+			Provides a resource to manage a schema in API Shield Schema Validation 2.0.
+		`),
+	}
+}
+
+func resourceCloudflareAPIShieldSchemaCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	sch, err := client.CreateAPIShieldSchema(
+		ctx,
+		cloudflare.ZoneIdentifier(zoneID),
+		cloudflare.CreateAPIShieldSchemaParams{
+			Name:              d.Get("name").(string),
+			Kind:              d.Get("kind").(string),
+			Source:            strings.NewReader(d.Get("source").(string)),
+			ValidationEnabled: cloudflare.BoolPtr(d.Get("validation_enabled").(bool)),
+		},
+	)
+
+	if err != nil {
+		return diag.FromErr(errors.Wrap(err, "failed to create cloudflare_api_shield_schema"))
+	}
+
+	// log warnings that occurred during creation
+	for _, w := range sch.Events.Warnings {
+		tflog.Warn(ctx, fmt.Sprintf("cloudflare_api_shield_schema: warning encountered when creating schema: %s", w))
+	}
+
+	d.SetId(sch.Schema.ID)
+
+	return resourceCloudflareAPIShieldSchemaRead(ctx, d, meta)
+}
+
+func resourceCloudflareAPIShieldSchemaRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	sch, err := client.GetAPIShieldSchema(
+		ctx,
+		cloudflare.ZoneIdentifier(zoneID),
+		cloudflare.GetAPIShieldSchemaParams{
+			SchemaID: d.Id(),
+		},
+	)
+
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("failed to fetch API Shield Schema: %w", err))
+	}
+
+	if err := d.Set("name", sch.Name); err != nil {
+		return diag.FromErr(err)
+	}
+
+	if err := d.Set("kind", sch.Kind); err != nil {
+		return diag.FromErr(err)
+	}
+
+	if err := d.Set("source", sch.Source); err != nil {
+		return diag.FromErr(err)
+	}
+
+	if err := d.Set("validation_enabled", sch.ValidationEnabled); err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.SetId(sch.ID)
+	return nil
+}
+
+func resourceCloudflareAPIShieldSchemaUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	_, err := client.PatchAPIShieldSchema(
+		ctx,
+		cloudflare.ZoneIdentifier(zoneID),
+		cloudflare.PatchAPIShieldSchemaParams{
+			SchemaID:          d.Id(),
+			ValidationEnabled: cloudflare.BoolPtr(d.Get("validation_enabled").(bool)),
+		},
+	)
+
+	if err != nil {
+		return diag.FromErr(errors.Wrap(err, "failed to create API Shield Schema"))
+	}
+
+	return resourceCloudflareAPIShieldSchemaRead(ctx, d, meta)
+}
+
+func resourceCloudflareAPIShieldSchemaDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*cloudflare.API)
+	zoneID := d.Get(consts.ZoneIDSchemaKey).(string)
+
+	err := client.DeleteAPIShieldSchema(
+		ctx,
+		cloudflare.ZoneIdentifier(zoneID),
+		cloudflare.DeleteAPIShieldSchemaParams{
+			SchemaID: d.Id(),
+		},
+	)
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("failed to fetch API Shield Schema: %w", err))
+	}
+
+	return nil
+}