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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Updates API requests and examples #60695

Merged
merged 3 commits into from
Mar 20, 2020
Merged

[DOCS] Updates API requests and examples #60695

merged 3 commits into from
Mar 20, 2020

Conversation

KOTungseth
Copy link
Contributor

Summary

  • Added <kibana host>:<port>/api/etc to all requests
  • Updated examples to include $ curl -X POST "localhost:5601/api/
  • Made a handful of other changes for consistency

Checklist

  • Documentation was added for features that require explanation or tutorials

@KOTungseth KOTungseth added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v7.7.0 v7.6.0 labels Mar 19, 2020
@KOTungseth KOTungseth self-assigned this Mar 19, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

joshdover
joshdover approved these changes Mar 19, 2020
View reviewed changes
Copy link
Contributor

@joshdover joshdover left a comment

Choose a reason for hiding this comment

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

LGTM, just a couple suggestions

docs/api/dashboard/export-dashboard.asciidoc Outdated
@@ -9,7 +9,7 @@ experimental[] Export dashboards and corresponding saved objects.
[[dashboard-api-export-request]]
==== Request

`GET /api/kibana/dashboards/export`
`GET <kibana host>:port/api/kibana/dashboards/export`
Copy link
Contributor

Choose a reason for hiding this comment

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

Should port also be in angle brackets?

Suggested change
`GET <kibana host>:port/api/kibana/dashboards/export`
`GET <kibana host>:<port>/api/kibana/dashboards/export`

If so, the rest will need to be changed as well.

docs/api/dashboard/export-dashboard.asciidoc Outdated
@@ -35,8 +35,8 @@ experimental[] Export dashboards and corresponding saved objects.

[source,js]
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a console or sh type for syntax highlighting?

@KOTungseth KOTungseth merged commit fda3196 into elastic:master Mar 20, 2020
@KOTungseth KOTungseth deleted the docs/api-requests branch March 20, 2020 21:33
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Mar 20, 2020
@KOTungseth
[DOCS] Updates API requests and examples (elastic#60695)
3207cf4 
* [DOCS] Updates API requests and examples

* Review comments
@KOTungseth KOTungseth mentioned this pull request Mar 20, 2020
Merged
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Mar 20, 2020
@KOTungseth
[DOCS] Updates API requests and examples (elastic#60695)
8084bf6 
* [DOCS] Updates API requests and examples

* Review comments
@KOTungseth KOTungseth mentioned this pull request Mar 20, 2020
Merged
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 21, 2020
@kibanamachine
Copy link
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

1 similar comment
@kibanamachine
Copy link
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

gmmorris added a commit to gmmorris/kibana that referenced this pull request Mar 23, 2020
@gmmorris
Merge branch 'master' into alerting/tls-warning
6230180 
* master: (39 commits)
  [APM]Create custom link from Trace summary (elastic#59648)
  [ML] Fixing app clean up (elastic#60853)
  [SIEM] Use ECS categorisation for Authentication widgets (elastic#60734)
  [NP] Remove kbnUrl usage in discover/dashboard/visualize (elastic#60016)
  Skip failing test
  [Uptime]Update fetch effect failed action handling (elastic#60742)
  [npm] upgrade elastic/maki (elastic#60829)
  [Uptime] Add Settings Page (elastic#53550)
  [APM] service maps: avoid unnecesary `useDeepObjectIdentity` (elastic#60836)
  [Index management] Re-enable index template tests (elastic#60780)
  Fixed UI/UX issues: alerts delete confirmation, combobox behaviors (elastic#60703)
  [SIEM] Fix patching of ML Rules (elastic#60830)
  [APM] Service Map - Separate overlapping edges by rotating nodes (elastic#60477)
  [Alerting] fix flaky test for index threshold grouping (elastic#60792)
  [SIEM][Detection Engine] Adds test scripts for machine learning feature
  Flatten child api response for resolver (elastic#60810)
  Change "url" to "urls" in APM agent instructions (elastic#60790)
  [DOCS] Updates API requests and examples (elastic#60695)
  [SIEM] [Cases] Create case from timeline (elastic#60711)
  [Lens] Resetting a layer generates new suggestions (elastic#60674)
  ...
@kibanamachine
Copy link
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

1 similar comment
@kibanamachine
Copy link
Contributor

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

KOTungseth added a commit that referenced this pull request Mar 26, 2020
@KOTungseth
[7.x] [DOCS] Updates API requests and examples (#60695) (#60826)
967186b 
* [DOCS] Updates API requests and examples (#60695)

* [DOCS] Updates API requests and examples

* Review comments

* Fixed error
KOTungseth added a commit that referenced this pull request Mar 26, 2020
@KOTungseth
[7.6] [DOCS] Updates API requests and examples (#60695) (#60827)
6c24a49 
* [DOCS] Updates API requests and examples (#60695)

* [DOCS] Updates API requests and examples

* Review comments

* Fixed errors
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Mar 26, 2020
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Apr 17, 2020
@KOTungseth
[DOCS] Updates API requests and examples (elastic#60695)
a7bc009 
* [DOCS] Updates API requests and examples

* Review comments
@KOTungseth KOTungseth mentioned this pull request Apr 17, 2020
Merged
KOTungseth added a commit to KOTungseth/kibana that referenced this pull request Apr 17, 2020
@KOTungseth
[DOCS] Updates API requests and examples (elastic#60695)
985ded9 
* [DOCS] Updates API requests and examples

* Review comments
@KOTungseth KOTungseth mentioned this pull request Apr 17, 2020
Merged
KOTungseth added a commit that referenced this pull request Apr 17, 2020
@KOTungseth
[DOCS] Updates API requests and examples (#60695) (#63903)
789818f 
* [DOCS] Updates API requests and examples

* Review comments
KOTungseth added a commit that referenced this pull request Apr 17, 2020
@KOTungseth @elasticmachine
[DOCS] Updates API requests and examples (#60695) (#63904)
154f011 
* [DOCS] Updates API requests and examples

* Review comments

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshdover joshdover joshdover approved these changes

Assignees

@KOTungseth KOTungseth

Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.6.0 v7.7.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@KOTungseth @elasticmachine @kibanamachine @joshdover