WIP better generated API reference docs

.gitignore

@@ -72,3 +72,4 @@ rest-api-spec
 yaml-rest-tests
 generated-tests
 schema
+api-extractor/*

.npmignore

@@ -8,23 +8,22 @@ pids
 *.pid
 *.seed
 
-# Directory for instrumented libs generated by jscoverage/JSCover
+# unit testing and coverage artifacts
 lib-cov
-
-# Coverage directory used by tools like istanbul
 coverage
-
-# coverage output
 coverage.lcov
-
-# nyc test coverage
 .nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
+.tap
+rest-api-spec
+yaml-rest-tests
+generated-tests
+junit-output
 
-# node-waf configuration
+# lock files
 .lock-wscript
+package-lock.json
+bun.lockb
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
 build/Release
@@ -45,17 +44,18 @@ jspm_packages
 # vim swap files
 *.swp
 
-package-lock.json
-
 # elasticsearch repo or binary files
 elasticsearch*
 
 # Generated typings, we don't commit them
 # because we should copy them in the main .d.ts file
 api/generated.d.ts
 
-# Ignore doc folder
+# documentation
 docs
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+CHANGELOG.md
 
 # Ignore test folder
 test
@@ -68,12 +68,14 @@ scripts
 .buildkite
 certs
 .github
-CODE_OF_CONDUCT.md
-CONTRIBUTING.md
 
+# Uncompiled source
 src
-bun.lockb
-.tap
-rest-api-spec
-yaml-rest-tests
-generated-tests
+
+# repo configurations
+.dockerignore
+.gitignore
+catalog-info.yaml
+codecov.yml
+renovate.json
+tsconfig.json

api-extractor.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/client.d.ts",
+  "bundledPackages": [
+    "@elastic/elasticsearch"
+  ],
+  "apiReport": {
+    "enabled": false
+  },
+  "docModel": {
+    "enabled": true,
+    "apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json",
+    "includeForgottenExports": true
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {
+    "enabled": true,
+    "tsdocMetadataFilePath": "<projectFolder>/api-extractor/tsdoc-metadata.json"
+  },
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    }
+  }
+}

docs/reference/api/API.md

@@ -0,0 +1,90 @@
+# `API` [interface-API]
+
+| Name | Type | Description |
+| - | - | - |
+| `asyncSearch` | [AsyncSearchApi](./AsyncSearchApi.md) |   |
+| `autoscaling` | [AutoscalingApi](./AutoscalingApi.md) |   |
+| `bulk` | typeof [bulkApi](./bulkApi.md) |   |
+| `capabilities` | typeof [capabilitiesApi](./capabilitiesApi.md) |   |
+| `cat` | [CatApi](./CatApi.md) |   |
+| `ccr` | [CcrApi](./CcrApi.md) |   |
+| `clearScroll` | typeof [clearScrollApi](./clearScrollApi.md) |   |
+| `closePointInTime` | typeof [closePointInTimeApi](./closePointInTimeApi.md) |   |
+| `cluster` | [ClusterApi](./ClusterApi.md) |   |
+| `connector` | [ConnectorApi](./ConnectorApi.md) |   |
+| `count` | typeof [countApi](./countApi.md) |   |
+| `create` | typeof [createApi](./createApi.md) |   |
+| `danglingIndices` | [DanglingIndicesApi](./DanglingIndicesApi.md) |   |
+| `delete` | typeof [deleteApi](./deleteApi.md) |   |
+| `deleteByQuery` | typeof [deleteByQueryApi](./deleteByQueryApi.md) |   |
+| `deleteByQueryRethrottle` | typeof [deleteByQueryRethrottleApi](./deleteByQueryRethrottleApi.md) |   |
+| `deleteScript` | typeof [deleteScriptApi](./deleteScriptApi.md) |   |
+| `enrich` | [EnrichApi](./EnrichApi.md) |   |
+| `eql` | [EqlApi](./EqlApi.md) |   |
+| `esql` | [EsqlApi](./EsqlApi.md) |   |
+| `exists` | typeof [existsApi](./existsApi.md) |   |
+| `existsSource` | typeof [existsSourceApi](./existsSourceApi.md) |   |
+| `explain` | typeof [explainApi](./explainApi.md) |   |
+| `features` | [FeaturesApi](./FeaturesApi.md) |   |
+| `fieldCaps` | typeof [fieldCapsApi](./fieldCapsApi.md) |   |
+| `fleet` | [FleetApi](./FleetApi.md) |   |
+| `get` | typeof [getApi](./getApi.md) |   |
+| `getScript` | typeof [getScriptApi](./getScriptApi.md) |   |
+| `getScriptContext` | typeof [getScriptContextApi](./getScriptContextApi.md) |   |
+| `getScriptLanguages` | typeof [getScriptLanguagesApi](./getScriptLanguagesApi.md) |   |
+| `getSource` | typeof [getSourceApi](./getSourceApi.md) |   |
+| `graph` | [GraphApi](./GraphApi.md) |   |
+| `healthReport` | typeof [healthReportApi](./healthReportApi.md) |   |
+| `ilm` | [IlmApi](./IlmApi.md) |   |
+| `index` | typeof [indexApi](./indexApi.md) |   |
+| `indices` | [IndicesApi](./IndicesApi.md) |   |
+| `inference` | [InferenceApi](./InferenceApi.md) |   |
+| `info` | typeof [infoApi](./infoApi.md) |   |
+| `ingest` | [IngestApi](./IngestApi.md) |   |
+| `knnSearch` | typeof [knnSearchApi](./knnSearchApi.md) |   |
+| `license` | [LicenseApi](./LicenseApi.md) |   |
+| `logstash` | [LogstashApi](./LogstashApi.md) |   |
+| `mget` | typeof [mgetApi](./mgetApi.md) |   |
+| `migration` | [MigrationApi](./MigrationApi.md) |   |
+| `ml` | [MlApi](./MlApi.md) |   |
+| `monitoring` | [MonitoringApi](./MonitoringApi.md) |   |
+| `msearch` | typeof [msearchApi](./msearchApi.md) |   |
+| `msearchTemplate` | typeof [msearchTemplateApi](./msearchTemplateApi.md) |   |
+| `mtermvectors` | typeof [mtermvectorsApi](./mtermvectorsApi.md) |   |
+| `nodes` | [NodesApi](./NodesApi.md) |   |
+| `openPointInTime` | typeof [openPointInTimeApi](./openPointInTimeApi.md) |   |
+| `ping` | typeof [pingApi](./pingApi.md) |   |
+| `profiling` | [ProfilingApi](./ProfilingApi.md) |   |
+| `putScript` | typeof [putScriptApi](./putScriptApi.md) |   |
+| `queryRules` | [QueryRulesApi](./QueryRulesApi.md) |   |
+| `rankEval` | typeof [rankEvalApi](./rankEvalApi.md) |   |
+| `reindex` | typeof [reindexApi](./reindexApi.md) |   |
+| `reindexRethrottle` | typeof [reindexRethrottleApi](./reindexRethrottleApi.md) |   |
+| `renderSearchTemplate` | typeof [renderSearchTemplateApi](./renderSearchTemplateApi.md) |   |
+| `rollup` | [RollupApi](./RollupApi.md) |   |
+| `scriptsPainlessExecute` | typeof [scriptsPainlessExecuteApi](./scriptsPainlessExecuteApi.md) |   |
+| `scroll` | typeof [scrollApi](./scrollApi.md) |   |
+| `search` | typeof [searchApi](./searchApi.md) |   |
+| `searchableSnapshots` | [SearchableSnapshotsApi](./SearchableSnapshotsApi.md) |   |
+| `searchApplication` | [SearchApplicationApi](./SearchApplicationApi.md) |   |
+| `searchMvt` | typeof [searchMvtApi](./searchMvtApi.md) |   |
+| `searchShards` | typeof [searchShardsApi](./searchShardsApi.md) |   |
+| `searchTemplate` | typeof [searchTemplateApi](./searchTemplateApi.md) |   |
+| `security` | [SecurityApi](./SecurityApi.md) |   |
+| `shutdown` | [ShutdownApi](./ShutdownApi.md) |   |
+| `simulate` | [SimulateApi](./SimulateApi.md) |   |
+| `slm` | [SlmApi](./SlmApi.md) |   |
+| `snapshot` | [SnapshotApi](./SnapshotApi.md) |   |
+| `sql` | [SqlApi](./SqlApi.md) |   |
+| `ssl` | [SslApi](./SslApi.md) |   |
+| `synonyms` | [SynonymsApi](./SynonymsApi.md) |   |
+| `tasks` | [TasksApi](./TasksApi.md) |   |
+| `termsEnum` | typeof [termsEnumApi](./termsEnumApi.md) |   |
+| `termvectors` | typeof [termvectorsApi](./termvectorsApi.md) |   |
+| `textStructure` | [TextStructureApi](./TextStructureApi.md) |   |
+| `transform` | [TransformApi](./TransformApi.md) |   |
+| `update` | typeof [updateApi](./updateApi.md) |   |
+| `updateByQuery` | typeof [updateByQueryApi](./updateByQueryApi.md) |   |
+| `updateByQueryRethrottle` | typeof [updateByQueryRethrottleApi](./updateByQueryRethrottleApi.md) |   |
+| `watcher` | [WatcherApi](./WatcherApi.md) |   |
+| `xpack` | [XpackApi](./XpackApi.md) |   |

docs/reference/api/AcknowledgedResponseBase.md

@@ -0,0 +1,5 @@
+# `AcknowledgedResponseBase` [interface-AcknowledgedResponseBase]
+
+| Name | Type | Description |
+| - | - | - |
+| `acknowledged` | boolean | For a successful response, this value is always true. On failure, an exception is returned instead. |

docs/reference/api/Action.md

@@ -0,0 +1,4 @@
+# `Action` [alias-Action]
+```typescript
+type Action = [IndexAction](./IndexAction.md) | [CreateAction](./CreateAction.md) | [UpdateAction](./UpdateAction.md) | [DeleteAction](./DeleteAction.md);
+```

docs/reference/api/AggregateName.md

@@ -0,0 +1,4 @@
+# `AggregateName` [alias-AggregateName]
+```typescript
+type AggregateName = string;
+```

docs/reference/api/AggregationsAdjacencyMatrixAggregate.md

@@ -0,0 +1,4 @@
+# `AggregationsAdjacencyMatrixAggregate` [interface-AggregationsAdjacencyMatrixAggregate]
+
+| Name | Type | Description |
+| - | - | - |

docs/reference/api/AggregationsAdjacencyMatrixAggregation.md

@@ -0,0 +1,6 @@
+# `AggregationsAdjacencyMatrixAggregation` [interface-AggregationsAdjacencyMatrixAggregation]
+
+| Name | Type | Description |
+| - | - | - |
+| `filters` | Record<string, [QueryDslQueryContainer](./QueryDslQueryContainer.md)> | Filters used to create buckets. At least one filter is required. |
+| `separator` | string | Separator used to concatenate filter names. Defaults to &. |

docs/reference/api/AggregationsAdjacencyMatrixBucket.md

@@ -0,0 +1,4 @@
+# `AggregationsAdjacencyMatrixBucket` [alias-AggregationsAdjacencyMatrixBucket]
+```typescript
+type AggregationsAdjacencyMatrixBucket = [AggregationsAdjacencyMatrixBucketKeys](./AggregationsAdjacencyMatrixBucketKeys.md) & { [property: string]: [AggregationsAggregate](./AggregationsAggregate.md) | string | [long](./long.md);};
+```

docs/reference/api/AggregationsAdjacencyMatrixBucketKeys.md

@@ -0,0 +1,5 @@
+# `AggregationsAdjacencyMatrixBucketKeys` [interface-AggregationsAdjacencyMatrixBucketKeys]
+
+| Name | Type | Description |
+| - | - | - |
+| `key` | string |   |

docs/reference/api/AggregationsAggregate.md

@@ -0,0 +1,4 @@
+# `AggregationsAggregate` [alias-AggregationsAggregate]
+```typescript
+type AggregationsAggregate = [AggregationsCardinalityAggregate](./AggregationsCardinalityAggregate.md) | [AggregationsHdrPercentilesAggregate](./AggregationsHdrPercentilesAggregate.md) | [AggregationsHdrPercentileRanksAggregate](./AggregationsHdrPercentileRanksAggregate.md) | [AggregationsTDigestPercentilesAggregate](./AggregationsTDigestPercentilesAggregate.md) | [AggregationsTDigestPercentileRanksAggregate](./AggregationsTDigestPercentileRanksAggregate.md) | [AggregationsPercentilesBucketAggregate](./AggregationsPercentilesBucketAggregate.md) | [AggregationsMedianAbsoluteDeviationAggregate](./AggregationsMedianAbsoluteDeviationAggregate.md) | [AggregationsMinAggregate](./AggregationsMinAggregate.md) | [AggregationsMaxAggregate](./AggregationsMaxAggregate.md) | [AggregationsSumAggregate](./AggregationsSumAggregate.md) | [AggregationsAvgAggregate](./AggregationsAvgAggregate.md) | [AggregationsWeightedAvgAggregate](./AggregationsWeightedAvgAggregate.md) | [AggregationsValueCountAggregate](./AggregationsValueCountAggregate.md) | [AggregationsSimpleValueAggregate](./AggregationsSimpleValueAggregate.md) | [AggregationsDerivativeAggregate](./AggregationsDerivativeAggregate.md) | [AggregationsBucketMetricValueAggregate](./AggregationsBucketMetricValueAggregate.md) | [AggregationsStatsAggregate](./AggregationsStatsAggregate.md) | [AggregationsStatsBucketAggregate](./AggregationsStatsBucketAggregate.md) | [AggregationsExtendedStatsAggregate](./AggregationsExtendedStatsAggregate.md) | [AggregationsExtendedStatsBucketAggregate](./AggregationsExtendedStatsBucketAggregate.md) | [AggregationsGeoBoundsAggregate](./AggregationsGeoBoundsAggregate.md) | [AggregationsGeoCentroidAggregate](./AggregationsGeoCentroidAggregate.md) | [AggregationsHistogramAggregate](./AggregationsHistogramAggregate.md) | [AggregationsDateHistogramAggregate](./AggregationsDateHistogramAggregate.md) | [AggregationsAutoDateHistogramAggregate](./AggregationsAutoDateHistogramAggregate.md) | [AggregationsVariableWidthHistogramAggregate](./AggregationsVariableWidthHistogramAggregate.md) | [AggregationsStringTermsAggregate](./AggregationsStringTermsAggregate.md) | [AggregationsLongTermsAggregate](./AggregationsLongTermsAggregate.md) | [AggregationsDoubleTermsAggregate](./AggregationsDoubleTermsAggregate.md) | [AggregationsUnmappedTermsAggregate](./AggregationsUnmappedTermsAggregate.md) | [AggregationsLongRareTermsAggregate](./AggregationsLongRareTermsAggregate.md) | [AggregationsStringRareTermsAggregate](./AggregationsStringRareTermsAggregate.md) | [AggregationsUnmappedRareTermsAggregate](./AggregationsUnmappedRareTermsAggregate.md) | [AggregationsMultiTermsAggregate](./AggregationsMultiTermsAggregate.md) | [AggregationsMissingAggregate](./AggregationsMissingAggregate.md) | [AggregationsNestedAggregate](./AggregationsNestedAggregate.md) | [AggregationsReverseNestedAggregate](./AggregationsReverseNestedAggregate.md) | [AggregationsGlobalAggregate](./AggregationsGlobalAggregate.md) | [AggregationsFilterAggregate](./AggregationsFilterAggregate.md) | [AggregationsChildrenAggregate](./AggregationsChildrenAggregate.md) | [AggregationsParentAggregate](./AggregationsParentAggregate.md) | [AggregationsSamplerAggregate](./AggregationsSamplerAggregate.md) | [AggregationsUnmappedSamplerAggregate](./AggregationsUnmappedSamplerAggregate.md) | [AggregationsGeoHashGridAggregate](./AggregationsGeoHashGridAggregate.md) | [AggregationsGeoTileGridAggregate](./AggregationsGeoTileGridAggregate.md) | [AggregationsGeoHexGridAggregate](./AggregationsGeoHexGridAggregate.md) | [AggregationsRangeAggregate](./AggregationsRangeAggregate.md) | [AggregationsDateRangeAggregate](./AggregationsDateRangeAggregate.md) | [AggregationsGeoDistanceAggregate](./AggregationsGeoDistanceAggregate.md) | [AggregationsIpRangeAggregate](./AggregationsIpRangeAggregate.md) | [AggregationsIpPrefixAggregate](./AggregationsIpPrefixAggregate.md) | [AggregationsFiltersAggregate](./AggregationsFiltersAggregate.md) | [AggregationsAdjacencyMatrixAggregate](./AggregationsAdjacencyMatrixAggregate.md) | [AggregationsSignificantLongTermsAggregate](./AggregationsSignificantLongTermsAggregate.md) | [AggregationsSignificantStringTermsAggregate](./AggregationsSignificantStringTermsAggregate.md) | [AggregationsUnmappedSignificantTermsAggregate](./AggregationsUnmappedSignificantTermsAggregate.md) | [AggregationsCompositeAggregate](./AggregationsCompositeAggregate.md) | [AggregationsFrequentItemSetsAggregate](./AggregationsFrequentItemSetsAggregate.md) | [AggregationsTimeSeriesAggregate](./AggregationsTimeSeriesAggregate.md) | [AggregationsScriptedMetricAggregate](./AggregationsScriptedMetricAggregate.md) | [AggregationsTopHitsAggregate](./AggregationsTopHitsAggregate.md) | [AggregationsInferenceAggregate](./AggregationsInferenceAggregate.md) | [AggregationsStringStatsAggregate](./AggregationsStringStatsAggregate.md) | [AggregationsBoxPlotAggregate](./AggregationsBoxPlotAggregate.md) | [AggregationsTopMetricsAggregate](./AggregationsTopMetricsAggregate.md) | [AggregationsTTestAggregate](./AggregationsTTestAggregate.md) | [AggregationsRateAggregate](./AggregationsRateAggregate.md) | [AggregationsCumulativeCardinalityAggregate](./AggregationsCumulativeCardinalityAggregate.md) | [AggregationsMatrixStatsAggregate](./AggregationsMatrixStatsAggregate.md) | [AggregationsGeoLineAggregate](./AggregationsGeoLineAggregate.md);
+```

docs/reference/api/AggregationsAggregateBase.md

@@ -0,0 +1,5 @@
+# `AggregationsAggregateBase` [interface-AggregationsAggregateBase]
+
+| Name | Type | Description |
+| - | - | - |
+| `meta` | [Metadata](./Metadata.md) |   |

docs/reference/api/AggregationsAggregateOrder.md

@@ -0,0 +1,4 @@
+# `AggregationsAggregateOrder` [alias-AggregationsAggregateOrder]
+```typescript
+type AggregationsAggregateOrder = [Partial](./Partial.md)<Record<[Field](./Field.md), [SortOrder](./SortOrder.md)>> | [Partial](./Partial.md)<Record<[Field](./Field.md), [SortOrder](./SortOrder.md)>>[];
+```

docs/reference/api/AggregationsAggregation.md

@@ -0,0 +1,4 @@
+# `AggregationsAggregation` [interface-AggregationsAggregation]
+
+| Name | Type | Description |
+| - | - | - |