fix: github_rest_api data source always returns header and body as null

[srgustafson8]

Resolves #2109

---

Before the change?

• The GitHub REST API data source would always return null or incomplete map values for body and headers attributes.

After the change?

• The GitHub REST API data source now returns the body and headers attributes as a JSON string, allowing users to decode them and use them.

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

• Yes
• No

This is technically a breaking change as it changes the type of the attributes involved to strings rather than maps - however, as this would have almost never worked properly, i'm not sure how much breaking it would do.

---

[srgustafson8]

Tests:

--- PASS: TestAccGithubRestApiDataSource (32.38s)
    --- PASS: TestAccGithubRestApiDataSource/queries_an_existing_branch_without_error (16.16s)
        --- SKIP: TestAccGithubRestApiDataSource/queries_an_existing_branch_without_error/with_an_anonymous_account (0.00s)
        --- PASS: TestAccGithubRestApiDataSource/queries_an_existing_branch_without_error/with_an_individual_account (8.15s)
        --- PASS: TestAccGithubRestApiDataSource/queries_an_existing_branch_without_error/with_an_organization_account (8.02s)
    --- PASS: TestAccGithubRestApiDataSource/queries_an_invalid_branch_without_error (16.22s)
        --- SKIP: TestAccGithubRestApiDataSource/queries_an_invalid_branch_without_error/with_an_anonymous_account (0.00s)
        --- PASS: TestAccGithubRestApiDataSource/queries_an_invalid_branch_without_error/with_an_individual_account (8.26s)
        --- PASS: TestAccGithubRestApiDataSource/queries_an_invalid_branch_without_error/with_an_organization_account (7.95s)
PASS
ok      github.com/integrations/terraform-provider-github/v5/github     33.171s

[kfcampbell]

Confirming integration tests are passing for me as well. I'm comfortable releasing this as a minor change given the broken nature of the behavior before. We will be releasing #2091 soon though, so stay tuned!

[riezebosch]

Trying out this new behaviour and I do see the headers having value in my state file but the body is still always null? I think, when working, this would also solve #1776 and #1953.

I think I solved it: #2152

[srgustafson8]

EDIT: I took a look at your original issue 1776 and I see what you mean now, while my implementation works for the calls that return a map, it doesn't for calls that return an array. Good catch.

---

hi @riezebosch - can you give some more info on what you're trying and seeing? If i try to use it, I get body populated correctly (on calls that don't fail with 404 or other things where body would be null).

e.g.

terraform {
  required_providers {
    github = {
      source  = "integrations/github"
      version = "6.0.0"
    }
  }
}

provider "github" {}

data "github_rest_api" "test" {
  endpoint = "repos/integrations/terraform-provider-github/git/refs/heads/main"
}

gives me in state, trimmed for brevity:

  "resources": [
    {
      "mode": "data",
      "type": "github_rest_api",
      "name": "test",
      "provider": "provider[\"registry.terraform.io/integrations/github\"]",
      "instances": [
        {
          "schema_version": 0,
          "attributes": {
            "body": "{\"node_id\":\"MDM6UmVmOTM0NDYwOTk6cmVmcy9oZWFkcy9tYWlu\",\"object\":{\"sha\":\"16872b724254fdddc3441c713b087cb4d7005f83\",\"type\":\"commit\",\"url\":\"https://api.github.com/repos/integrations/terraform-provider-github/git/commits/16872b724254fdddc3441c713b087cb4d7005f83\"},\"ref\":\"refs/heads/main\",\"url\":\"https://api.github.com/repos/integrations/terraform-provider-github/git/refs/heads/main\"}",
            "code": 200,
            "headers": "{\"Access-Control-Allow-Origin\":[\"*\"],\"Access-Control-Expose-Headers\" etc etc....",
            "status": "200 OK"
          },
          "sensitive_attributes": []
        }
      ]
    }
  ],

[riezebosch]

See my pr #2152