Skip to content
This repository has been archived by the owner on Oct 21, 2022. It is now read-only.

Fix content-type suggestion in inline documentation

Compare
Choose a tag to compare
@taylordowns2000 taylordowns2000 released this 08 Jul 20:23

The inline docs were displaying "content-type": "json", which isn't valid. Updated across functions to use "application/json":

/**
 * Make a POST request
 * @public
 * @example
 *  post("/myendpoint", {
 *      body: {"foo": "bar"},
 *      headers: {"content-type": "application/json"},
 *      authentication: {username: "user", password: "pass"},
 *    },
 *    function(state) {
 *      return state;
 *    }
 *  )
 * @function
 * @param {string} path - Path to resource
 * @param {object} params - Body, Query, Headers and Authentication parameters
 * @param {function} callback - (Optional) Callback function
 * @returns {Operation}
 */