stackitcloud / terraform-provider-stackit

The official Terraform provider for STACKIT
https://registry.terraform.io/providers/stackitcloud/stackit
Apache License 2.0
34 stars 13 forks source link

Lack in documentation -> #222

Open docbyte86 opened 7 months ago

docbyte86 commented 7 months ago

Hello all,

there is a big lack in documentation of the terraform provider. It would be helpful to get the restrictions and input guidelines for the corresponding values.

For example SKE:

current situation:

name (String) The cluster name.

Expected entry:

name (String) Specifies the cluster name (lower case, alphanumeric, hypens allowed, up to 11 chars)

I think there is a big area for improvements

joaopalet commented 7 months ago

Hi,

Thanks for the suggestion! In most cases the validation is done by the API and in general when the restrictions/guidelines are not documented in the OAS we do not want to maintain them in the provider, as the services underneath might change it.

Still, we have created a new entry in our backlog to look into possible improvements in this area and will work on it soon.

docbyte86 commented 7 months ago

Hi @joaopalet , thank you very much. Does it make sense to raise a support request ticket to STACKIT, directly to improve the messages, received by the API, then?

joaopalet commented 7 months ago

(...) directly to improve the messages, received by the API (...)

Do you mean a ticket to improve the error messages returned by the STACKIT APIs?

In this provider we are using the STACKIT Go SDK (which is generated automatically from each service OAS) to make the requests to the STACKIT APIs. What I meant was that we are trying not to add field descriptions with restrictions in this provider that are not documented in OAS of the services. So in those cases we let the validation be done by the API itself and in case an error occurs we show the error message that returned