oatts-cypress

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>processing - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="compilation.html">compilation</a><ul class='methods'><li data-type='method'><a href="compilation.html#compile">compile</a></li><li data-type='method'><a href="compilation.html#compileOperationLevel">compileOperationLevel</a></li><li data-type='method'><a href="compilation.html#compilePathLevel">compilePathLevel</a></li><li data-type='method'><a href="compilation.html#compileTransactionLevel">compileTransactionLevel</a></li><li data-type='method'><a href="compilation.html#prepareTemplate">prepareTemplate</a></li></ul></li><li><a href="processing.html">processing</a><ul class='methods'><li data-type='method'><a href="processing.html#determineQueryType">determineQueryType</a></li><li data-type='method'><a href="processing.html#isNumberType">isNumberType</a></li><li data-type='method'><a href="processing.html#lookupCustomQueryValue">lookupCustomQueryValue</a></li><li data-type='method'><a href="processing.html#lookupCustomValue">lookupCustomValue</a></li><li data-type='method'><a href="processing.html#pathify">pathify</a></li><li data-type='method'><a href="processing.html#process">process</a></li><li data-type='method'><a href="processing.html#processHeaders">processHeaders</a></li><li data-type='method'><a href="processing.html#processOperations">processOperations</a></li><li data-type='method'><a href="processing.html#processParams">processParams</a></li><li data-type='method'><a href="processing.html#processPaths">processPaths</a></li><li data-type='method'><a href="processing.html#processResponse">processResponse</a></li><li data-type='method'><a href="processing.html#processTransactions">processTransactions</a></li><li data-type='method'><a href="processing.html#replaceNewlines">replaceNewlines</a></li></ul></li><li><a href="templateHelpers.html">templateHelpers</a><ul class='methods'><li data-type='method'><a href="templateHelpers.html#isNotDefaultStatusCode">isNotDefaultStatusCode</a></li><li data-type='method'><a href="templateHelpers.html#json">json</a></li><li data-type='method'><a href="templateHelpers.html#notEmptyObject">notEmptyObject</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html">generate</a></li><li><a href="global.html">merge2</a></li></ul> </nav> <div id="main"> <h1 class="page-title">processing</h1> <section> <header> <h2> processing </h2> </header> <article> <div class="container-overview"> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line21">line 21</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="determineQueryType"><span class="type-signature"></span>determineQueryType<span class="signature">(param)</span><span class="type-signature"> → {string}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line537">line 537</a> </li></ul></dd> </dl> <div class="description"> Determines the proper type for the Query parameter </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>param</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">sway Parameter object to investigate</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="isNumberType"><span class="type-signature"></span>isNumberType<span class="signature">(type)</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line524">line 524</a> </li></ul></dd> </dl> <div class="description"> evaluates if the given type is an OpenAPI number type or not </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">type to be evaluated</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="lookupCustomQueryValue"><span class="type-signature"></span>lookupCustomQueryValue<span class="signature">(code, op, path, options)</span><span class="type-signature"> → {any}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line347">line 347</a> </li></ul></dd> </dl> <div class="description"> resolves any custom query values available for the given operation and path </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>code</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">response status code being evaluated</td> </tr> <tr> <td class="name"><code>op</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the operation method being processed</td> </tr> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">API path being processed</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">for use in looking up the custom value</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">any</span> </dd> </dl> <h4 class="name" id="lookupCustomValue"><span class="type-signature"></span>lookupCustomValue<span class="signature">(name, location, code, op, path, options)</span><span class="type-signature"> → {any}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line312">line 312</a> </li></ul></dd> </dl> <div class="description"> resolves any custom values available for the given parameter </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">parameter name being looked up</td> </tr> <tr> <td class="name"><code>location</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">where the parameter is in the request/response</td> </tr> <tr> <td class="name"><code>code</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">response status code being evaluated</td> </tr> <tr> <td class="name"><code>op</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the operation method being processed</td> </tr> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">API path being processed</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">for use in looking up the custom value</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">any</span> </dd> </dl> <h4 class="name" id="pathify"><span class="type-signature"></span>pathify<span class="signature">(path, param, value)</span><span class="type-signature"> → {string}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line501">line 501</a> </li></ul></dd> </dl> <div class="description"> replaces the path paremeter in the given URL path with a sample value </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">URL path to be pathified</td> </tr> <tr> <td class="name"><code>param</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">sway Parameter object to use in pathify</td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> </td> <td class="description last">a custom value to use in the pathify</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="process"><span class="type-signature"></span>process<span class="signature">(api, options)</span><span class="type-signature"> → {<a href="processing.html#.ProcessedSpec">processing.ProcessedSpec</a>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line38">line 38</a> </li></ul></dd> </dl> <div class="description"> Processes the given API spec, creating test data artifacts </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>api</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">API spec object to be processed</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">options to be used during processing</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type"><a href="processing.html#.ProcessedSpec">processing.ProcessedSpec</a></span> </dd> </dl> <h4 class="name" id="processHeaders"><span class="type-signature"></span>processHeaders<span class="signature">(responseCode, op, path, top, options)</span><span class="type-signature"> → {object}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line378">line 378</a> </li></ul></dd> </dl> <div class="description"> Determines the request headers for a transaction </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>responseCode</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">response code being processed</td> </tr> <tr> <td class="name"><code>op</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parent operation object</td> </tr> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parent path object</td> </tr> <tr> <td class="name"><code>top</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">global properties</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">for use in processing headers</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id="processOperations"><span class="type-signature"></span>processOperations<span class="signature">(api, parentPath, topLevel, options)</span><span class="type-signature"> → {Array.<processing.ProcessedOp>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line140">line 140</a> </li></ul></dd> </dl> <div class="description"> Processes the operations of the given Path object </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>api</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parsed OpenAPI spec object</td> </tr> <tr> <td class="name"><code>parentPath</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">sway Path object being processed</td> </tr> <tr> <td class="name"><code>topLevel</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">global spec properties</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">options to use during processing</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">Array.<processing.ProcessedOp></span> </dd> </dl> <h4 class="name" id="processParams"><span class="type-signature"></span>processParams<span class="signature">(code, op, path, options)</span><span class="type-signature"> → {<a href="processing.html#.ProcessedParams">processing.ProcessedParams</a>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line247">line 247</a> </li></ul></dd> </dl> <div class="description"> Processes the parameters of a Path + Operation for use in a test </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>code</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">response status code being processed</td> </tr> <tr> <td class="name"><code>op</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">sway Operation object that's being processed</td> </tr> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">sway Path object that's being process</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">options to use during processing</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type"><a href="processing.html#.ProcessedParams">processing.ProcessedParams</a></span> </dd> </dl> <h4 class="name" id="processPaths"><span class="type-signature"></span>processPaths<span class="signature">(api, topLevel, options)</span><span class="type-signature"> → {Array.<<a href="processing.html#.ProcessedPath">processing.ProcessedPath</a>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line78">line 78</a> </li></ul></dd> </dl> <div class="description"> Processes the paths defined by the api spec, or indicated by the options </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>api</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parsed OpenAPI spec object</td> </tr> <tr> <td class="name"><code>topLevel</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">global spec properties</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">options to use during processing</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">Array.<<a href="processing.html#.ProcessedPath">processing.ProcessedPath</a>></span> </dd> </dl> <h4 class="name" id="processResponse"><span class="type-signature"></span>processResponse<span class="signature">(res, op, path, options)</span><span class="type-signature"> → {<a href="processing.html#.ExpectedResponse">processing.ExpectedResponse</a>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line463">line 463</a> </li></ul></dd> </dl> <div class="description"> Processes a sway Response for use in a test </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>res</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">sway Response object being processed</td> </tr> <tr> <td class="name"><code>op</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the operation method being processed</td> </tr> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">API path being processed</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">options to use during processing</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type"><a href="processing.html#.ExpectedResponse">processing.ExpectedResponse</a></span> </dd> </dl> <h4 class="name" id="processTransactions"><span class="type-signature"></span>processTransactions<span class="signature">(api, parentOp, parentPath, topLevel, options)</span><span class="type-signature"> → {Array.<<a href="processing.html#.ProcessedTransaction">processing.ProcessedTransaction</a>>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line184">line 184</a> </li></ul></dd> </dl> <div class="description"> Processes the transactions for a given Path + Operation </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>api</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parsed OpenAPI spec object</td> </tr> <tr> <td class="name"><code>parentOp</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parent sway Operation object being processed</td> </tr> <tr> <td class="name"><code>parentPath</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">parent sway Path object being processed</td> </tr> <tr> <td class="name"><code>topLevel</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">global spec properties</td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">options to use during processing</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">Array.<<a href="processing.html#.ProcessedTransaction">processing.ProcessedTransaction</a>></span> </dd> </dl> <h4 class="name" id="replaceNewlines"><span class="type-signature"></span>replaceNewlines<span class="signature">(str)</span><span class="type-signature"> → {string}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line556">line 556</a> </li></ul></dd> </dl> <div class="description"> Used to replace newlines with a space in each response.description </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">string to replace newlines with spaces</td> </tr> </tbody> </table> <h5>Returns:</h5> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h3 class="subsection-title">Type Definitions</h3> <h4 class="name" id=".ExpectedResponse">ExpectedResponse</h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line454">line 454</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>statusCode</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">expected response status code</td> </tr> <tr> <td class="name"><code>custom</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">indicates if the value was a custom injection</td> </tr> <tr> <td class="name"><code>res</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">expected response body, if applicable; can be a generated sample</td> </tr> </tbody> </table> <div class="description"> ExpectedResponse is the expected response generated based on the API spec </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <h4 class="name" id=".ProcessedParams">ProcessedParams</h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line237">line 237</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">processed path with path parameter sample substitutions</td> </tr> <tr> <td class="name"><code>body</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">the request body params</td> </tr> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">the request query params</td> </tr> <tr> <td class="name"><code>formData</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">the request form data params</td> </tr> </tbody> </table> <div class="description"> ProcessedParams is an object representing the processed request parameters for unit test compilation </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <h4 class="name" id=".ProcessedPath">ProcessedPath</h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line69">line 69</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">name to be used in generation of a file name; based on the path</td> </tr> <tr> <td class="name"><code>pathLevelDescription</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the brief description to use at the top level 'describe' block</td> </tr> <tr> <td class="name"><code>operations</code></td> <td class="type"> <span class="param-type">Array.<processing.ProcessedOp></span> </td> <td class="description last">Collection of operations processed for test compilation</td> </tr> </tbody> </table> <div class="description"> ProcessedPath is the fully traversed path resource ready for unit test compilation </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <h4 class="name" id=".ProcessedSpec">ProcessedSpec</h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line27">line 27</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>host</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Hostname to be used in the test requests; derived from the options or spec</td> </tr> <tr> <td class="name"><code>scheme</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">HTTP schema to be used in the test requests; derived from the spec</td> </tr> <tr> <td class="name"><code>basePath</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Base path as defined by the spec</td> </tr> <tr> <td class="name"><code>consumes</code></td> <td class="type"> <span class="param-type">Array.<string></span> </td> <td class="description last">Global content type 'consumes' collection</td> </tr> <tr> <td class="name"><code>tests</code></td> <td class="type"> <span class="param-type">Array.<ProcessedPath></span> </td> <td class="description last">Collection of paths processed for test compilation</td> </tr> </tbody> </table> <div class="description"> ProcessedSpec is the fully traversed spec processed for unit test compilation </div> <h5>Type:</h5> <ul> <li> <span class="param-type">object</span> </li> </ul> <h4 class="name" id=".ProcessedTransaction">ProcessedTransaction</h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_process.js.html">lib/process.js</a>, <a href="lib_process.js.html#line167">line 167</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>testLevelDescription</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the brief description to use in the test 'it' block</td> </tr> <tr> <td class="name"><code>scheme</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">copied from the globally defined HTTP schema</td> </tr> <tr> <td class="name"><code>host</code></td> <td class="type"> <span class="param-type">string</span> </td>