honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/painless/painless-api-reference.asci...

12 lines
515 B
Plaintext
Raw Normal View History

Painless Spec Documentation Clean Up (#29441) Created a flatter structure for the different sections. Cleaned up comments, keywords, and literals. Used callouts for examples where it made sense.
2018-04-17 15:16:08 -04:00
[[painless-api-reference]]
== Painless API Reference
[DOCS] Setting up separate Painless book.
2017-05-12 19:17:06 -04:00
Task to generate Painless API's per context (#41233) 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.
2019-04-23 12:10:47 -04:00
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.
[DOCS] Setting up separate Painless book.
2017-05-12 19:17:06 -04:00
include::painless-api-reference/index.asciidoc[]