habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP better generated API reference docs

Browse Source
This commit is contained in:
Josh Mock
2025-05-27 15:30:21 -05:00
parent a1dc6f55ee
commit b627037af1
3745 changed files with 30211 additions and 15508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
docs/reference/api/API.md Normal file
View File

@ -0,0 +1,90 @@
## 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) |   |