Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Name: Unique name for this parameter (at this level)
  • From: Where will the value need to come from
    • query is for simple values and used with GET HTTP methods
    • header parameter are not commonly used as parameters, but they are supported
    • body is for more complex values such as all of the parameters for adding a new customer
      • body parameters are not supported with HTTP GET or DELETE methods.
  • Data type: The type of value that will be sent to the API.
    • When "from" is set to "body", a new item becomes available called "object", allowing for complex parameters.
    • If a parameter is defined as an integer and the parameter value contains alpha characters, an error will be returned to the caller before your API logic is called.
  • Required: Check if the parameter must be passed and must have a valid value.
    • When a parameter is defined as required and the parameter is not passed, an error will be returned to the caller before your API logic is called.
  • Example: An example of what the parameter value should be.
  • Allow Multiples: Check if the parameter should be an Array.
    • If a parameter is defined as an Array, but parameter value passed is not an array, an array will be created with that value as the only element, and then passed to your API logic
    • If a parameter is not defined as an Array, but parameter value is an array, the first valid value from that array will be passed to your API logic
  • Deprecated: Check this if you want to mark this parameter as deprecated or soon to be removed. The parameter will appear as deprecated in the Documenting Your APIs.
  • Description: Describes the parameter.  This field supports CommonMark.

...