update docs

elastic · Jul 15, 2021 · e0a2ddf · e0a2ddf
1 parent 859caf2
commit e0a2ddf
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/...blic.executioncontext.executioncontext.md → ...c.executioncontext.getexecutioncontext.md b/...blic.executioncontext.executioncontext.md → ...c.executioncontext.getexecutioncontext.md
@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [ExecutionContext](./kibana-plugin-plugins-expressions-public.executioncontext.md) &gt; [executionContext](./kibana-plugin-plugins-expressions-public.executioncontext.executioncontext.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-public](./kibana-plugin-plugins-expressions-public.md) &gt; [ExecutionContext](./kibana-plugin-plugins-expressions-public.executioncontext.md) &gt; [getExecutionContext](./kibana-plugin-plugins-expressions-public.executioncontext.getexecutioncontext.md)
 
-## ExecutionContext.executionContext property
+## ExecutionContext.getExecutionContext property
 
 Contains the meta-data about the source of the expression.
 
 <b>Signature:</b>
 
 ```typescript
-readonly executionContext?: IExecutionContextContainer;
+getExecutionContext: () => IExecutionContextContainer | undefined;
 ```
diff --git a/...expressions/public/kibana-plugin-plugins-expressions-public.executioncontext.md b/...expressions/public/kibana-plugin-plugins-expressions-public.executioncontext.md
@@ -17,7 +17,7 @@ export interface ExecutionContext<InspectorAdapters extends Adapters = Adapters,
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [abortSignal](./kibana-plugin-plugins-expressions-public.executioncontext.abortsignal.md) | <code>AbortSignal</code> | Adds ability to abort current execution. |
-|  [executionContext](./kibana-plugin-plugins-expressions-public.executioncontext.executioncontext.md) | <code>IExecutionContextContainer</code> | Contains the meta-data about the source of the expression. |
+|  [getExecutionContext](./kibana-plugin-plugins-expressions-public.executioncontext.getexecutioncontext.md) | <code>() =&gt; IExecutionContextContainer &#124; undefined</code> | Contains the meta-data about the source of the expression. |
 |  [getKibanaRequest](./kibana-plugin-plugins-expressions-public.executioncontext.getkibanarequest.md) | <code>() =&gt; KibanaRequest</code> | Getter to retrieve the <code>KibanaRequest</code> object inside an expression function. Useful for functions which are running on the server and need to perform operations that are scoped to a specific user. |
 |  [getSearchContext](./kibana-plugin-plugins-expressions-public.executioncontext.getsearchcontext.md) | <code>() =&gt; ExecutionContextSearch</code> | Get search context of the expression. |
 |  [getSearchSessionId](./kibana-plugin-plugins-expressions-public.executioncontext.getsearchsessionid.md) | <code>() =&gt; string &#124; undefined</code> | Search context in which expression should operate. |

diff --git a/...rver.executioncontext.executioncontext.md → ...r.executioncontext.getexecutioncontext.md b/...rver.executioncontext.executioncontext.md → ...r.executioncontext.getexecutioncontext.md
@@ -1,13 +1,13 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) &gt; [ExecutionContext](./kibana-plugin-plugins-expressions-server.executioncontext.md) &gt; [executionContext](./kibana-plugin-plugins-expressions-server.executioncontext.executioncontext.md)
+[Home](./index.md) &gt; [kibana-plugin-plugins-expressions-server](./kibana-plugin-plugins-expressions-server.md) &gt; [ExecutionContext](./kibana-plugin-plugins-expressions-server.executioncontext.md) &gt; [getExecutionContext](./kibana-plugin-plugins-expressions-server.executioncontext.getexecutioncontext.md)
 
-## ExecutionContext.executionContext property
+## ExecutionContext.getExecutionContext property
 
 Contains the meta-data about the source of the expression.
 
 <b>Signature:</b>
 
 ```typescript
-readonly executionContext?: IExecutionContextContainer;
+getExecutionContext: () => IExecutionContextContainer | undefined;
 ```
diff --git a/...expressions/server/kibana-plugin-plugins-expressions-server.executioncontext.md b/...expressions/server/kibana-plugin-plugins-expressions-server.executioncontext.md
@@ -17,7 +17,7 @@ export interface ExecutionContext<InspectorAdapters extends Adapters = Adapters,
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [abortSignal](./kibana-plugin-plugins-expressions-server.executioncontext.abortsignal.md) | <code>AbortSignal</code> | Adds ability to abort current execution. |
-|  [executionContext](./kibana-plugin-plugins-expressions-server.executioncontext.executioncontext.md) | <code>IExecutionContextContainer</code> | Contains the meta-data about the source of the expression. |
+|  [getExecutionContext](./kibana-plugin-plugins-expressions-server.executioncontext.getexecutioncontext.md) | <code>() =&gt; IExecutionContextContainer &#124; undefined</code> | Contains the meta-data about the source of the expression. |
 |  [getKibanaRequest](./kibana-plugin-plugins-expressions-server.executioncontext.getkibanarequest.md) | <code>() =&gt; KibanaRequest</code> | Getter to retrieve the <code>KibanaRequest</code> object inside an expression function. Useful for functions which are running on the server and need to perform operations that are scoped to a specific user. |
 |  [getSearchContext](./kibana-plugin-plugins-expressions-server.executioncontext.getsearchcontext.md) | <code>() =&gt; ExecutionContextSearch</code> | Get search context of the expression. |
 |  [getSearchSessionId](./kibana-plugin-plugins-expressions-server.executioncontext.getsearchsessionid.md) | <code>() =&gt; string &#124; undefined</code> | Search context in which expression should operate. |

diff --git a/src/plugins/expressions/public/public.api.md b/src/plugins/expressions/public/public.api.md
@@ -139,7 +139,7 @@ export type ExecutionContainer<Output = ExpressionValue> = StateContainer<Execut
 // @public
 export interface ExecutionContext<InspectorAdapters extends Adapters = Adapters, ExecutionContextSearch extends SerializableState_2 = SerializableState_2> {
     abortSignal: AbortSignal;
-    readonly executionContext?: IExecutionContextContainer;
+    getExecutionContext: () => IExecutionContextContainer | undefined;
     getKibanaRequest?: () => KibanaRequest;
     getSearchContext: () => ExecutionContextSearch;
     getSearchSessionId: () => string | undefined;

diff --git a/src/plugins/expressions/server/server.api.md b/src/plugins/expressions/server/server.api.md
@@ -137,7 +137,7 @@ export type ExecutionContainer<Output = ExpressionValue> = StateContainer<Execut
 // @public
 export interface ExecutionContext<InspectorAdapters extends Adapters = Adapters, ExecutionContextSearch extends SerializableState_2 = SerializableState_2> {
     abortSignal: AbortSignal;
-    readonly executionContext?: IExecutionContextContainer;
+    getExecutionContext: () => IExecutionContextContainer | undefined;
     getKibanaRequest?: () => KibanaRequest;
     getSearchContext: () => ExecutionContextSearch;
     getSearchSessionId: () => string | undefined;