Change the behavior of default parameter values

[webron]

Currently the UI displays and sends the default values of the parameters.
The default values are there for documentation purposes and should not be sent to the server.

We should add as flag that allows setting whether default values are sent or displayed only (should always be displayed for documentation), where I believe the default should be they are not sent. This would make the UI a better (even though basic) testing tool.

The challenge may be with non-text input such as drop downs and multi-selects, but even there we can check if it's the default value, just not send it.

[bherila]

How do you set default values, by the way?

[wing328]

If you're referring to the spec, then here is an example (default value of "" for the api_key header parameter):

      "delete": {
        "tags": [
          "pet"
        ],
        "summary": "Deletes a pet",
        "description": "",
        "operationId": "deletePet",
        "produces": [
          "application/json",
          "application/xml"
        ],
        "parameters": [
          {
            "name": "api_key",
            "in": "header",
            "description": "",
            "required": false,
            "type": "string"
            "default": ""
          },
          {
            "name": "petId",
            "in": "path",
            "description": "Pet id to delete",
            "required": true,
            "type": "integer",
            "format": "int64"
          }

Please refer to https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameter-object for more information

[bherila]

Thanks, sorry for the OT post by the way.

[thinkerbot]

Is there any discussion to add an example field to parameter objects in swagger itself? That might solve the issue... you could display the server-side default for documentation, then use the example kinda like you use the body parameter schema example... ie as a shortcut to fill in the form.

Note - the behavior you described above about not sending when the default value is selected seems erroneous to me, in that if I happen to specify the default value from a dropdown then I think it should send with the value I intentionally selected. Is it better stated that the parameter shouldn't be sent by default with the default value, but rather by default it should not be sent at all?

[webron]

@thinkerbot OAI/OpenAPI-Specification#636

[webron]

Closing as for an older version of the UI.