mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 21:18:31 +00:00
a74ba7d5ba
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.
12 lines
515 B
Plaintext
12 lines
515 B
Plaintext
[[painless-api-reference]]
|
|
== Painless API Reference
|
|
|
|
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[]
|