Skip to content

Add static section whitelist info to api docs generation #41870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
May 8, 2019
Merged

Add static section whitelist info to api docs generation #41870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
974ebb3
Add static section whitelist info to api docs generation
jdconrad May 6, 2019
a321443
Merge branch 'master' into staticdoc
jdconrad May 6, 2019
0dfb0e2
Merge branch 'master' into staticdoc
jdconrad May 7, 2019
a3c138a
Update TLS ciphers and protocols for JDK 11 (#41808)
jaymode May 7, 2019
502b395
Correct spelling of MockLogAppender.PatternSeenEventExpectation (#41893)
romseygeek May 7, 2019
a99fc23
Handle serialization exceptions during publication (#41781)
DaveCTurner May 7, 2019
8bff716
[DOCS] Fix callouts for dataframe APIs (#41904)
lcawl May 7, 2019
90a9b03
Merge branch 'master' into staticdoc
jdconrad May 7, 2019
e2d5463
Add new api
jdconrad May 7, 2019
1559a8e
SQL: Remove CircuitBreaker from parser (#41835)
matriv May 7, 2019
86d9e98
Allow unknown task time in QueueResizingEsTPE (#41810)
williamrandolph May 7, 2019
5b1caa8
Cleanup versioned deprecations in analysis (#41560)
rjernst May 7, 2019
7f75d7c
Merge branch 'master' into staticdoc
jdconrad May 7, 2019
7e7f5ed
Change compute to merge.
jdconrad May 7, 2019
1b80e0d
Remove ml-cpp binary files
jasontedor May 7, 2019
618ec5b
Merge branch 'master' into staticdoc
jdconrad May 7, 2019
619d392
Merge branch 'master' into staticdoc
jdconrad May 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/painless/painless-api-reference/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
|Aggs Reduce | <<painless-api-reference-shared, Shared API>> |
|Analysis | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-analysis, Specialized API>>
|Bucket Aggregation | <<painless-api-reference-shared, Shared API>> |
|Field | <<painless-api-reference-shared, Shared API>> |
|Field | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-field, Specialized API>>
|Filter | <<painless-api-reference-shared, Shared API>> |
|Ingest | <<painless-api-reference-shared, Shared API>> | <<painless-api-reference-ingest, Specialized API>>
|Interval | <<painless-api-reference-shared, Shared API>> |
Expand All @@ -33,6 +33,7 @@

include::painless-api-reference-shared/index.asciidoc[]
include::painless-api-reference-analysis/index.asciidoc[]
include::painless-api-reference-field/index.asciidoc[]
include::painless-api-reference-ingest/index.asciidoc[]
include::painless-api-reference-moving-function/index.asciidoc[]
include::painless-api-reference-score/index.asciidoc[]
4 changes: 4 additions & 0 deletions .../painless/painless-api-reference/painless-api-reference-analysis/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ The following specialized API is available in the Analysis context.

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

==== Classes By Package
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.


==== org.elasticsearch.analysis.common
<<painless-api-reference-analysis-org-elasticsearch-analysis-common, Expand details for org.elasticsearch.analysis.common>>

Expand Down
2 changes: 1 addition & 1 deletion ...inless/painless-api-reference/painless-api-reference-analysis/packages.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

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

[[painless-api-reference-analysis-AnalysisPredicateScript-Token]]
==== AnalysisPredicateScript.Token
Expand Down
17 changes: 17 additions & 0 deletions docs/painless/painless-api-reference/painless-api-reference-field/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// This file is auto-generated. Do not edit.

[[painless-api-reference-field]]
=== Field API

The following specialized API is available in the Field context.

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

==== Static Methods
The following methods are directly callable without a class/instance qualifier. Note parameters denoted by a (*) are treated as read-only values.

* List domainSplit(String)
* List domainSplit(String, Map)

include::packages.asciidoc[]

3 changes: 3 additions & 0 deletions .../painless/painless-api-reference/painless-api-reference-field/packages.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// This file is auto-generated. Do not edit.


4 changes: 4 additions & 0 deletions docs/painless/painless-api-reference/painless-api-reference-ingest/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ The following specialized API is available in the Ingest context.

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

==== Classes By Package
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.


==== org.elasticsearch.ingest.common
<<painless-api-reference-ingest-org-elasticsearch-ingest-common, Expand details for org.elasticsearch.ingest.common>>

Expand Down
2 changes: 1 addition & 1 deletion ...painless/painless-api-reference/painless-api-reference-ingest/packages.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

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

[[painless-api-reference-ingest-Processors]]
==== Processors
Expand Down
4 changes: 4 additions & 0 deletions ...ss/painless-api-reference/painless-api-reference-moving-function/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ The following specialized API is available in the Moving Function context.

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

==== Classes By Package
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.


==== org.elasticsearch.search.aggregations.pipeline
<<painless-api-reference-moving-function-org-elasticsearch-search-aggregations-pipeline, Expand details for org.elasticsearch.search.aggregations.pipeline>>

Expand Down
2 changes: 1 addition & 1 deletion ...painless-api-reference/painless-api-reference-moving-function/packages.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

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

[[painless-api-reference-moving-function-MovingFunctions]]
==== MovingFunctions
Expand Down
25 changes: 25 additions & 0 deletions docs/painless/painless-api-reference/painless-api-reference-score/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,31 @@ The following specialized API is available in the Score context.

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

==== Static Methods
The following methods are directly callable without a class/instance qualifier. Note parameters denoted by a (*) are treated as read-only values.

* double cosineSimilarity(List *, VectorScriptDocValues.DenseVectorScriptDocValues)
* double cosineSimilaritySparse(Map *, VectorScriptDocValues.SparseVectorScriptDocValues)
* double decayDateExp(String *, String *, String *, double *, JodaCompatibleZonedDateTime)
* double decayDateGauss(String *, String *, String *, double *, JodaCompatibleZonedDateTime)
* double decayDateLinear(String *, String *, String *, double *, JodaCompatibleZonedDateTime)
* double decayGeoExp(String *, String *, String *, double *, GeoPoint)
* double decayGeoGauss(String *, String *, String *, double *, GeoPoint)
* double decayGeoLinear(String *, String *, String *, double *, GeoPoint)
* double decayNumericExp(double *, double *, double *, double *, double)
* double decayNumericGauss(double *, double *, double *, double *, double)
* double decayNumericLinear(double *, double *, double *, double *, double)
* double dotProduct(List, VectorScriptDocValues.DenseVectorScriptDocValues)
* double dotProductSparse(Map *, VectorScriptDocValues.SparseVectorScriptDocValues)
* double randomScore(int *)
* double randomScore(int *, String *)
* double saturation(double, double)
* double sigmoid(double, double, double)

==== Classes By Package
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.


==== org.elasticsearch.index.query
<<painless-api-reference-score-org-elasticsearch-index-query, Expand details for org.elasticsearch.index.query>>

Expand Down
2 changes: 1 addition & 1 deletion .../painless/painless-api-reference/painless-api-reference-score/packages.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

[role="exclude",id="painless-api-reference-score-org-elasticsearch-index-query"]
=== Score API for package org.elasticsearch.index.query
See the <<painless-api-reference-score, Score API>> for a high-level overview of all packages.
See the <<painless-api-reference-score, Score API>> for a high-level overview of all packages and classes.

[[painless-api-reference-score-VectorScriptDocValues]]
==== VectorScriptDocValues
Expand Down
4 changes: 4 additions & 0 deletions docs/painless/painless-api-reference/painless-api-reference-shared/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@

The following API is available in all contexts.

==== Classes By Package
The following classes are available grouped by their respective packages. Click on a class to view details about the available methods and fields.


==== java.lang
<<painless-api-reference-shared-java-lang, Expand details for java.lang>>

Expand Down
42 changes: 21 additions & 21 deletions ...painless/painless-api-reference/painless-api-reference-shared/packages.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

[role="exclude",id="painless-api-reference-shared-java-lang"]
=== Shared API for package java.lang
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-Appendable]]
==== Appendable
Expand Down Expand Up @@ -1399,7 +1399,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-math"]
=== Shared API for package java.math
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-BigDecimal]]
==== BigDecimal
Expand Down Expand Up @@ -1557,7 +1557,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-text"]
=== Shared API for package java.text
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-Annotation]]
==== Annotation
Expand Down Expand Up @@ -2265,7 +2265,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-time"]
=== Shared API for package java.time
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-Clock]]
==== Clock
Expand Down Expand Up @@ -3078,7 +3078,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-time-chrono"]
=== Shared API for package java.time.chrono
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-AbstractChronology]]
==== AbstractChronology
Expand Down Expand Up @@ -3675,7 +3675,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-time-format"]
=== Shared API for package java.time.format
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-DateTimeFormatter]]
==== DateTimeFormatter
Expand Down Expand Up @@ -3874,7 +3874,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-time-temporal"]
=== Shared API for package java.time.temporal
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-ChronoField]]
==== ChronoField
Expand Down Expand Up @@ -4166,7 +4166,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-time-zone"]
=== Shared API for package java.time.zone
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-ZoneOffsetTransition]]
==== ZoneOffsetTransition
Expand Down Expand Up @@ -4265,7 +4265,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-util"]
=== Shared API for package java.util
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-AbstractCollection]]
==== AbstractCollection
Expand Down Expand Up @@ -7194,7 +7194,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-util-function"]
=== Shared API for package java.util.function
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-BiConsumer]]
==== BiConsumer
Expand Down Expand Up @@ -7582,7 +7582,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-util-regex"]
=== Shared API for package java.util.regex
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-Matcher]]
==== Matcher
Expand Down Expand Up @@ -7635,7 +7635,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-java-util-stream"]
=== Shared API for package java.util.stream
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-BaseStream]]
==== BaseStream
Expand Down Expand Up @@ -7957,7 +7957,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-apache-lucene-util"]
=== Shared API for package org.apache.lucene.util
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-BytesRef]]
==== BytesRef
Expand All @@ -7974,7 +7974,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-common-geo"]
=== Shared API for package org.elasticsearch.common.geo
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-GeoPoint]]
==== GeoPoint
Expand All @@ -7987,7 +7987,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-index-fielddata"]
=== Shared API for package org.elasticsearch.index.fielddata
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-ScriptDocValues-Booleans]]
==== ScriptDocValues.Booleans
Expand Down Expand Up @@ -8386,7 +8386,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-index-mapper"]
=== Shared API for package org.elasticsearch.index.mapper
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-IpFieldMapper-IpFieldType-IpScriptDocValues]]
==== IpFieldMapper.IpFieldType.IpScriptDocValues
Expand Down Expand Up @@ -8445,7 +8445,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-index-query"]
=== Shared API for package org.elasticsearch.index.query
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-IntervalFilterScript-Interval]]
==== IntervalFilterScript.Interval
Expand All @@ -8459,7 +8459,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-index-similarity"]
=== Shared API for package org.elasticsearch.index.similarity
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-ScriptedSimilarity-Doc]]
==== ScriptedSimilarity.Doc
Expand Down Expand Up @@ -8499,7 +8499,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-painless-api"]
=== Shared API for package org.elasticsearch.painless.api
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-Debug]]
==== Debug
Expand All @@ -8511,7 +8511,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-script"]
=== Shared API for package org.elasticsearch.script
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-JodaCompatibleZonedDateTime]]
==== JodaCompatibleZonedDateTime
Expand Down Expand Up @@ -8594,7 +8594,7 @@ See the <<painless-api-reference-shared, Shared API>> for a high-level overview

[role="exclude",id="painless-api-reference-shared-org-elasticsearch-search-lookup"]
=== Shared API for package org.elasticsearch.search.lookup
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages.
See the <<painless-api-reference-shared, Shared API>> for a high-level overview of all packages and classes.

[[painless-api-reference-shared-FieldLookup]]
==== FieldLookup
Expand Down
Loading