turnstile: rename id to sitekey

[vasilevalex]

Fixes #3093

[github-actions]

changelog detected ✅

[jacobbednarz]

thanks for the PR! unfortunately, it can't be accepted as is. all resources must have the id field as part of their schema. where it overlaps with another identifier, behind the scenes we can just reuse that value.

[vasilevalex]

Hi @jacobbednarz
Yes, sorry I don't have experience of terraform provider development. I just wanted to use widget for my small Hugo blog hosted on Cloudflare Pages. And with this patch I at least created the widget.

So if you can help me with some questions:

1. What should regular user expect to receive from terraform? 'id' with several comments everywhere in the examples and in the documentation explaining that 'id' is actually sitekey. Or just use 'sitekey' the same way as it is implemented in API?
2. As I can see the code just remapps 'id' <-> 'sitekey'. But this document says that this "should not" be done: https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/contributing/provider-design.md I'm bit confused.

Thanks!

[jacobbednarz]

1. What should regular user expect to receive from terraform? 'id' with several comments everywhere in the examples and in the documentation explaining that 'id' is actually sitekey. Or just use 'sitekey' the same way as it is implemented in API?

the id is what we want here since it is used as an anchor for terraform operations and it is aliased to sitekey in the API calls. can you elaborate on what errors (with debug logs) drew you to make the change? @punkeel might be able to help diagnose how you got there with more context.

2. As I can see the code just remapps 'id' <-> 'sitekey'. But this document says that this "should not" be done: https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/contributing/provider-design.md I'm bit confused.

which part are you referring to? i'm not sure which part you mean however, using the sitekey (primary) value as the id something we do in most resources since they are unique.

[vasilevalex]

Thanks for the answers @jacobbednarz, I'll make changes.

[punkeel]

I suspect this sitekey/id is a red herring, and the real issue is around error handling in Terraform... at least, from what I've seen, every time the API returns an error, the state gets corrupted (which leads to a similar "id/sitekey is missing" error message).

Let me file a small PR, see if that helps