When creating an oncall-shift via the public API, rolling_users is not validated

[joeyorlando]

What went wrong?

What happened:

Below is a reproducible example via Terraform:

terraform {
  required_version = ">= 1.5.1"
  required_providers {
    grafana = {
      source  = "grafana/grafana"
      version = ">= 2.0.0"
    }
  }
}


provider "grafana" {
  alias               = "oncall"
  oncall_access_token = "<redacted>"
  oncall_url          = "http://localhost:8080/"
}

data "grafana_oncall_user" "joey" {
  provider = grafana.oncall
  username = "joey"
}

data "grafana_oncall_user" "bob" {
  provider = grafana.oncall
  username = "bob"
}

resource "grafana_oncall_on_call_shift" "example_shift" {
  provider = grafana.oncall
  name       = "Example Shift"
  type       = "rolling_users"
  start      = "2024-09-19T14:00:00"
  duration   = 60 * 60 * 12
  frequency  = "weekly"
  interval   = 1
  by_day     = ["MO", "TU", "WE", "TH", "FR"]
  week_start = "MO"
  rolling_users = [
    ["foo"],
    ["bar"],
    # [data.grafana_oncall_user.bob.id],
    # [data.grafana_oncall_user.joey.id],
  ]
  time_zone = "UTC"
}

resource "grafana_oncall_schedule" "example_schedule" {
  provider = grafana.oncall
  name      = "Example Calendar Schadule"
  type      = "calendar"
  time_zone = "America/New_York"
  shifts = [
    grafana_oncall_on_call_shift.example_shift.id,
  ]
}

Then:

❯ terraform apply
data.grafana_oncall_user.bob: Reading...
data.grafana_oncall_user.joey: Reading...
data.grafana_oncall_user.joey: Read complete after 0s [id=U95J3KBUFXM8J]
data.grafana_oncall_user.bob: Read complete after 0s [id=USSSBK861DG8H]

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # grafana_oncall_on_call_shift.example_shift will be created
  + resource "grafana_oncall_on_call_shift" "example_shift" {
      + by_day        = [
          + "FR",
          + "MO",
          + "TH",
          + "TU",
          + "WE",
        ]
      + duration      = 43200
      + frequency     = "weekly"
      + id            = (known after apply)
      + interval      = 1
      + name          = "Example Shift"
      + rolling_users = [
          + [
              + "foo",
            ],
          + [
              + "bar",
            ],
        ]
      + start         = "2024-09-19T14:00:00"
      + time_zone     = "UTC"
      + type          = "rolling_users"
      + week_start    = "MO"
    }

  # grafana_oncall_schedule.example_schedule will be created
  + resource "grafana_oncall_schedule" "example_schedule" {
      + id        = (known after apply)
      + name      = "Example Calendar Schadule"
      + shifts    = (known after apply)
      + time_zone = "America/New_York"
      + type      = "calendar"
    }

Plan: 2 to add, 0 to change, 0 to destroy.

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

grafana_oncall_on_call_shift.example_shift: Creating...
grafana_oncall_on_call_shift.example_shift: Creation complete after 0s [id=ORYHWWAVT9D6Y]
grafana_oncall_schedule.example_schedule: Creating...
grafana_oncall_schedule.example_schedule: Creation complete after 0s [id=SXAGQRJCI1AH4]

Apply complete! Resources: 2 added, 0 changed, 0 destroyed.

The oncall shift is created and persisted as such:

{
    "id": 3,
    "public_primary_key": "ORYHWWAVT9D6Y",
    "name": "Example Shift",
    "time_zone": "UTC",
    "source": 3,
    "rolling_users": "[{}, {}]",
    "start_rotation_from_user_index": 0,
    "uuid": "17adca68f6ee43ec9a7a56008f7896f4",
    "type": 2,
    "start": "2024-09-19 14:00:00",
    "duration": 43200000000,
    "frequency": 1,
    "priority_level": 0,
    "interval": 1,
    "week_start": 0,
    "by_day": "[\"MO\", \"WE\", \"FR\", \"TU\", \"TH\"]",
    "by_month": null,
    "by_monthday": null,
    "organization_id": 1,
    "team_id": null,
    "until": null,
    "schedule_id": null,
    "rotation_start": "2024-09-19 14:00:00",
    "updated_shift_id": null
  }

What did you expect to happen:
I would expect the OnCall API and/or Terraform to complain about the values being passed not being valid Grafana OnCall user IDs

How do we reproduce it?

See above steps for detailed repro steps

Grafana OnCall Version

v1.9.25

Product Area

Terraform/Crossplane

Grafana OnCall Platform?

None

User's Browser?

No response

Anything else to add?

No response