@@ -11,11 +11,15 @@ Some APM app features are provided via a REST API:
1111* <<agent-config-api>>
1212* <<annotation-api>>
1313
14- TIP: Kibana provides additional <<api,REST APIs>> ,
15- and general information on <<using-api,how to use APIs>> .
14+ TIP: The Kibana <<api,REST API reference>> provides additional information on how to use Kibana APIs ,
15+ like required request headers and authentication options .
1616
17- // Basic auth or API can be used
18- // Need to talk about permissions req'd
17+ // AGENT CONFIG API
18+ // GET --> Feature (APM) Read
19+ // CREAT/EDIT/DELETE --> Feature (APM) All
20+
21+ // ANNOTATION API
22+ // Still in progress
1923
2024////
2125*******************************************************
@@ -299,7 +303,7 @@ The following APIs are available:
299303// * <<obs-annotation-delete>> DELETE /api/observability/annotation/:id
300304
301305By default, annotations are stored in a newly created `observability-annotations` index.
302- The name of this index is configurable with `CONFIG_NAME_AND_LINK_HERE `.
306+ The name of this index can be changed in your `config.yml` by editing `xpack.observability.annotations.index `.
303307
304308////
305309*******************************************************
@@ -337,7 +341,8 @@ The name of this index is configurable with `CONFIG_NAME_AND_LINK_HERE`.
337341(optional, string) The message displayed in the annotation. Defaults to `service.version`.
338342
339343`tags`::
340- (optional, array) Tags that are useful for what? Defaults to `[apm]`.
344+ (optional, array) Tags are used by the APM app to distinguish APM annotations from other annotations.
345+ Tags may have additional functionality in future releases. Defaults to `[apm]`.
341346
342347[[apm-annotation-config-example]]
343348===== Example
0 commit comments