Commit Graph

195 Commits

Author SHA1 Message Date
Torkel Ödegaard
8b0dd4244b
Search: Fixes search limits and adds a page parameter (#16458)
* Search: Fixes search limits and adds a page parameter

This adds a page parameter to search api without adding
any major breaking change.

It does at an api validation error when trying to use
a limit beyond 5000. This is a breaking change. We could
remove this and have it only in the docs and describe that this
is a limit that grafana will apply silently.

Fixes #16049

* Fix: Corrected wrong array slice change

* Docs: minor docs fix

* Search: fixed folder tests

* Fixed: Moved limit to correct inner query

* Search: moving limit check and page check

* Search: limit in handler is no longer needed
2019-04-17 13:07:50 +02:00
Marcus Efraimsson
3d82c848dd
docs: fixes and update current version 2019-04-09 17:30:21 +02:00
Marcus Efraimsson
79b86466fd Fix: Alerting Notification channel http api fixes (#16288)
Fix so that uid can be changed when updating notification
channels through the http api.
Update documentation
2019-03-29 09:42:38 +01:00
Marcus Efraimsson
2ae63e70c0
Alerting: Notification channel http api enhancements (#16219)
Now returns uid in response to get notification channel by id.
Adds GET/PUT/DELETE support for notification channel by uid, 
  /api/alert-notifications/uid/:uid.
Break apart alerting and alert notification http api docs in two 
  pages and update documentation to make it up to date
  with current implementation.

Fixes #16012
2019-03-26 18:37:02 +07:00
Paweł Krupa
2a207d6970
clarify notifications API docs 2019-03-24 11:49:20 +01:00
Marcus Efraimsson
80ce11a4a4
docs: update admin and user http api documentation 2019-03-08 15:15:57 +01:00
Leonard Gram
1bcaaccb96
docs: missing field added to example
Closes #15715
2019-03-01 16:07:34 +01:00
Marcus Efraimsson
6848fe0edf
docs: update annotaions http api 2019-02-06 14:26:43 +01:00
SamuelToh
4de9e3598b Address review comments 2019-02-06 06:41:39 +10:00
SamuelToh
a7a964ec19 Added PATCH verb end point for annotation op
Added new PATCH verb annotation endpoint

Removed unwanted fmt

Added test cases for PATCH verb annotation endpoint

Fixed formatting issue

Check arr len before proceeding

Updated doc to include PATCH verb annotation endpt
2019-02-05 09:43:17 +10:00
Frank lin Piat
1fc5ea181a
Document /api/health
Document the health check implemented in #3302 (and #935), see  https://github.com/grafana/grafana/issues/3302#issuecomment-297066201
2019-01-25 17:52:28 +01:00
Torkel Ödegaard
4712a87733
Revert "Specify expected encoding for access/secret key" 2019-01-18 16:37:43 +01:00
Mohammed Salman Khan
aa799c6f0b
Fixed Syntax for folder permission's JSON 2019-01-14 10:53:16 -05:00
Andrew Prokhorenkov
294fb7b3bc
fix JSON in responses for Admin API documentation 2019-01-06 16:57:44 -06:00
Mario Trangoni
5d60d323e2 docs/*: Fix misspell issues
See,
$ find . -type f | xargs misspell -locale US | grep -vi -e vendor -e node_modules -e devenv -e unknwon | grep docs
2018-11-29 18:14:20 +01:00
Daniel Hollcraft
4a2e9b4bfa
chore: correct pause-all-alerts auth in docs 2018-11-26 09:43:26 -05:00
supercharlesliu
a241f67fba Add doc for api "GET /api/users/:id/teams" 2018-11-20 10:17:46 +08:00
Marcus Efraimsson
33469ecfab
docs: team http api update 2018-11-14 17:59:32 +01:00
Marcus Efraimsson
662808f092
Merge pull request #13930 from grafana/enterprise-docs
docs: restructure and enhancement
2018-11-08 01:50:35 -08:00
Dan Cech
1bc3f0af07
Update docs/sources/http_api/datasource_permissions.md
Co-Authored-By: marefr <marcus.efraimsson@gmail.com>
2018-11-06 15:56:12 +01:00
Matthew Miner
7e13aa2cfb Fix minor JSON typo in HTTP API docs 2018-11-01 10:05:26 -07:00
Marcus Efraimsson
280c8631f9
docs: enhanced ldap 2018-10-31 18:01:30 +01:00
Marcus Efraimsson
5495072c83
docs: fix datasource permissions keywords 2018-10-31 17:18:31 +01:00
Marcus Efraimsson
fc6d7c9b6b
datasource permission http api 2018-10-30 19:02:12 +01:00
Emil Hessman
69cf131f81 docs: fix minor typos 2018-10-06 17:09:41 +02:00
Torkel Ödegaard
320947359c Merge branch '12886-docs-authentication-section' 2018-09-06 13:16:17 +02:00
Marcus Efraimsson
51069c9ccb
docs: reminder notifications update 2018-08-23 18:56:37 +02:00
Patrick O'Carroll
76bd173a36 created a section under administration for authentication, moved ldap guide here, created pages for auth-proxy, oauth, anonymous auth, ldap sync with grafana ee, and overview, moved authentication guides from configuration to, added linksin configuration page to guides 2018-08-23 15:58:37 +02:00
Marcus Efraimsson
b8671b201e
Merge pull request #12879 from anwar6953/patch-1
Fix typo
2018-08-14 22:56:00 +02:00
Marcus Efraimsson
c5c518fd17
docs: remove message property in response from get alerts http api
Fixes #12524
2018-08-14 15:17:29 +02:00
Ali Anwar
5fd8849d65
Update dashboard.md 2018-08-11 23:44:15 -07:00
Ali Anwar
8d2aac0936
Fix typo 2018-08-11 23:42:31 -07:00
Marcus Efraimsson
beddfdd86b
add api route for retrieving teams of signed in user 2018-08-08 10:26:05 +02:00
Augustin
05e060dee0 HTTP API documentation +fix when updating a playlist (#12612)
* get id from path param when updating a playlist

* add playlist http api documentation

* remove required condition for the id in update cmd
2018-07-17 07:45:38 -07:00
Augustin Husson
86a574cc50 refix the settings indentation 2018-07-04 12:30:23 +02:00
Augustin Husson
991a4b1663 update stats admin doc 2018-07-04 12:26:30 +02:00
Augustin Husson
01fc6c5d95 fix json indentation 2018-07-04 12:23:10 +02:00
Marcus Efraimsson
7a4858dd11
docs: update folders api 2018-06-29 20:24:02 +02:00
Marcus Efraimsson
cdaeb1578d
docs: update organisation http api
make the distinction clearer between /api/org and /api/orgs and that
basic auth must be used for the /api/orgs resource
2018-06-29 19:10:42 +02:00
Dan Cech
3056d9a80e support passing api token in Basic auth password (#12416) 2018-06-28 03:08:32 -07:00
Malcolm Jones
2765afc830 Document the endpoint for deleting an org 2018-06-14 15:28:54 -04:00
Patrick O'Carroll
0c269d64d0 Alert panel filters (#11712)
alert list panel: filter alerts by name, dashboard, folder, tags
2018-06-01 14:36:40 +02:00
Dan Cech
417db13efb Fix dashboard snapshot deletion (#12025)
* fix issue deleting dashboard snapshots by deleteKey, add dedicated endopoint for authenticated requests, update frontend, tests & docs.
2018-05-24 08:55:16 +02:00
Carl Bergquist
a376de56f2
Merge pull request #11934 from liquidm/improve_alert_docs
Improve alert docs
2018-05-21 14:34:58 +02:00
Stuart McLean
c09c00a1f5 fixes following first code review 2018-05-15 10:06:26 +02:00
Stuart McLean
295169b94f add useful note to alerting api docs 2018-05-14 20:50:44 +02:00
Stuart McLean
2dd40eb4e4 improve alerting api docs sample responses 2018-05-14 20:50:08 +02:00
Bernie
1157542f70
Update dashboard_permissions.md
miss { in repsponse
2018-05-11 10:19:28 +08:00
Daniel Lee
2c3b8bb035
Merge pull request #9910 from jeroenj/patch-1
Adding a user in a specified organisation uses the admin API
2018-05-08 23:09:25 +02:00
Marcus Efraimsson
85ccefdb84
Merge branch 'master' into docs-5.1 2018-04-24 16:17:15 +02:00
Daniel Lee
3451f9a9db Merge branch 'annotations-created' of https://github.com/ryantxu/grafana into ryantxu-annotations-created 2018-04-20 17:14:06 +02:00
Marcus Efraimsson
7e8bd8d004
Merge branch 'master' into docs-5.1 2018-04-18 14:39:38 +02:00
ohadbenita
4664549411
Specify expected encoding for access/secret key 2018-04-17 23:55:07 +03:00
Marcus Efraimsson
92ac1fbb5b
Merge branch 'master' into docs-5.1 2018-04-16 09:58:46 +02:00
Mario Trangoni
638f7d23d4 docs: fix codespell issues 2018-04-13 20:31:29 +02:00
Marcus Efraimsson
fa95297e6a
docs: update default annotation limit when querying api
Needed due to closing #11569
2018-04-13 10:58:29 +02:00
Caleb Tote
5f47523d76
Update annotations.md to contain correct annotations api path 2018-04-09 15:09:37 -04:00
ryan
a2bbd89a9e adding updated column 2018-03-22 15:52:09 +01:00
Marcus Efraimsson
34d9983da2 docs: add team api link from http api reference page 2018-03-12 13:57:32 +01:00
Marcus Efraimsson
f1fc1672be docs: minor fix for dashboard http api documentation
Reported in #11176
2018-03-09 10:39:50 -05:00
Daniel Lee
cc2f478792 Merge branch 'docs_v5.0' 2018-03-01 09:36:48 +01:00
Laurent Godet
59704ee939 Fix Github OAuth not working with private Organizations (#11028)
* Fix Github OAuth not working with private organizations

* Update documentation
2018-02-28 13:08:15 +01:00
Marcus Efraimsson
e350653430 docs: fix type in datasource http api 2018-02-23 14:52:45 +01:00
Marcus Efraimsson
c367cb294e docs: minor folder http api changes 2018-02-22 16:07:55 +01:00
Marcus Efraimsson
02b412b127 docs: update http api index 2018-02-21 13:11:32 +01:00
Marcus Efraimsson
7d89f19f6f docs: dashboard and folder permissions http api 2018-02-21 13:09:54 +01:00
Marcus Efraimsson
b5e96f5ec2 docs: folder http api 2018-02-21 13:09:01 +01:00
Torkel Ödegaard
2f6e77af1e Merge branch 'master' into docs_v5.0 2018-02-21 10:47:14 +01:00
Daniel Lee
2bcd7cd25b
docs: status code changes for Team API 2018-02-16 11:18:41 +01:00
Daniel Lee
8377d3630c docs: team API. Closes #10832 2018-02-15 23:05:16 +01:00
stukselbax
3d91a1cbdd
Duplicate typo fixed 2018-02-14 10:53:14 +03:00
Marcus Efraimsson
2bddf50184 docs: update dashboard permissions http api docs 2018-02-12 14:50:35 +01:00
Marcus Efraimsson
1e0817f863 docs: update http api for api index, dashboard, folder and dashboard search 2018-02-05 20:53:58 +01:00
Daniel Lee
34ab882986 docs: adds http api dashboard permissions 2018-02-05 17:13:05 +01:00
Marcus Efraimsson
8ce2074eb2 docs: fix links in HTTP API Reference page
Fixes #10745
2018-02-05 14:05:52 +01:00
Torkel Ödegaard
07fa2f1722
fix: alert list links did not work, changed dashboardUri to Url, this is breaking api change in alert api (#10756) 2018-02-05 09:42:41 +01:00
Alexandre Rio
8ced9f6462
Update search datasource by name API path
Correct path for search by name endpoint is /api/datasources/:name
2018-02-01 16:41:33 +01:00
Andrew Prokhorenkov
30e51ad136
fix missing comma in documentation output example 2017-12-19 22:30:35 +02:00
bergquist
4a433ee630
docs: include all notifiers type 2017-12-14 14:45:17 +01:00
Carl Bergquist
35106537f2 Replace Read Only Editor role with ViewersCanEdit setting (#10166)
* removes readonly editor role

* adds viewersCanEdit setting

This enable you to allow viewers to edit/inspect
dashboards in grafana in their own browser without
allowing them to save dashboards

* remove read only editor option from all dropdowns

* migrates all read only viewers to viewers

* docs: replace readOnlyEditor with viewersCanEdit
2017-12-13 18:53:42 +01:00
Marcus Efraimsson
5b05941dec docs: Improve delete snapshot documentation 2017-11-23 13:08:44 +01:00
bergquist
ca940c2ae5 docs: adds docs for pausing all alerts 2017-11-22 09:31:23 +01:00
Jeroen Jacobs
5b926cc102
Adding a user in a specified organisation uses the admin API 2017-11-17 12:19:18 +01:00
Marcus Efraimsson
540d540ea9 fix: return id from api when creating new annotation/graphite annotation, fixes #9798
When creating a region annotation the response will include both
id (region start id) and endId (region end id), if not only id.
2017-11-16 16:19:01 +01:00
Ratna Deep Simhadri
538a8cff1e
chore(docs): update the search Query Example
- Updated the last  Search Dashboards Example , so that the Example Request and Response seem related
2017-11-01 23:04:51 -07:00
zhengkai
2848773ab4 #edit_grafana_organisation_apis_doc (#9651) 2017-10-25 08:15:51 +02:00
bergquist
dea631bedc tech: remove rabbitmq event publisher
closes #9645
2017-10-24 14:10:23 +02:00
Alexander Zobnin
74e90d01ec Fixes for annotations API (#9577)
* annotations: throw error if no text specified and set default time to Now() if empty, #9571

* annotations: fix saving graphite event with empty string tags

* docs: add /api/annotations/graphite endpoint docs, #9571
2017-10-18 10:13:02 +02:00
Torkel Ödegaard
25aa9df270 Create annotations (#8197)
* annotations: add 25px space for events section

* annotations: restored create annotation action

* annotations: able to use fa icons as event markers

* annotations: initial emoji support from twemoji lib

* annotations: adjust fa icon position

* annotations: initial emoji picker

* annotation: include user info into annotation requests

* annotation: add icon info

* annotation: display user info in tooltip

* annotation: fix region saving

* annotation: initial region markers

* annotation: fix region clearing (add flot-temp-elem class)

* annotation: adjust styles a bit

* annotations: minor fixes

* annoations: removed userId look in loop, need a sql join or a user cache for this

* annotation: fix invisible events

* lib: changed twitter emoij lib to be npm dependency

* annotation: add icon picker to Add Annotation dialog

* annotation: save icon to annotation table

* annotation: able to set custom icon for annotation added by user

* annotations: fix emoji after library upgrade (switch to 72px)

* emoji: temporary remove bad code points

* annotations: improve icon picker

* annotations: icon show icon picker at the top

* annotations: use svg for emoji

* annotations: fix region drawing when add annotation editor opened

* annotations: use flot lib for drawing region fill

* annotations: move regions building into event_manager

* annotations: don't draw additional space if no events are got

* annotations: deduplicate events

* annotations: properly render cut regions

* annotations: fix cut region building

* annotations: refactor

* annotations: adjust event section size

* add-annotations: fix undefined default icon

* create-annotations:  edit event (frontend part)

* fixed bug causes error when hover event marker

* create-annotations:  update event (backend)

* ignore grafana-server debug binary in git (created VS Code)

* create-annotations: use PUT request for updating annotation.

* create-annotations: fixed time format when editing existing event

* create-annotations: support for region update

* create-annotations: fix bug with limit and event type

* create-annotations: delete annotation

* create-annotations: show only selected icon in edit mode

* create-annotations: show event editor only for users with at least Editor role

* create-annotations: handle double-sized emoji codepoints

* create-annotations: refactor

use CP_SEPARATOR from emojiDef

* create-annotations: update emoji list, add categories.

* create-annotations: copy SVG emoji into public/vendor/npm and use it as a base path

* create-annotations: initial tabs for emoji picker

* emoji-picker: adjust styles

* emoji-picker: minor refactor

* emoji-picker: refactor - rename and move into one directory

* emoji-picker: build emoji elements on app load, not on picker open

* emoji-picker: fix emoji searching

* emoji-picker: refactor

* emoji-picker: capitalize category name

* emoji-picker: refactor

move buildEmojiElem() into emoji_converter.ts for future reuse.

* jquery.flot.events: refactor

use buildEmojiElem() for making emojis, remove unused code for font awesome based icons.

* emoji_converter: handle converting error

* tech: updated

* merged with master

* shore: clean up some stuff

* annotation: wip tags

* annotation: filtering by tags

* tags: parse out spaces etc. from a tags string

* annotations: use tagsinput component for tag filtering

* annotation: wip work on how we query alert & panel annotations

* annotations: support for updating tags in an annotation

* linting

* annotations: work on unifying how alert history annotations and manual panel annotations are created

* tslint: fixes

* tags: create tag on blur as well

Currently, the tags directive only creates the tag when the
user presses enter. This change means the tag is created on
blur as well (when the user clicks outside the input field).

* annotations: fix update after refactoring

* annotations: progress on how alert annotations are fetched

* annotations: minor progress

* annotations: progress

* annotation: minor progress

* annotations: move tag parsing from tooltip to ds

Instead of parsing a tag string into an array in the annotation_tooltip
class, this moves the parsing to the datasources. InfluxDB ds already
does that parsing. Graphite now has it.

* annotations: more work on querying

* annotations: change from tags as string to array

when saving in the db and in the api.

* annotations: delete tag link if removed on edit

* annotation: more work on depricating annotation title

* annotations: delete tag links on delete

* annotations: fix for find

* annotation: added user to annotation tooltip and added alertName to annoation dto

* annotations: use id from route instead from cmd for updating

* annotations: http api docs

* create annotation: last edits

* annotations: minor fix for querying annotations before dashboard saved

* annotations: fix for popover placement when legend is on the side (and doubel render pass is causing original marker to be removed)

* annotations: changing how the built in query gets added

* annotation: added time to header in edit mode

* tests: fixed jshint built issue
2017-10-07 10:31:39 +02:00
Patrick O'Carroll
81be4e2612 Update codebox (#9430)
* updated the codeboxes in docs

* codebox change from json to http
2017-10-05 19:01:03 +02:00
Tobias Hintze
af79d046db introduce smtp config option for EHLO identity 2017-09-24 20:48:20 +02:00
Carl Bergquist
4670c74942 Merge pull request #9022 from adriangarza/master
added CloudWatch data source API documentation
2017-09-07 14:10:53 +02:00
Daniel Lee
52676161bb docs: update to http api admin section
Make it clearer that it only works with basic auth
2017-09-05 10:04:01 +02:00
Daniel Lee
c4feef2541 docs: http api /users - corrections + adds missing method 2017-08-11 10:24:54 +02:00
Adrian Garza
5420f271f1 added CloudWatch data source API documentation
access and secret keys are base64-encoded gibberish
2017-08-10 16:03:42 -07:00
Fredrik Wendt
5542309170 fixed incorrect header text (#8952)
Status code now replaced with Query parameters
2017-07-29 15:34:22 +01:00
Fredrik Wendt
6b344d0158 removed incorrect HTTP response data (#8949)
the example response body contained incorrect out-of-place data, presumably from a copy-paste operation
2017-07-28 09:25:30 +02:00
Daniel Lee
68e7219135 docs: add missing parameter api call 2017-07-09 02:00:50 +02:00
Ben Tranter
6f4c7a4d65 Add dashboard version history documentation (#8741)
Adds docs for the new API endpoints, and for the dashboard history feature.
2017-07-03 14:29:30 +02:00
Daniel Lee
cb720d8eaf docs: add body options for snapshot api 2017-06-13 23:17:14 +02:00