-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This adds a gradle task called generateContextDoc in the Painless module. The task will start a cluster, issue commands against the context rest api for Painless, and generate documentation for each API per context. Each context has a first page of classes sorted by package first and class name second, along with a page per package with each classes' constructors, methods, and fields. A link is generated for each constructor, method, and field to a JavaDoc page when possible.
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,11 @@ | ||
[[painless-api-reference]] | ||
== Painless API Reference | ||
|
||
Painless has a strict whitelist for methods and classes to ensure all | ||
painless scripts are secure. Most of these methods are exposed directly | ||
from the Java Runtime Environment (JRE) while others are part of | ||
Elasticsearch or Painless itself. Below is a list of all available | ||
classes grouped with their respected methods. Clicking on the method | ||
name takes you to the documentation for that specific method. Methods | ||
defined in the JRE also have a `(java 9)` link which can be used to see | ||
the method's documentation in Java 9. | ||
Painless has a strict whitelist for methods and classes per context to | ||
ensure all painless scripts are secure. Most of these methods are | ||
exposed directly from the Java Runtime Environment (JRE) while others | ||
are part of Elasticsearch or Painless itself. Below is a list of the available | ||
APIs per context. The shared API is available to all contexts, while the | ||
specialized API available differs between contexts. | ||
|
||
include::painless-api-reference/index.asciidoc[] |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.