Understanding how the generator produces such customized code

[Sys-Pix]

Hi,

I’ve been exploring the terraform-provider-ovh and I’d like to understand more about how the code generation process works.
Where can I find the JSON input used by the Terraform Plugin Framework Code Generator ?

Any guidance or pointers to documentation, example JSON files, or relevant parts of the source code would be greatly appreciated

Thanks for your work on this project

[rbeuque74]

Hello,
The JSON are the specification of our API.

You can find them here:
Meta schemas: https://eu.api.ovh.com/v1/
Linking to each "section" schemas: https://eu.api.ovh.com/v1/cloud.json?format=openapi3

(query parameter format=openapi3 is important here for the Terraform Plugin Framework Code Generator)

If you have other question, feel free !

[Sys-Pix]

Hello @rbeuque74

Thanks a lot for you answer

I still have a few follow-up questions if you don't mind - just to better understand some of the internal steps and how everything ties together.

curl "https://eu.api.ovh.com/v1/cloud.json?format=openapi3" -o openapi.json

tfplugingen-openapi generate \
  --config ./generator_config.yml \
  --output ./provider_code_spec.json \
  ./openapi.json

Do you use tfplugingen-openapi to generate the provider_code_spec.json ? If not, what tools do you use ?

Here is the generator_config.yml file i used to do some tests

---
provider:
  name: test
  
data_sources:
  cloud_project_gateway:
    read:
      path: /cloud/project/{serviceName}/region/{regionName}/gateway/{id}
      method: GET

tfplugingen-framework generate data-sources \
  --input ./provider_code_spec.json \
  --output test \
  --package test

So far it mostly works. I can generate the code and it runs fine - However the generated class doesn't include custom types.
I'm wondering if I might have missed a step or a configuration option during the generation process

Also, is there any plan to automate this in the future - for example, to automatically re-generate all the _gen.go files when doing a version bump or schema update ?

BR

[amstuta]

Hello @Sys-Pix,

We currently rely on a fork of tfplugingen-framework to handle custom types in the generated files. However this fork is not ready to be open-sourced so you won't be able to use it for now.
If you are willing to generate resources for our provider, one thing that is feasible is to use the official generator and just write the code to convert API responses to Terraform types.

Regarding the auto-update of generated resources, it is indeed planned but I cannot give you an ETA for now :)

[amstuta]

I'm closing this issue but don't hesitate to open another one if you have any questions :)