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

12
docs/reference/api/MappingRuntimeField.md Normal file
View File

@ -0,0 +1,12 @@
## Interface `MappingRuntimeField`
| Name | Type | Description |
| - | - | - |
| `fetch_fields` | ([MappingRuntimeFieldFetchFields](./MappingRuntimeFieldFetchFields.md) | [Field](./Field.md))[] | For type `lookup` |
| `fields` | Record<string, [MappingCompositeSubField](./MappingCompositeSubField.md)> | For type `composite` |
| `format` | string | A custom format for `date` type runtime fields. |
| `input_field` | [Field](./Field.md) | For type `lookup` |
| `script` | [Script](./Script.md) | [ScriptSource](./ScriptSource.md) | Painless script executed at query time. |
| `target_field` | [Field](./Field.md) | For type `lookup` |
| `target_index` | [IndexName](./IndexName.md) | For type `lookup` |
| `type` | [MappingRuntimeFieldType](./MappingRuntimeFieldType.md) | Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`, `keyword`, `long`, or `lookup`. |