Update inventory docs

Author: lranjbar

docs/data-sources/inventory.md

@@ -45,14 +45,16 @@ output "inventory_details" {
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Required
+### Optional
 
 - `id` (Number) Inventory id
+- `name` (String) Name of the inventory
+- `organization_name` (String) The name for the organization to which the inventory belongs
 
 ### Read-Only
 
 - `description` (String) Description of the inventory
-- `name` (String) Name of the inventory
+- `named_url` (String) The Named Url of the inventory
 - `organization` (Number) Identifier for the organization to which the inventory belongs
 - `url` (String) Url of the inventory
 - `variables` (String) Variables of the inventory. Will be either JSON or YAML string depending on how the variables were entered into AAP.

docs/resources/inventory.md

@@ -111,4 +111,6 @@ output "inventory_xyz" {
 ### Read-Only
 
 - `id` (Number) Inventory id
+- `named_url` (String) Named URL of the inventory
+- `organization_name` (String) Name for the organization.
 - `url` (String) URL of the inventory

internal/provider/inventory_data_source.go

@@ -12,7 +12,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	tfpath "github.com/hashicorp/terraform-plugin-framework/path"
-	"github.com/hashicorp/terraform-plugin-framework/provider"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
@@ -38,6 +37,7 @@ var (
 	_ datasource.DataSource                     = &InventoryDataSource{}
 	_ datasource.DataSourceWithConfigure        = &InventoryDataSource{}
 	_ datasource.DataSourceWithConfigValidators = &InventoryDataSource{}
+	_ datasource.DataSourceWithValidateConfig   = &InventoryDataSource{}
 )
 
 // NewInventoryDataSource is a helper function to simplify the provider implementation.
@@ -105,9 +105,8 @@ func (d *InventoryDataSource) Read(ctx context.Context, req datasource.ReadReque
 		return
 	}
 
-	URI := path.Join(d.client.getApiEndpoint(), "inventories")
-	resourceURL, err := ReturnAAPNamedURL(state.Id, state.Name, state.OrganizationName, URI)
-	// resourceURL, err := state.ResourceUrlFromParameters(d)
+	uri := path.Join(d.client.getApiEndpoint(), "inventories")
+	resourceURL, err := ReturnAAPNamedURL(state.Id, state.Name, state.OrganizationName, uri)
 	if err != nil {
 		resp.Diagnostics.AddError("Minimal Data Not Supplied", "Expected either [id] or [name + organization_name] pair")
 		return
@@ -164,7 +163,7 @@ func (d *InventoryDataSource) ConfigValidators(_ context.Context) []datasource.C
 	}
 }
 
-func (d *InventoryDataSource) ValidateConfig(ctx context.Context, req provider.ValidateConfigRequest, resp *provider.ValidateConfigResponse) {
+func (d *InventoryDataSource) ValidateConfig(ctx context.Context, req datasource.ValidateConfigRequest, resp *datasource.ValidateConfigResponse) {
 	var data InventoryDataSourceModel
 
 	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
@@ -181,30 +180,29 @@ func (d *InventoryDataSource) ValidateConfig(ctx context.Context, req provider.V
 		return
 	}
 
-	if IsValueNotProvided(data.Id) && IsValueNotProvided(data.Name) {
+	if !IsValueProvided(data.Id) && !IsValueProvided(data.Name) {
 		resp.Diagnostics.AddAttributeWarning(
 			tfpath.Root("id"),
-			"Missing Atribute Configuration",
+			"Missing Attribute Configuration",
 			"Expected either [id] or [name + organization_name] pair",
 		)
 	}
 
-	if IsValueProvided(data.Name) && IsValueNotProvided(data.OrganizationName) {
+	if IsValueProvided(data.Name) && !IsValueProvided(data.OrganizationName) {
 		resp.Diagnostics.AddAttributeWarning(
 			tfpath.Root("organization_name"),
 			"Missing Attribute Configuration",
 			"Expected organization_name to be configured with name.",
 		)
 	}
 
-	if IsValueNotProvided(data.Name) && IsValueProvided(data.OrganizationName) {
+	if !IsValueProvided(data.Name) && IsValueProvided(data.OrganizationName) {
 		resp.Diagnostics.AddAttributeWarning(
 			tfpath.Root("name"),
 			"Missing Attribute Configuration",
 			"Expected name to be configured with organization_name.",
 		)
 	}
-
 }
 
 func (dm *InventoryDataSourceModel) ParseHttpResponse(body []byte) diag.Diagnostics {

internal/provider/inventory_resource.go

@@ -291,7 +291,7 @@ func (r *InventoryResourceModel) generateRequestBody() ([]byte, diag.Diagnostics
 		organizationId = r.Organization.ValueInt64()
 	}
 
-	if IsValueNotProvided(r.NamedUrl) {
+	if !IsValueProvided(r.NamedUrl) {
 		namedURL, err := ReturnAAPNamedURL(r.Id, r.Name, r.OrganizationName, "inventories")
 		// Squashing error here. If we can't generate the named url just leave it blank
 		if err == nil {

internal/provider/inventory_resource_test.go

@@ -86,7 +86,9 @@ func TestInventoryResourceGenerateRequestBody(t *testing.T) {
 				Variables:        customtypes.NewAAPCustomStringValue("{\"foo\": \"bar\", \"nested\": {\"foobar\": \"baz\"}}"),
 			},
 			expected: []byte(
-				`{"organization":2,"summary_fields":{"organization":{"id":2,"name":"test organization"},"inventory":{"id":1,"name":"test inventory"}},"related":{"named_url":"inventories/1"},"name":"test inventory","description":"A test inventory for testing","variables":"{\"foo\": \"bar\", \"nested\": {\"foobar\": \"baz\"}}"}`,
+				`{"organization":2,"summary_fields":{"organization":{"id":2,"name":"test organization"},"inventory":{"id":1,"name":"test inventory"}},` +
+					`"related":{"named_url":"inventories/1"},"name":"test inventory","description":"A test inventory for testing",` +
+					`"variables":"{\"foo\": \"bar\", \"nested\": {\"foobar\": \"baz\"}}"}`,
 			),
 		},
 	}

internal/provider/utils.go

@@ -16,19 +16,17 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
-func ReturnAAPNamedURL(id types.Int64, name types.String, orgName types.String, URI string) (string, error) {
+func ReturnAAPNamedURL(id types.Int64, name types.String, orgName types.String, uri string) (string, error) {
 	if IsValueProvided(id) {
-		return path.Join(URI, id.String()), nil
-	} else if IsValueProvided(name) && IsValueProvided(orgName) {
+		return path.Join(uri, id.String()), nil
+	}
+
+	if IsValueProvided(name) && IsValueProvided(orgName) {
 		namedUrl := fmt.Sprintf("%s++%s", name.ValueString(), orgName.ValueString())
-		return path.Join(URI, namedUrl), nil
-	} else {
-		return "", errors.New("invalid lookup parameters")
+		return path.Join(uri, namedUrl), nil
 	}
-}
 
-func IsValueNotProvided(value attr.Value) bool {
-	return value.IsNull() || value.IsUnknown()
+	return "", errors.New("invalid lookup parameters")
 }
 
 func IsValueProvided(value attr.Value) bool {