From 5617e5c6139c05cf60ab7748b7ba135a1189b3a4 Mon Sep 17 00:00:00 2001 From: Yury Semikhatsky Date: Fri, 10 Jun 2022 16:53:01 -0700 Subject: [PATCH] docs: route.har options for non-js clients (#14804) --- docs/src/api/class-route.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/src/api/class-route.md b/docs/src/api/class-route.md index 0fc5a9e775..a1d188f328 100644 --- a/docs/src/api/class-route.md +++ b/docs/src/api/class-route.md @@ -217,6 +217,7 @@ Optional response body as text. Optional response body as raw bytes. ### option: Route.fulfill.har +* langs: js - `har` <[Object]> - `path` <[string]> Path to the HAR file. - `fallback` ?<[RouteHARFallback]<"abort"|"continue"|"throw">> Behavior in the case where matching entry was not found in the HAR. Either [`method: Route.abort`] the request, [`method: Route.continue`] it, or throw an error. Defaults to "abort". @@ -224,6 +225,21 @@ Optional response body as raw bytes. HAR file to extract the response from. If HAR file contains an entry with the matching url and HTTP method, then the entry's headers, status and body will be used to fulfill. An entry resulting in a redirect will be followed automatically. Individual fields such as headers can be overridden using fulfill options. If `path` is a relative path, then it is resolved relative to the current working directory. +### option: Route.fulfill.harPath +* langs: csharp, java, python + - alias-python: har_path +- `harPath` <[path]> + +HAR file to extract the response from. If HAR file contains an entry with the matching url and HTTP method, then the entry's headers, status and body will be used to fulfill. An entry resulting in a redirect will be followed automatically. Individual fields such as headers can be overridden using fulfill options. +If `path` is a relative path, then it is resolved relative to the current working directory. + +### option: Route.fulfill.harFallback +* langs: csharp, java, python + - alias-python: har_fallback +- `harFallback` ?<[RouteHARFallback]<"abort"|"continue"|"throw">> + +Behavior in the case where matching entry was not found in the HAR. Either [`method: Route.abort`] the request, [`method: Route.continue`] it, or throw an error. Defaults to "abort". + ### option: Route.fulfill.path - `path` <[path]>