@unito/integration-debugger/dist/src/services/stepChecks/requestSchema.d.ts

The Unito Integration Debugger

import * as CrawlerDriver from '../crawlerDriver';
type Value = string | boolean | number | string[] | boolean[] | number[];
export declare const encodeObjectToQueryString: (obj: Record<string, Value>) => string;
/**
 * Check: Request schema of an item.
 *
 * @example
 * The following itemSummary represents an item fetchable with dynamic parameters:
 * {
 *  "data": [
 *   {
 *     "path": "/my/super/path/custom",
 *     "requestSchema": {
 *      "parameters": [{
 *        "name": "firstParam",
 *        "type": "string",
 *        "nullable": true
 *      }]
 *   }]
 * }
 *
 * The path with dynamic parameters wont be automatically infer by the crawler. It needs to be generated.
 * A new step will be added to the crawler with the generated path.
 *
 */
declare const check: CrawlerDriver.StepCheck;
export default check;