Add asResponse option to HttpService methods (#52434)

docs/development/core/public/kibana-plugin-public.httperrorresponse.md

@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-export interface HttpErrorResponse extends HttpResponse 
+export interface HttpErrorResponse extends IHttpResponse 
 ```
 
 ## Properties

docs/development/core/public/kibana-plugin-public.httpfetchoptions.asresponse.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) &gt; [asResponse](./kibana-plugin-public.httpfetchoptions.asresponse.md)
+
+## HttpFetchOptions.asResponse property
+
+When `true` the return type of [HttpHandler](./kibana-plugin-public.httphandler.md) will be an [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) with detailed request and response information. When `false`<!-- -->, the return type will just be the parsed response body. Defaults to `false`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+asResponse?: boolean;
+```

docs/development/core/public/kibana-plugin-public.httpfetchoptions.md

@@ -16,6 +16,7 @@ export interface HttpFetchOptions extends HttpRequestInit
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [asResponse](./kibana-plugin-public.httpfetchoptions.asresponse.md) | <code>boolean</code> | When <code>true</code> the return type of [HttpHandler](./kibana-plugin-public.httphandler.md) will be an [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) with detailed request and response information. When <code>false</code>, the return type will just be the parsed response body. Defaults to <code>false</code>. |
 |  [headers](./kibana-plugin-public.httpfetchoptions.headers.md) | <code>HttpHeadersInit</code> | Headers to send with the request. See [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md)<!-- -->. |
 |  [prependBasePath](./kibana-plugin-public.httpfetchoptions.prependbasepath.md) | <code>boolean</code> | Whether or not the request should automatically prepend the basePath. Defaults to <code>true</code>. |
 |  [query](./kibana-plugin-public.httpfetchoptions.query.md) | <code>HttpFetchQuery</code> | The query string for an HTTP request. See [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md)<!-- -->. |

docs/development/core/public/kibana-plugin-public.httphandler.md

@@ -2,12 +2,12 @@
 
 [Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [HttpHandler](./kibana-plugin-public.httphandler.md)
 
-## HttpHandler type
+## HttpHandler interface
 
-A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [HttpBody](./kibana-plugin-public.httpbody.md) for the response.
+A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) for the response.
 
 <b>Signature:</b>
 
 ```typescript
-export declare type HttpHandler = (path: string, options?: HttpFetchOptions) => Promise<HttpBody>;
+export interface HttpHandler 
 ```

docs/development/core/public/kibana-plugin-public.httpinterceptor.response.md

@@ -9,17 +9,17 @@ Define an interceptor to be executed after a response is received.
 <b>Signature:</b>
 
 ```typescript
-response?(httpResponse: HttpResponse, controller: IHttpInterceptController): Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void;
+response?(httpResponse: IHttpResponse, controller: IHttpInterceptController): Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  httpResponse | <code>HttpResponse</code> |  |
+|  httpResponse | <code>IHttpResponse</code> |  |
 |  controller | <code>IHttpInterceptController</code> |  |
 
 <b>Returns:</b>
 
-`Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void`
+`Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void`
 

docs/development/core/public/kibana-plugin-public.httpinterceptor.responseerror.md

@@ -9,7 +9,7 @@ Define an interceptor to be executed if a response interceptor throws an error o
 <b>Signature:</b>
 
 ```typescript
-responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptController): Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void;
+responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptController): Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void;
 ```
 
 ## Parameters
@@ -21,5 +21,5 @@ responseError?(httpErrorResponse: HttpErrorResponse, controller: IHttpInterceptC
 
 <b>Returns:</b>
 
-`Promise<InterceptedHttpResponse> | InterceptedHttpResponse | void`
+`Promise<IHttpResponseInterceptorOverrides> | IHttpResponseInterceptorOverrides | void`
 

docs/development/core/public/kibana-plugin-public.ihttpresponse.body.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) &gt; [body](./kibana-plugin-public.ihttpresponse.body.md)
+
+## IHttpResponse.body property
+
+Parsed body received, may be undefined if there was an error.
+
+<b>Signature:</b>
+
+```typescript
+readonly body?: TResponseBody;
+```

docs/development/core/public/kibana-plugin-public.ihttpresponse.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponse](./kibana-plugin-public.ihttpresponse.md)
+
+## IHttpResponse interface
+
+
+<b>Signature:</b>
+
+```typescript
+export interface IHttpResponse<TResponseBody = any> 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [body](./kibana-plugin-public.ihttpresponse.body.md) | <code>TResponseBody</code> | Parsed body received, may be undefined if there was an error. |
+|  [request](./kibana-plugin-public.ihttpresponse.request.md) | <code>Readonly&lt;Request&gt;</code> | Raw request sent to Kibana server. |
+|  [response](./kibana-plugin-public.ihttpresponse.response.md) | <code>Readonly&lt;Response&gt;</code> | Raw response received, may be undefined if there was an error. |
+

