Merge pull request #27 from danielgtaylor/autoconfig-exclude

feat: ability to exclude autoconfig prompt vars

Author: danielgtaylor

cli/autoconfig.go

@@ -7,6 +7,10 @@ type AutoConfigVar struct {
 	Example     string        `json:"example,omitempty"`
 	Default     interface{}   `json:"default,omitempty"`
 	Enum        []interface{} `json:"enum,omitempty"`
+
+	// Exclude the value from being sent to the server. This essentially makes
+	// it a value which is only used in param templates.
+	Exclude bool `json:"exclude,omitempty"`
 }
 
 // AutoConfig holds an API's automatic configuration settings for the CLI. These

cli/interactive.go

@@ -95,21 +95,32 @@ func askLoadBaseAPI(a asker, config *APIConfig) {
 					def = fmt.Sprintf("%v", v.Default)
 				}
 
+				// If a description is present, prefer to display it over the variable
+				// name used a server arguments or in templates, since you don't
+				// always have control over that value.
+				promptText := name
+				if v.Description != "" {
+					promptText = v.Description
+				}
+
 				if len(v.Enum) > 0 {
 					enumStr := []string{}
 					for val := range v.Enum {
 						enumStr = append(enumStr, fmt.Sprintf("%v", val))
 					}
-					responses[name] = a.askSelect(name, enumStr, def, v.Description)
+					responses[name] = a.askSelect(promptText, enumStr, def, "")
 				} else {
-					responses[name] = a.askInput(name, def, v.Default == nil, v.Description)
+					responses[name] = a.askInput(promptText, def, v.Default == nil, "")
 				}
 			}
 
 			// Generate params from user inputs.
 			params := map[string]string{}
 			for name, resp := range responses {
-				params[name] = resp
+				// Only include the param if the variable wasn't excluded.
+				if !ac.Prompt[name].Exclude {
+					params[name] = resp
+				}
 			}
 
 			for name, template := range ac.Auth.Params {

docs/openapi.md

@@ -88,20 +88,21 @@ Valid types for the security setting when not using a security scheme defined wi
 | `oauth-client-credentials` | OAuth2 pre-shared client key/secret (m2m) |
 | `oauth-authorization-code` | OAuth2 authorization code (user login)    |
 
-By default, all prompt variables become auth parameters of the same name. Additionally, a template system can be used to augment the value or create new params. Any value within `{...}` will get replaced by the value of the param with the given name. For example:
+By default, all prompt variables become auth parameters of the same name. This can be disabled by setting `exclude` to `true` if desired. Additionally, a template system can be used to augment the value or create new params. Any value within `{...}` will get replaced by the value of the param with the given name. For example:
 
 ```yaml
 x-cli-config:
   prompt:
     org:
       description: Organization ID
       example: github
+      exclude: true
   params:
     audience: https://example.com/{org}
     some_static_value: foo
 ```
 
-The above will prompt the user for an `org` and then fill in the params using the value from the user when creating the API configuration profile.
+The above will prompt the user for an `org` and then fill in the params using the value from the user when creating the API configuration profile. Since `exclude` is set, the `org` parameter is never sent to the server and is only used to fill in the param template for `audience`.
 
 #### Auth Parameters