From 0c7816b384dbce542322a047a09da1c8447a2d9f Mon Sep 17 00:00:00 2001 From: Michael Rosenfeld Date: Fri, 7 Jun 2024 14:46:58 -0500 Subject: [PATCH 1/2] Add Missing Resource and Data Source Documentation --- docs/data-sources/package_deny_policy.md | 30 ++++++++++++++++++++++++ docs/resources/package_deny_policy.md | 29 +++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 docs/data-sources/package_deny_policy.md create mode 100644 docs/resources/package_deny_policy.md diff --git a/docs/data-sources/package_deny_policy.md b/docs/data-sources/package_deny_policy.md new file mode 100644 index 0000000..1831f85 --- /dev/null +++ b/docs/data-sources/package_deny_policy.md @@ -0,0 +1,30 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "cloudsmith_package_deny_policy Data Source - terraform-provider-cloudsmith" +subcategory: "" +description: |- + +--- + +# cloudsmith_package_deny_policy (Data Source) + +Package deny policies are a feature within Cloudsmith's policy management system to control which packages can be downloaded within their repositories. + + +## Schema + +### Required + +- `namespace` (String) Namespace to which this package deny policy belongs. +- `slug_perm` (String) Identifier of the package deny policy. + +### Optional + +- `description` (String) Description of the package deny policy. +- `enabled` (Boolean) Is the package deny policy enabled?. +- `name` (String) A descriptive name for the package deny policy. +- `package_query` (String) The query to match the packages to be blocked. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/docs/resources/package_deny_policy.md b/docs/resources/package_deny_policy.md new file mode 100644 index 0000000..d77d101 --- /dev/null +++ b/docs/resources/package_deny_policy.md @@ -0,0 +1,29 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "cloudsmith_package_deny_policy Resource - terraform-provider-cloudsmith" +subcategory: "" +description: |- + +--- + +# cloudsmith_package_deny_policy (Resource) + +Package deny policies are a feature within Cloudsmith's policy management system to control which packages can be downloaded within their repositories. + + +## Schema + +### Required + +- `namespace` (String) Namespace to which this package deny policy belongs. +- `package_query` (String) The query to match the packages to be blocked. + +### Optional + +- `description` (String) Description of the package deny policy. +- `enabled` (Boolean) Is the package deny policy enabled?. +- `name` (String) A descriptive name for the package deny policy. + +### Read-Only + +- `id` (String) The ID of this resource. From c8b3729d436536a7a13abec019acec5c66afd20c Mon Sep 17 00:00:00 2001 From: Michael Rosenfeld Date: Fri, 7 Jun 2024 14:59:34 -0500 Subject: [PATCH 2/2] Add Missing Docs and Update Resource Description --- cloudsmith/resource_package_deny_policy.go | 1 + docs/data-sources/package_deny_policy.md | 2 +- docs/resources/package_deny_policy.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/cloudsmith/resource_package_deny_policy.go b/cloudsmith/resource_package_deny_policy.go index 00c7d35..4193616 100644 --- a/cloudsmith/resource_package_deny_policy.go +++ b/cloudsmith/resource_package_deny_policy.go @@ -142,6 +142,7 @@ func packageDenyPolicy() *schema.Resource { Read: packageDenyPolicyRead, Update: packageDenyPolicyUpdate, Delete: packageDenyPolicyDelete, + Description: "Package deny policies control which packages can be downloaded within their repositories.", Importer: &schema.ResourceImporter{ StateContext: packageDenyPolicyImport, diff --git a/docs/data-sources/package_deny_policy.md b/docs/data-sources/package_deny_policy.md index 1831f85..789d53b 100644 --- a/docs/data-sources/package_deny_policy.md +++ b/docs/data-sources/package_deny_policy.md @@ -2,7 +2,7 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "cloudsmith_package_deny_policy Data Source - terraform-provider-cloudsmith" subcategory: "" -description: |- +description: "Package deny policies control which packages can be downloaded within their repositories" --- diff --git a/docs/resources/package_deny_policy.md b/docs/resources/package_deny_policy.md index d77d101..45a36b1 100644 --- a/docs/resources/package_deny_policy.md +++ b/docs/resources/package_deny_policy.md @@ -2,7 +2,7 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "cloudsmith_package_deny_policy Resource - terraform-provider-cloudsmith" subcategory: "" -description: |- +description: "Package deny policies control which packages can be downloaded within their repositories ---