[BUG] fabric_variable_library misleading documentation

[levvko]

🐛 What happened?

Example code in the fabric_variable_library documentation is wrong Definition argument requires 3 inputs (variables.json, valueSets/valueSet1.json and settings.json) and doesn't work with only variables.json specified. Please also note that the three mentioned above are the only options, as the documentation has examples with other values as well.

🔬 How to reproduce?

1. Add variable library resource according to documentation
2. run terraform plan
3. see an error: "Attribute definition map must contain at least 3 elements, got: 1"

🏗️ Code Sample / Log

resource "fabric_variable_library" "vl" {
  for_each = tomap({
    for ws in local.workspaces : "${ws.data-project-id}_${title(ws.workspace)}" => ws
  })

  workspace_id = fabric_workspace.workspace[each.key].id
  display_name = "var_library_name"
  description  = "description"
  format       = "Default"

  definition = {
    "variables.json" = {
      source = "${path.module}/files/var-library.json"
      tokens = {
...
         replace_token = var.replace_token
...
      }
    }
  }
}

Error details:

│ Error: Invalid Attribute Value
│ 
│   with module.data-project.fabric_variable_library.vl,
│   on data-project/fabric-workspace-items.tf line 22, in resource "fabric_variable_library" "vl":
│   22:   definition = {
│   23:     "variables.json" = {
│   24:       source = "${path.module}/files/var-library.json"
│   25:       tokens = {
...
│   38:       }
│   39:     }
│   40:   }
│ 
│ Attribute definition map must contain at least 3 elements, got: 1

📷 Screenshots

No response

📈 Expected behavior

Documentation contains working examples.

🌌 Environment (Provider Version)

1.6.0

🌌 Environment (Terraform Version)

1.11.4

🌌 Environment (OS)

Linux

📎 Additional context

No response

🔰 Code of Conduct

• I agree to follow this project's Code of Conduct.

[CatalinDabuleanu]

Hello @levvko

Thank you for reporting this. Indeed, there is an issue in our current documentation which is going to be fixed in our next release.

Please find below the documentation related to definition for Variable Library. Please keep in mind that variabls.json and settings.json are required. You can add then as many valueSets as you want.

For this to work with the current version, you have to add both variables.json and settings.json and at least 1 valueSets.

After the fix, only the variables.json and settings.json will be required.

[levvko]

Hi @CatalinDabuleanu,

Have you considered making settings.json optional as well? From what I can see, it can be almost empty for this to work with current version.

[CatalinDabuleanu]

Hi @levvko

Thank you for raising this suggestion. We will take this internally with our API team and reach back once we have a response.

[levvko]

Thanks a lot for looking into it