chore: Define conversion function for generating API request body from Resource Model in create (non-nested) #3239
Conversation
| tagKey = "autogeneration" | ||
| tagValOmitJSON = "omitjson" | ||
| tagValCreateOnly = "createonly" |
There was a problem hiding this comment.
Giving some more thought to the naming, would omitjsonupdate over createonly be more consistent?
There was a problem hiding this comment.
good idea, changed here: d6c212b
| ) | ||
|
|
||
| // Marshal gets a Terraform model and marshals it into JSON (e.g. for an Atlas request). | ||
| func Marshal(model any, isCreate bool) ([]byte, error) { |
There was a problem hiding this comment.
Would leave an additional comment clarifying when attributes are sent in payload, and how use of tags changes that behaviour
| AttrString types.String `tfsdk:"attribute_string"` | ||
| // values with tag `omitjson` are not marshaled, and they don't need to be Terraform types | ||
| AttrOmit types.String `tfsdk:"attribute_omit" autogeneration:"omitjson"` | ||
| AttrOmitNoTerraform string `autogeneration:"omitjson"` |
There was a problem hiding this comment.
Any particular reason why this is not types.String? Would also define it with a known string value to ensure it is never sent even if it has a value in the config
There was a problem hiding this comment.
do you mean AttrOmitNoTerraform? It's to prove that in this case you can use "invalid" types that are not Terraform types in the model, and that's ok because it's not sent in JSON, like explained in the comment above.
In the normal case it would panic if the model has an attribute that is not Terraform, e.g test here
There was a problem hiding this comment.
Aah makes sense, I see AttrOmit covers the case i was mentioning, thanks!
| for i := 0; i < valModel.NumField(); i++ { | ||
| attrTypeModel := valModel.Type().Field(i) | ||
| tag := attrTypeModel.Tag.Get(tagKey) | ||
| if tag == tagValOmitJSON { |
There was a problem hiding this comment.
@lantoli
Would it be worth supporting multiple tags: "autogeneration:omitjson,{futureTag}"? Probably, it can happen at a later stage
There was a problem hiding this comment.
@EspenAlbert yes, it makes sense, but didn't want to anticipate until we don't need it, this code would be very easy to adapt when neeeded
Description
Define conversion function for generating API request body from Resource Model in create (non-nested).
Marshalis used to create the Atlas request from the Terraform plan model. It's called in operations that need to create an Atlas request payload, i.e.CreateandUpdate. It's not used inRead,DeleteorImport.Unmarshalis used to update the Terraform model from the Atlas response. It's called inCreate,UpdateandRead. It's not used inDeleteorImport.It supports an
autogenerationtag in model struct fields that can have:omitjson: Field will never be marshaled into JSON, useful for attributes not needed in Atlas requests like timeouts or computed values.omitjsonupdate: Field that is not marshaled into JSON when it's an update, this field is sent only when the resource is created.Link to any related issue(s): CLOUDP-310079
Type of change:
Required Checklist:
Further comments