docs/development/core/public/kibana-plugin-public.ihttpresponse.request.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) &gt; [request](./kibana-plugin-public.ihttpresponse.request.md)
+
+## IHttpResponse.request property
+
+Raw request sent to Kibana server.
+
+<b>Signature:</b>
+
+```typescript
+readonly request: Readonly<Request>;
+```

docs/development/core/public/kibana-plugin-public.ihttpresponse.response.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) &gt; [response](./kibana-plugin-public.ihttpresponse.response.md)
+
+## IHttpResponse.response property
+
+Raw response received, may be undefined if there was an error.
+
+<b>Signature:</b>
+
+```typescript
+readonly response?: Readonly<Response>;
+```

docs/development/core/public/kibana-plugin-public.ihttpresponseinterceptoroverrides.body.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponseInterceptorOverrides](./kibana-plugin-public.ihttpresponseinterceptoroverrides.md) &gt; [body](./kibana-plugin-public.ihttpresponseinterceptoroverrides.body.md)
+
+## IHttpResponseInterceptorOverrides.body property
+
+Parsed body received, may be undefined if there was an error.
+
+<b>Signature:</b>
+
+```typescript
+readonly body?: TResponseBody;
+```

docs/development/core/public/kibana-plugin-public.ihttpresponseinterceptoroverrides.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponseInterceptorOverrides](./kibana-plugin-public.ihttpresponseinterceptoroverrides.md)
+
+## IHttpResponseInterceptorOverrides interface
+
+Properties that can be returned by HttpInterceptor.request to override the response.
+
+<b>Signature:</b>
+
+```typescript
+export interface IHttpResponseInterceptorOverrides<TResponseBody = any> 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [body](./kibana-plugin-public.ihttpresponseinterceptoroverrides.body.md) | <code>TResponseBody</code> | Parsed body received, may be undefined if there was an error. |
+|  [response](./kibana-plugin-public.ihttpresponseinterceptoroverrides.response.md) | <code>Readonly&lt;Response&gt;</code> | Raw response received, may be undefined if there was an error. |
+

docs/development/core/public/kibana-plugin-public.ihttpresponseinterceptoroverrides.response.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [IHttpResponseInterceptorOverrides](./kibana-plugin-public.ihttpresponseinterceptoroverrides.md) &gt; [response](./kibana-plugin-public.ihttpresponseinterceptoroverrides.response.md)
+
+## IHttpResponseInterceptorOverrides.response property
+
+Raw response received, may be undefined if there was an error.
+
+<b>Signature:</b>
+
+```typescript
+readonly response?: Readonly<Response>;
+```

docs/development/core/public/kibana-plugin-public.md

@@ -52,18 +52,19 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [HttpErrorResponse](./kibana-plugin-public.httperrorresponse.md) |  |
 |  [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) | All options that may be used with a [HttpHandler](./kibana-plugin-public.httphandler.md)<!-- -->. |
 |  [HttpFetchQuery](./kibana-plugin-public.httpfetchquery.md) |  |
+|  [HttpHandler](./kibana-plugin-public.httphandler.md) | A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) for the response. |
 |  [HttpHeadersInit](./kibana-plugin-public.httpheadersinit.md) |  |
 |  [HttpInterceptor](./kibana-plugin-public.httpinterceptor.md) | An object that may define global interceptor functions for different parts of the request and response lifecycle. See [IHttpInterceptController](./kibana-plugin-public.ihttpinterceptcontroller.md)<!-- -->. |
 |  [HttpRequestInit](./kibana-plugin-public.httprequestinit.md) | Fetch API options available to [HttpHandler](./kibana-plugin-public.httphandler.md)<!-- -->s. |
-|  [HttpResponse](./kibana-plugin-public.httpresponse.md) |  |
 |  [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) |  |
 |  [I18nStart](./kibana-plugin-public.i18nstart.md) | I18nStart.Context is required by any localizable React component from @<!-- -->kbn/i18n and @<!-- -->elastic/eui packages and is supposed to be used as the topmost component for any i18n-compatible React tree. |
 |  [IAnonymousPaths](./kibana-plugin-public.ianonymouspaths.md) | APIs for denoting paths as not requiring authentication |
 |  [IBasePath](./kibana-plugin-public.ibasepath.md) | APIs for manipulating the basePath on URL segments. |
 |  [IContextContainer](./kibana-plugin-public.icontextcontainer.md) | An object that handles registration of context providers and configuring handlers with context. |
 |  [IHttpFetchError](./kibana-plugin-public.ihttpfetcherror.md) |  |
 |  [IHttpInterceptController](./kibana-plugin-public.ihttpinterceptcontroller.md) | Used to halt a request Promise chain in a [HttpInterceptor](./kibana-plugin-public.httpinterceptor.md)<!-- -->. |
-|  [InterceptedHttpResponse](./kibana-plugin-public.interceptedhttpresponse.md) |  |
+|  [IHttpResponse](./kibana-plugin-public.ihttpresponse.md) |  |
+|  [IHttpResponseInterceptorOverrides](./kibana-plugin-public.ihttpresponseinterceptoroverrides.md) | Properties that can be returned by HttpInterceptor.request to override the response. |
 |  [IUiSettingsClient](./kibana-plugin-public.iuisettingsclient.md) | Client-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. [IUiSettingsClient](./kibana-plugin-public.iuisettingsclient.md) |
 |  [LegacyCoreSetup](./kibana-plugin-public.legacycoresetup.md) | Setup interface exposed to the legacy platform via the <code>ui/new_platform</code> module. |
 |  [LegacyCoreStart](./kibana-plugin-public.legacycorestart.md) | Start interface exposed to the legacy platform via the <code>ui/new_platform</code> module. |
@@ -108,8 +109,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [HandlerContextType](./kibana-plugin-public.handlercontexttype.md) | Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-public.handlerfunction.md) to represent the type of the context. |
 |  [HandlerFunction](./kibana-plugin-public.handlerfunction.md) | A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-public.icontextcontainer.md) |
 |  [HandlerParameters](./kibana-plugin-public.handlerparameters.md) | Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-public.handlerfunction.md)<!-- -->, excluding the [HandlerContextType](./kibana-plugin-public.handlercontexttype.md)<!-- -->. |
-|  [HttpBody](./kibana-plugin-public.httpbody.md) |  |
-|  [HttpHandler](./kibana-plugin-public.httphandler.md) | A function for making an HTTP requests to Kibana's backend. See [HttpFetchOptions](./kibana-plugin-public.httpfetchoptions.md) for options and [HttpBody](./kibana-plugin-public.httpbody.md) for the response. |
 |  [HttpSetup](./kibana-plugin-public.httpsetup.md) | See [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) |
 |  [HttpStart](./kibana-plugin-public.httpstart.md) | See [HttpServiceBase](./kibana-plugin-public.httpservicebase.md) |
 |  [IContextProvider](./kibana-plugin-public.icontextprovider.md) | A function that returns a context value for a specific key of given context type. |

src/core/public/application/capabilities/capabilities_service.tsx

@@ -74,7 +74,7 @@ export class CapabilitiesService {
     const url = http.anonymousPaths.isAnonymous(window.location.pathname)
       ? '/api/core/capabilities/defaults'
       : '/api/core/capabilities';
-    const capabilities = await http.post(url, {
+    const capabilities = await http.post<Capabilities>(url, {
       body: payload,
     });
     return deepFreeze(capabilities);