Skip to content

Commit 2c56148

Browse files
jdconradjdconrad
committed
Add static section whitelist info to api docs generation (#41870)
This change adds imported methods, class bindings, and instance bindings to the documentation generation for the Painless Context APIs.
1 parent a2b7871 commit 2c56148

File tree

14 files changed

+261
-60
lines changed

14 files changed

+261
-60
lines changed

‎docs/painless/painless-api-reference/index.asciidoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
|Aggs Reduce | <<painless-api-reference-shared, Shared API>> |
1111
|Analysis | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-analysis, Specialized API>>
1212
|Bucket Aggregation | <<painless-api-reference-shared, Shared API>> |
13-
|Field | <<painless-api-reference-shared, Shared API>> |
13+
|Field | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-field, Specialized API>>
1414
|Filter | <<painless-api-reference-shared, Shared API>> |
1515
|Ingest | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-ingest, Specialized API>>
1616
|Interval | <<painless-api-reference-shared, Shared API>> |
@@ -33,6 +33,7 @@
3333

3434
include::painless-api-reference-shared/index.asciidoc[]
3535
include::painless-api-reference-analysis/index.asciidoc[]
36+
include::painless-api-reference-field/index.asciidoc[]
3637
include::painless-api-reference-ingest/index.asciidoc[]
3738
include::painless-api-reference-moving-function/index.asciidoc[]
3839
include::painless-api-reference-score/index.asciidoc[]

‎docs/painless/painless-api-reference/painless-api-reference-analysis/index.asciidoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The following specialized API is available in the Analysis context.
77

88
* See the <<painless-api-reference-shared, Shared API>> for further API available in all contexts.
99

10+
==== Classes By Package
11+
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.
12+
13+
1014
==== org.elasticsearch.analysis.common
1115
<<painless-api-reference-analysis-org-elasticsearch-analysis-common, Expand details for org.elasticsearch.analysis.common>>
1216

‎docs/painless/painless-api-reference/painless-api-reference-analysis/packages.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[role="exclude",id="painless-api-reference-analysis-org-elasticsearch-analysis-common"]
55
=== Analysis API for package org.elasticsearch.analysis.common
6-
See the <<painless-api-reference-analysis, Analysis API>> for a high-level overview of all packages.
6+
See the <<painless-api-reference-analysis, Analysis API>> for a high-level overview of all packages and classes.
77

88
[[painless-api-reference-analysis-AnalysisPredicateScript-Token]]
99
==== AnalysisPredicateScript.Token

‎docs/painless/painless-api-reference/painless-api-reference-field/index.asciidoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// This file is auto-generated. Do not edit.
2+
3+
[[painless-api-reference-field]]
4+
=== Field API
5+
6+
The following specialized API is available in the Field context.
7+
8+
* See the <<painless-api-reference-shared, Shared API>> for further API available in all contexts.
9+
10+
==== Static Methods
11+
The following methods are directly callable without a class/instance qualifier. Note parameters denoted by a (*) are treated as read-only values.
12+
13+
* List domainSplit(String)
14+
* List domainSplit(String, Map)
15+
16+
include::packages.asciidoc[]
17+

‎docs/painless/painless-api-reference/painless-api-reference-field/packages.asciidoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// This file is auto-generated. Do not edit.
2+
3+

‎docs/painless/painless-api-reference/painless-api-reference-ingest/index.asciidoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The following specialized API is available in the Ingest context.
77

88
* See the <<painless-api-reference-shared, Shared API>> for further API available in all contexts.
99

10+
==== Classes By Package
11+
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.
12+
13+
1014
==== org.elasticsearch.ingest.common
1115
<<painless-api-reference-ingest-org-elasticsearch-ingest-common, Expand details for org.elasticsearch.ingest.common>>
1216

‎docs/painless/painless-api-reference/painless-api-reference-ingest/packages.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[role="exclude",id="painless-api-reference-ingest-org-elasticsearch-ingest-common"]
55
=== Ingest API for package org.elasticsearch.ingest.common
6-
See the <<painless-api-reference-ingest, Ingest API>> for a high-level overview of all packages.
6+
See the <<painless-api-reference-ingest, Ingest API>> for a high-level overview of all packages and classes.
77

88
[[painless-api-reference-ingest-Processors]]
99
==== Processors

‎docs/painless/painless-api-reference/painless-api-reference-moving-function/index.asciidoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ The following specialized API is available in the Moving Function context.
77

88
* See the <<painless-api-reference-shared, Shared API>> for further API available in all contexts.
99

10+
==== Classes By Package
11+
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.
12+
13+
1014
==== org.elasticsearch.search.aggregations.pipeline
1115
<<painless-api-reference-moving-function-org-elasticsearch-search-aggregations-pipeline, Expand details for org.elasticsearch.search.aggregations.pipeline>>
1216

‎docs/painless/painless-api-reference/painless-api-reference-moving-function/packages.asciidoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
[role="exclude",id="painless-api-reference-moving-function-org-elasticsearch-search-aggregations-pipeline"]
55
=== Moving Function API for package org.elasticsearch.search.aggregations.pipeline
6-
See the <<painless-api-reference-moving-function, Moving Function API>> for a high-level overview of all packages.
6+
See the <<painless-api-reference-moving-function, Moving Function API>> for a high-level overview of all packages and classes.
77

88
[[painless-api-reference-moving-function-MovingFunctions]]
99
==== MovingFunctions

‎docs/painless/painless-api-reference/painless-api-reference-score/index.asciidoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,31 @@ The following specialized API is available in the Score context.
77

88
* See the <<painless-api-reference-shared, Shared API>> for further API available in all contexts.
99

10+
==== Static Methods
11+
The following methods are directly callable without a class/instance qualifier. Note parameters denoted by a (*) are treated as read-only values.
12+
13+
* double cosineSimilarity(List *, VectorScriptDocValues.DenseVectorScriptDocValues)
14+
* double cosineSimilaritySparse(Map *, VectorScriptDocValues.SparseVectorScriptDocValues)
15+
* double decayDateExp(String *, String *, String *, double *, JodaCompatibleZonedDateTime)
16+
* double decayDateGauss(String *, String *, String *, double *, JodaCompatibleZonedDateTime)
17+
* double decayDateLinear(String *, String *, String *, double *, JodaCompatibleZonedDateTime)
18+
* double decayGeoExp(String *, String *, String *, double *, GeoPoint)
19+
* double decayGeoGauss(String *, String *, String *, double *, GeoPoint)
20+
* double decayGeoLinear(String *, String *, String *, double *, GeoPoint)
21+
* double decayNumericExp(double *, double *, double *, double *, double)
22+
* double decayNumericGauss(double *, double *, double *, double *, double)
23+
* double decayNumericLinear(double *, double *, double *, double *, double)
24+
* double dotProduct(List, VectorScriptDocValues.DenseVectorScriptDocValues)
25+
* double dotProductSparse(Map *, VectorScriptDocValues.SparseVectorScriptDocValues)
26+
* double randomScore(int *)
27+
* double randomScore(int *, String *)
28+
* double saturation(double, double)
29+
* double sigmoid(double, double, double)
30+
31+
==== Classes By Package
32+
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.
33+
34+
1035
==== org.elasticsearch.index.query
1136
<<painless-api-reference-score-org-elasticsearch-index-query, Expand details for org.elasticsearch.index.query>>
1237

0 commit comments

Comments
 (0)