update docs

elastic · Apr 14, 2020 · 7f52fb3 · 7f52fb3
1 parent 40a9b7f
commit 7f52fb3
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 16 deletions.
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.md
@@ -16,7 +16,7 @@ export interface HttpResources
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [register](./kibana-plugin-core-server.httpresources.register.md) | <code>&lt;P, Q, B&gt;(route: RouteConfig&lt;P, Q, B, 'get'&gt;, handler: HttpResourcesRequestHandler&lt;P, Q, B&gt;) =&gt; void</code> |  |
-|  [registerAnonymousCoreApp](./kibana-plugin-core-server.httpresources.registeranonymouscoreapp.md) | <code>(route: StaticHttpResourcesRenderOptions) =&gt; void</code> |  |
-|  [registerCoreApp](./kibana-plugin-core-server.httpresources.registercoreapp.md) | <code>(route: StaticHttpResourcesRenderOptions) =&gt; void</code> |  |
+|  [register](./kibana-plugin-core-server.httpresources.register.md) | <code>&lt;P, Q, B&gt;(route: RouteConfig&lt;P, Q, B, 'get'&gt;, handler: HttpResourcesRequestHandler&lt;P, Q, B&gt;) =&gt; void</code> | To register a route handler executing passed function to form response. |
+|  [registerAnonymousCoreApp](./kibana-plugin-core-server.httpresources.registeranonymouscoreapp.md) | <code>(route: StaticHttpResourcesRenderOptions) =&gt; void</code> | To register a route handler rendering HTML bootstrapping Kibana application without retrieving user-specific information. |
+|  [registerCoreApp](./kibana-plugin-core-server.httpresources.registercoreapp.md) | <code>(route: StaticHttpResourcesRenderOptions) =&gt; void</code> | To register a route handler rendering HTML bootstrapping Kibana application. |
 
diff --git a/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md b/docs/development/core/server/kibana-plugin-core-server.httpresources.register.md
@@ -4,6 +4,8 @@
 
 ## HttpResources.register property
 
+To register a route handler executing passed function to form response.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...core/server/kibana-plugin-core-server.httpresources.registeranonymouscoreapp.md b/...core/server/kibana-plugin-core-server.httpresources.registeranonymouscoreapp.md
@@ -4,6 +4,8 @@
 
 ## HttpResources.registerAnonymousCoreApp property
 
+To register a route handler rendering HTML bootstrapping Kibana application without retrieving user-specific information.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...elopment/core/server/kibana-plugin-core-server.httpresources.registercoreapp.md b/...elopment/core/server/kibana-plugin-core-server.httpresources.registercoreapp.md
@@ -4,6 +4,8 @@
 
 ## HttpResources.registerCoreApp property
 
+To register a route handler rendering HTML bootstrapping Kibana application.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...ent/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md b/...ent/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.headers.md
@@ -4,10 +4,15 @@
 
 ## HttpResourcesRenderOptions.headers property
 
-HTTP Headers with additional information about response
+HTTP Headers with additional information about response.
 
 <b>Signature:</b>
 
 ```typescript
 headers?: ResponseHeaders;
 ```
+
+## Remarks
+
+All HTML pages are already pre-configured with `content-security-policy` header that cannot be overridden.
+
diff --git a/...development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md b/...development/core/server/kibana-plugin-core-server.httpresourcesrenderoptions.md
@@ -16,5 +16,5 @@ export interface HttpResourcesRenderOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [headers](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) | <code>ResponseHeaders</code> | HTTP Headers with additional information about response |
+|  [headers](./kibana-plugin-core-server.httpresourcesrenderoptions.headers.md) | <code>ResponseHeaders</code> | HTTP Headers with additional information about response. |
 
diff --git a/...evelopment/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md b/...evelopment/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.md
@@ -16,8 +16,8 @@ export interface HttpResourcesServiceToolkit
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) | <code>(options?: HttpResourcesRenderOptions) =&gt; Promise&lt;IKibanaResponse&gt;</code> |  |
-|  [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) | <code>(options?: HttpResourcesRenderOptions) =&gt; Promise&lt;IKibanaResponse&gt;</code> |  |
-|  [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) | <code>(options: HttpResourcesResponseOptions) =&gt; IKibanaResponse</code> |  |
-|  [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) | <code>(options: HttpResourcesResponseOptions) =&gt; IKibanaResponse</code> |  |
+|  [renderAnonymousCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md) | <code>(options?: HttpResourcesRenderOptions) =&gt; Promise&lt;IKibanaResponse&gt;</code> | To respond with HTML page bootstrapping Kibana application without retrieving user-specific information. |
+|  [renderCoreApp](./kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md) | <code>(options?: HttpResourcesRenderOptions) =&gt; Promise&lt;IKibanaResponse&gt;</code> | To respond with HTML page bootstrapping Kibana application. |
+|  [renderHtml](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md) | <code>(options: HttpResourcesResponseOptions) =&gt; IKibanaResponse</code> | To respond with a custom HTML page. |
+|  [renderJs](./kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md) | <code>(options: HttpResourcesResponseOptions) =&gt; IKibanaResponse</code> | To respond with a custom JS script file. |
 
diff --git a/...kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md b/...kibana-plugin-core-server.httpresourcesservicetoolkit.renderanonymouscoreapp.md
@@ -4,6 +4,8 @@
 
 ## HttpResourcesServiceToolkit.renderAnonymousCoreApp property
 
+To respond with HTML page bootstrapping Kibana application without retrieving user-specific information.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...e/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md b/...e/server/kibana-plugin-core-server.httpresourcesservicetoolkit.rendercoreapp.md
@@ -4,6 +4,8 @@
 
 ## HttpResourcesServiceToolkit.renderCoreApp property
 
+To respond with HTML page bootstrapping Kibana application.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md b/...core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderhtml.md
@@ -4,6 +4,8 @@
 
 ## HttpResourcesServiceToolkit.renderHtml property
 
+To respond with a custom HTML page.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...t/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md b/...t/core/server/kibana-plugin-core-server.httpresourcesservicetoolkit.renderjs.md
@@ -4,6 +4,8 @@
 
 ## HttpResourcesServiceToolkit.renderJs property
 
+To respond with a custom JS script file.
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -865,11 +865,8 @@ export type Headers = {
 
 // @public
 export interface HttpResources {
-    // (undocumented)
     register: <P, Q, B>(route: RouteConfig<P, Q, B, 'get'>, handler: HttpResourcesRequestHandler<P, Q, B>) => void;
-    // (undocumented)
     registerAnonymousCoreApp: (route: StaticHttpResourcesRenderOptions) => void;
-    // (undocumented)
     registerCoreApp: (route: StaticHttpResourcesRenderOptions) => void;
 }
 
@@ -886,13 +883,9 @@ export type HttpResourcesResponseOptions = HttpResponseOptions;
 
 // @public
 export interface HttpResourcesServiceToolkit {
-    // (undocumented)
     renderAnonymousCoreApp: (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse>;
-    // (undocumented)
     renderCoreApp: (options?: HttpResourcesRenderOptions) => Promise<IKibanaResponse>;
-    // (undocumented)
     renderHtml: (options: HttpResourcesResponseOptions) => IKibanaResponse;
-    // (undocumented)
     renderJs: (options: HttpResourcesResponseOptions) => IKibanaResponse;
 }