Skip to content

Commit a74ba7d

Browse files
committed
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.
1 parent d1a3ae2 commit a74ba7d

File tree

362 files changed

+10277
-6427
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

362 files changed

+10277
-6427
lines changed

docs/Versions.asciidoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ release-state can be: released | prerelease | unreleased
3030
///////
3131
Javadoc roots used to generate links from Painless's API reference
3232
///////
33-
:java8-javadoc: https://docs.oracle.com/javase/8/docs/api
34-
:java9-javadoc: https://docs.oracle.com/javase/9/docs/api
33+
:java11-javadoc: https://docs.oracle.com/en/java/javase/11/docs/api
3534
:joda-time-javadoc: http://www.joda.org/joda-time/apidocs
3635
:lucene-core-javadoc: http://lucene.apache.org/core/{lucene_version_path}/core
3736

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[[painless-api-reference]]
22
== Painless API Reference
33

4-
Painless has a strict whitelist for methods and classes to ensure all
5-
painless scripts are secure. Most of these methods are exposed directly
6-
from the Java Runtime Environment (JRE) while others are part of
7-
Elasticsearch or Painless itself. Below is a list of all available
8-
classes grouped with their respected methods. Clicking on the method
9-
name takes you to the documentation for that specific method. Methods
10-
defined in the JRE also have a `(java 9)` link which can be used to see
11-
the method's documentation in Java 9.
4+
Painless has a strict whitelist for methods and classes per context to
5+
ensure all painless scripts are secure. Most of these methods are
6+
exposed directly from the Java Runtime Environment (JRE) while others
7+
are part of Elasticsearch or Painless itself. Below is a list of the available
8+
APIs per context. The shared API is available to all contexts, while the
9+
specialized API available differs between contexts.
1210

1311
include::painless-api-reference/index.asciidoc[]

docs/painless/painless-api-reference/AbstractChronology.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractCollection.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractList.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractMap.SimpleEntry.asciidoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractMap.SimpleImmutableEntry.asciidoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractMap.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractQueue.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractSequentialList.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/AbstractSet.asciidoc

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/painless/painless-api-reference/Annotation.asciidoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/painless/painless-api-reference/Appendable.asciidoc

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/painless/painless-api-reference/ArithmeticException.asciidoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/painless/painless-api-reference/ArrayDeque.asciidoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/painless/painless-api-reference/ArrayIndexOutOfBoundsException.asciidoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/painless/painless-api-reference/ArrayList.asciidoc

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/painless/painless-api-reference/ArrayStoreException.asciidoc

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/painless/painless-api-reference/Arrays.asciidoc

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/painless/painless-api-reference/AttributedCharacterIterator.Attribute.asciidoc

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/painless/painless-api-reference/AttributedCharacterIterator.asciidoc

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)