Input validation functions for specific parameter sets. about azure-sdk-for-go HOT 4 CLOSED

@aznashwan thanks for the suggestion. My question is what do you mean for "validation"? (e.g. is it a check for required parameters, input format of certain fields etc?)

from azure-sdk-for-go.

Most prevalent example are all the string configuration options scattered around the various resources.
By validation; I mean a way to be ensure that the inputs are valid (prefferably even without making API calls at all).
ex:

func isValidProtocol(protocol string) bool {
     validProtocols := map[string]bool {
         "TCP": true,
         "UDP": true,
         "*": true,
     }
    return validProtocols[protocol] 
}

This can be applied further to a bunch of of other things (ex: given hosted service name contains disallowed characters, given disk size is preposterous etc...)

from azure-sdk-for-go.

@aznashwan unfortunately we consciously removed those checks from the client and we don't want to have those. Here are the reasons:

1. We think client library should be dumb enough and not be aware of the server's logic.
2. Adding validation to the client “duplicates” the functionality. (e.g. in both cases, we return an error anyway)
3. Having such logic at the client makes it possible to easily go “out of sync” (e.g. max chars for hosted service name can be increased on the API but client would require update to support it).

We try to don't do such validations in our hand-written SDKs (because they're hard to maintain and rarely add value). For the new Azure Resource Management SDKs (that will be code-generated), we may do this if the valid input(s)/formats are part of the model spec.

from azure-sdk-for-go.

All very fair points indeed; some of them having crossed my mind as well.

from azure-sdk-for-go.