chore: add docs for import

README.md

@@ -117,6 +117,18 @@ output "router_token" {
 
 Further in depth examples can be found in the [examples](examples) directory.
 
+## Importing resources
+
+Resources can be imported into Terraform using the `terraform import` command. The following resources are supported for import:
+
+- `cosmo_namespace`
+- `cosmo_federated_graph`
+- `cosmo_subgraph`
+- `cosmo_contract`
+- `cosmo_monograph`
+
+For detailed instructions on how to import each resource, refer to the corresponding resource documentation in the corresponding [docs](docs/resources).
+
 ## Cosmo Local Example
 
 The module [cosmo-local](examples/cosmo-local) contains an example of how to use the provider to manage a local cosmo setup on minikube.

docs/resources/contract.md

@@ -48,3 +48,12 @@ resource "cosmo_contract" "test" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Contracts can be imported using the UUID of the contract, e.g.
+terraform import cosmo_contract.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b
+```

docs/resources/federated_graph.md

@@ -43,3 +43,12 @@ resource "cosmo_federated_graph" "test" {
 ### Read-Only
 
 - `id` (String) The unique identifier of the federated graph resource, automatically generated by the system.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Federated Graphs can be imported using the UUID of the federated graph.
+terraform import cosmo_federated_graph.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b
+```

docs/resources/monograph.md

@@ -48,3 +48,12 @@ resource "cosmo_monograph" "example" {
 ### Read-Only
 
 - `id` (String) The unique identifier of the monograph resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Monographs can be imported using the UUID of the monograph, e.g.
+terraform import cosmo_monograph.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b
+```

docs/resources/namespace.md

@@ -31,3 +31,14 @@ resource "cosmo_namespace" "test" {
 ### Read-Only
 
 - `id` (String) The unique identifier of the namespace resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Namespaces can be imported using the name of the namespace
+terraform import cosmo_namespace.example my-namespace
+# or alternatively, the UUID of the namespace
+terraform import cosmo_namespace.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b
+```

docs/resources/subgraph.md

@@ -49,3 +49,12 @@ resource "cosmo_subgraph" "test" {
 ### Read-Only
 
 - `id` (String) The unique identifier of the subgraph resource.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+# Subgraphs can be imported using the UUID of the subgraph, e.g.
+terraform import cosmo_subgraph.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b
+```

examples/resources/cosmo_contract/import.sh

@@ -0,0 +1,2 @@
+# Contracts can be imported using the UUID of the contract, e.g.
+terraform import cosmo_contract.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b

examples/resources/cosmo_federated_graph/import.sh

@@ -0,0 +1,2 @@
+# Federated Graphs can be imported using the UUID of the federated graph.
+terraform import cosmo_federated_graph.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b

examples/resources/cosmo_monograph/import.sh

@@ -0,0 +1,2 @@
+# Monographs can be imported using the UUID of the monograph, e.g.
+terraform import cosmo_monograph.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b

examples/resources/cosmo_namespace/import.sh

@@ -0,0 +1,4 @@
+# Namespaces can be imported using the name of the namespace
+terraform import cosmo_namespace.example my-namespace
+# or alternatively, the UUID of the namespace
+terraform import cosmo_namespace.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b

examples/resources/cosmo_subgraph/import.sh

@@ -0,0 +1,2 @@
+# Subgraphs can be imported using the UUID of the subgraph, e.g.
+terraform import cosmo_subgraph.example 0b1b1b1b-1b1b-1b1b-1b1b-1b1b1b1b1b1b

internal/service/namespace/import_cosmo_namespace_test.go

@@ -18,10 +18,18 @@ func TestAccCosmoNamespaceImportBasic(t *testing.T) {
 				Config: testAccNamespaceResourceConfig(name),
 			},
 			{
+				// import via ID
 				ResourceName:      "cosmo_namespace.test",
 				ImportState:       true,
 				ImportStateVerify: true,
 			},
+			{
+				// import via name
+				ResourceName:      "cosmo_namespace.test",
+				ImportState:       true,
+				ImportStateId:     name,
+				ImportStateVerify: true,
+			},
 		},
 	})
 }

internal/service/namespace/resource_cosmo_namespace.go

@@ -3,8 +3,7 @@ package namespace
 import (
 	"context"
 	"fmt"
-
-	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/google/uuid"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -13,6 +12,11 @@ import (
 	"github.com/wundergraph/cosmo/terraform-provider-cosmo/internal/utils"
 )
 
+var (
+	_ resource.Resource                = (*NamespaceResource)(nil)
+	_ resource.ResourceWithImportState = (*NamespaceResource)(nil)
+)
+
 type NamespaceResource struct {
 	client *api.PlatformClient
 }
@@ -195,5 +199,15 @@ func getNamespace(ctx context.Context, client api.PlatformClient, id, name strin
 }
 
 func (r *NamespaceResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
-	resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
+	var data NamespaceResourceModel
+
+	id := req.ID
+
+	if err := uuid.Validate(id); err != nil {
+		data.Name = types.StringValue(id) // We assume this is the namespace name
+	} else {
+		data.Id = types.StringValue(id)
+	}
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
 }