v1

latestOpenAPI 3.0.32026-07-1771012.0 KB

Send resources to the server to be analyzed. It returns the test plan that would be executed but without executing it.<br/> This operation can work in three different ways:<br/>

<li> <b>Send a single resource in the request body as plain text</b><br/> For simple test plans formed by a single file. The parameter <code>resourceType</code> must be informed. </li> <li> <b>Send a set of resources in the request body as a JSON object</b><br/> For medium plans formed by a set of files, including a configuration file.<br/> The request body would be a JSON object where each property name is a file path and its value is the file content, with the proper characters escaped. </li> <li> <b>Sending a local directory and no body</b><br/> For medium-large plans that are stored in the same machine that the execution server. The parameter <code>workspace</code> must be informed.<br/> This should be the preferred method for large projects, due to the amount of net traffic required otherwise. </li>
post/plans

Query parameters

resourceTypestring

Only used when a single resource is sent as plain text. Set the Wakamiti resource type for that content (e.g. <code>gherkin</code>).

workspacestring

The local path where the test resources are located. The request body must be empty.

Response

OK