Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SivaanandM committed Sep 30, 2024
1 parent ae63a6b commit db061a0
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-



~> Starting with Palette version 4.5 (and the corresponding provider release), the `registry_uid` attribute will become required. The existing `filters` attribute will be deprecated, and a new `pack_filters` attribute will be introduced for advanced search functionality.
~> The existing `filters` attribute will be deprecated, and a new `pack_filters` attribute will be introduced for advanced search functionality.

## Example Usage

Expand Down Expand Up @@ -59,7 +59,7 @@ data "spectrocloud_pack" "cni" {
- `filters` (String) Filters to apply when searching for a pack. This is a string of the form 'key1=value1' with 'AND', 'OR` operators. Refer to the Palette API [pack search API endpoint documentation](https://docs.spectrocloud.com/api/v1/v-1-packs-search/) for filter examples..
- `id` (String) The UID of the pack returned.
- `name` (String) The name of the pack to search for.
- `registry_uid` (String) The UID of the registry to search for the pack in. This is a required parameter starting from version 0.21.0.
- `registry_uid` (String) The unique identifier (UID) of the registry where the pack is located. Specify `registry_uid` to search within a specific registry.
- `type` (String) The type of pack to search for. Supported values are `helm`, `manifest`, `container`, `operator-instance`.
- `version` (String) The version of the pack to search for.

Expand Down
4 changes: 1 addition & 3 deletions docs/data-sources/pack_simple.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ description: |-

## Example Usage

~> Starting with version 0.21.0 the attribute `registry_uid` is required.

```hcl
data "spectrocloud_registry" "registry" {
name = "Public Repo"
Expand All @@ -38,7 +36,7 @@ data "spectrocloud_pack_simple" "pack" {
### Optional

- `context` (String) Indicates in which context registry should be searched for the pack values. Allowed values are `system`, `project` or `tenant`. Defaults to `project`.If the `project` context is specified, the project name will sourced from the provider configuration parameter [`project_name`](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs#schema).
- `registry_uid` (String) The unique identifier of the registry the pack belongs to. This is a required parameter starting from version 0.21.0
- `registry_uid` (String) The unique identifier (UID) of the registry where the pack is located. Specify `registry_uid` to search within a specific registry.
- `version` (String) The version of the pack.

### Read-Only
Expand Down
2 changes: 1 addition & 1 deletion spectrocloud/data_source_pack.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func dataSourcePack() *schema.Resource {
},
"registry_uid": {
Type: schema.TypeString,
Description: "The UID of the registry to search for the pack in. This is a required parameter starting from version 0.21.0.",
Description: "The unique identifier (UID) of the registry where the pack is located. Specify `registry_uid` to search within a specific registry.",
Computed: true,
Optional: true,
},
Expand Down
2 changes: 1 addition & 1 deletion spectrocloud/data_source_pack_simple.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func dataSourcePackSimple() *schema.Resource {
"registry_uid": {
Type: schema.TypeString,
Optional: true,
Description: "The unique identifier of the registry the pack belongs to. This is a required parameter starting from version 0.21.0",
Description: "The unique identifier (UID) of the registry where the pack is located. Specify `registry_uid` to search within a specific registry.",
},
"type": {
Type: schema.TypeString,
Expand Down
2 changes: 1 addition & 1 deletion templates/data-sources/pack.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: |-



~> Starting with Palette version 4.5 (and the corresponding provider release), the `registry_uid` attribute will become required. The existing `filters` attribute will be deprecated, and a new `pack_filters` attribute will be introduced for advanced search functionality.
~> The existing `filters` attribute will be deprecated, and a new `pack_filters` attribute will be introduced for advanced search functionality.

## Example Usage

Expand Down
2 changes: 0 additions & 2 deletions templates/data-sources/pack_simple.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ description: |-

## Example Usage

~> Starting with version 0.21.0 the attribute `registry_uid` is required.

```hcl
data "spectrocloud_registry" "registry" {
name = "Public Repo"
Expand Down

0 comments on commit db061a0

Please sign in to comment.