[Docs]Updates ToC - API and Reference Sections #18
Conversation
benskelker
changed the title
benskelker
force-pushed
the
timeline-api-and-object-schema
branch
from
e5a1da6 to
f2925d6
Compare
|
@angorayc - this is the file (timeline schema) I want to finalise first: https://github.com/elastic/security-docs/pull/18/files#diff-096d4f209a384c835f720d067fef1abf After that, documenting the API should be straightforward. Thanks |
benskelker
force-pushed
the
timeline-api-and-object-schema
branch
from
ae70155 to
6fe9af1
Compare
benskelker
force-pushed
the
timeline-api-and-object-schema
branch
from
6fe9af1 to
6755418
Compare
| |============================================== | ||
| |Name |Type |Description | ||
|
|
||
| |`aggregatable` |Boolean |??? |
There was a problem hiding this comment.
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html#search-field-caps-api-response-body
Whether this field can be aggregated on all indices.
| |`columnHeaderType` |String |??? | ||
| |`description` |String |??? | ||
| |`example` |String |??? | ||
| |`indexes` |String |??? |
There was a problem hiding this comment.
the same as indices in https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html#search-field-caps-api-response-body
The list of indices where this field has the same type, or null if all indices have the same type for the field.
| |`description` |String |??? | ||
| |`example` |String |??? | ||
| |`indexes` |String |??? | ||
| |`id` |String |??? |
There was a problem hiding this comment.
alias of actual field from ECS or user defined field name
| |`example` |String |??? | ||
| |`indexes` |String |??? | ||
| |`id` |String |??? | ||
| |`name` |String |??? |
There was a problem hiding this comment.
typically null, this field is reserved for future use
There was a problem hiding this comment.
@angorayc - should we remove this for now?
| |`id` |String |??? | ||
| |`name` |String |??? | ||
| |`placeholder` |String |??? | ||
| |`searchable` |Boolean |??? |
There was a problem hiding this comment.
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html#search-field-caps-api-response-body
Whether this field is indexed for search on all indices.
| |`excluded` |Boolean |Indicates if the dropzone query clause uses `NOT` logic. | ||
| |`id` |String |The dropzone query clause's unique ID. | ||
| |`kqlQuery` |String |Always an empty string (not used).??? | ||
| // Can be removed? |
There was a problem hiding this comment.
I think we are following some reusable schema across Kibana, therefore we can sometimes find the property is there but we are not actually using it.
benskelker
changed the title
|
@angorayc @XavierM @jmikell821 @Donnater Thanks! |
benskelker
changed the title
* starts adding timeline api and object schema * continues timeline object schema * timeline schema * minor edits * another correction * corrections - round 1 * table structure * correction cont * adds screenshot * fixes terminology * wording * wording * more corrections and stuff * more stuff * LIVERPOOL 30 YEARS * improves screenshot callouts * corrections are meeting * fixes link * restrcuture ToC * cleanup * improves pinned events description * removes timeline schema file text
* starts adding timeline api and object schema * continues timeline object schema * timeline schema * minor edits * another correction * corrections - round 1 * table structure * correction cont * adds screenshot * fixes terminology * wording * wording * more corrections and stuff * more stuff * LIVERPOOL 30 YEARS * improves screenshot callouts * corrections are meeting * fixes link * restrcuture ToC * cleanup * improves pinned events description * removes timeline schema file text
benskelker
changed the title
Moves the API and ref sections to first-level chapters.
Adds Timeline API object schema.Timeline schema previewAll other changes are just for restructuring the new Elastic Security docs ToC, and they do not need to be reviewed.