Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[APM] docs: add more API information #68717

Merged
merged 1 commit into from
Jun 11, 2020

Conversation

bmorelli25
Copy link
Member

Summary

It has become clear through user reports that linking to the Kibana REST API documentation is not sufficient for documenting the new APM APIs. This PR adds documentation around the three request headers needed to interact with these APIs, and clarifies that you cannot use the dev console as these are not ES APIs.

Related issues

Closes elastic/apm#275.

@bmorelli25 bmorelli25 added Team:APM All issues that need APM UI Team support release_note:skip Skip the PR/issue when compiling release notes v7.8.0 labels Jun 9, 2020
@bmorelli25 bmorelli25 self-assigned this Jun 9, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

Copy link
Member

@dgieselaar dgieselaar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @bmorelli25!

@bmorelli25 bmorelli25 merged commit 6ec3c23 into elastic:master Jun 11, 2020
@bmorelli25 bmorelli25 deleted the api-clarifications branch June 11, 2020 05:35
bmorelli25 added a commit to bmorelli25/kibana that referenced this pull request Jun 11, 2020
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jun 11, 2020
* master: (38 commits)
  Support migrating from reserved feature privileges (elastic#68504)
  add `preference` field to SavedObjectsFindOptions (elastic#68620)
  [ILM] Add "wait for snapshot" policy field to Delete phase (elastic#68505)
  Cleanup old license overwrites (elastic#68744)
  Bump TypeScript to v3.9 (elastic#67666)
  [APM] Service maps - adds new storybook stories to test out various data sets (elastic#68727)
  Fix vega specification parsing (elastic#67963)
  docs: add more api information (elastic#68717)
  [APM] Don't show annotations on charts with no data (elastic#68829)
  [Metrics UI] Fix Inventory View sorting by handling null values (elastic#67889)
  skip flaky suite (elastic#68836)
  [SIEM][Detections Engine] - Fix reference rule url overflow (elastic#68640)
  Index pattern public api => common (elastic#68289)
  [APM] Lazy-load alert triggers (elastic#68806)
  [DOCS] Fix table formatting in ingest manager settings (elastic#68824)
  [Endpoint] Functional Tests cleanup (elastic#68756)
  revert previous commit which was unintentional
  Use Github token instead for project assignments
  [SIEM][Exceptions] - ExceptionsViewer cleanup (elastic#68739)
  move @kbn/storybook to devDeps (elastic#68791)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support v7.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Add note to use CURL for calling APM APIs
3 participants