Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lack in documentation -> #222

Open
docbyte86 opened this issue Jan 22, 2024 · 3 comments
Open

Lack in documentation -> #222

docbyte86 opened this issue Jan 22, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@docbyte86
Copy link

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

@hcsa73 hcsa73 added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation and removed dependencies Pull requests that update a dependency file labels Jan 22, 2024
@joaopalet
Copy link
Contributor

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
Copy link
Author

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
Copy link
Contributor

joaopalet commented Jan 31, 2024

(...) 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants