Normalized environment variable

forcedotcom / postman-salesforce-apis

Salesforce API Postman Collection

Creative Commons Zero v1.0 Universal

1.08k stars 652 forks source link

Normalized environment variable #10

Closed scolladon closed 4 years ago

scolladon commented 4 years ago

Define naming convention to distinguish settable by user variable and variable set by the system

pozil commented 4 years ago

Proposed convention: uppercase text surrounded with <>:

<REPLACE_ME>

scolladon commented 4 years ago

I propose the following :

all variable should be lower camel case: myVariable
variable set by the user should start by a letter: userSettableVariable
variable set by the system should start by an underscore: _systemSettableVariable

applied to existing : url => url version => version username => username password => password secret_token => secretToken clientId => clientId clientSecret => clientSecret redirectUrl => redirectUrl init_access_token => initAccessToken site => site key => to remove : seems to not be used env => to remove : seems to not be used orgId => _orgId userId => _userId endpoint => _endpoint access_token => _accessToken refreshtoken => refreshToken

pozil commented 4 years ago

Sounds good, let's try to separate two concepts in docs: variables and placeholders.

Here's what I propose as definitions:

Variables are set in the Postman Environment dialog. This doesn't modify the requests. Syntax: we use the convention that you defined.
Placeholders are request parts that needs to be replaced with a value. This modifies the requests. Syntax: uppercase text with underscores surrounded with <>

scolladon commented 4 years ago

Wonderfull ! I think we don't need to add placeholder in the template environment, they will be added when we set them in the code. This way we expose the variable in the environment template and we let the scripts add the system one it requires : url => url version => version username => username password => password secret_token => secretToken clientId => clientId clientSecret => clientSecret redirectUrl => redirectUrl init_access_token => initAccessToken site => site key => to remove : seems to not be used env => to remove : seems to not be used orgId => removed from template userId => removed from template endpoint => removed from template access_token => removed from template refresh_token => removed from template other set variable like jobId and batchId should be removed