Commit Graph

227 Commits

Author SHA1 Message Date
Michael
7ccc0e838e
Update alert docs (#33658)
Update link. (Blind guess as to the proper format. Please check.)
2021-05-03 14:18:05 -04:00
achatterjee-grafana
599a9b9a6d
Add note to Snapshot API doc to specify that user has to provide the entire dashboard model (#33572)
* Added note as suggested by Macus E.

* Update docs/sources/http_api/snapshot.md

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-04-30 13:11:08 -04:00
changdingfang
adc68a310e
Update team.md (#33454) 2021-04-29 10:52:48 -04:00
achatterjee-grafana
37eee84552
Docs: Removed type from find annotations example. (#33399) 2021-04-27 07:28:13 +02:00
Tania B
711cf47b41
Docs: Add license check endpoint doc (#32987)
* Docs: Add license check endpoint doc

* Change request example

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>

* Change response example

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
Co-authored-by: achatterjee-grafana <aparajita.chatterjee@grafana.com>
2021-04-21 15:31:38 -04:00
ying-jeanne
7480d9e2be
Doc: Document the X-Grafana-Org-Id HTTP header (#32478)
* Doc: Document the X-Grafana-Org-Id HTTP header

* Update docs/sources/http_api/auth.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* update the auth.md with X-Grafana-Org-Id

* remove empty line

* Update docs/sources/http_api/auth.md

* Update docs/sources/http_api/auth.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2021-04-21 18:24:56 +02:00
Per
1ed724ea6e
Update team.md (#33060)
Missing start { in http response.

Co-authored-by: achatterjee-grafana <aparajita.chatterjee@grafana.com>
2021-04-16 16:39:38 -04:00
achatterjee-grafana
8edeae416e
Fixed some formatting issues for PRs from yesterday. (#33078) 2021-04-16 12:35:49 -04:00
Diana Payton
db29a8a8de
Docs: Replace next with latest in aliases (#33054) 2021-04-15 23:08:58 +02:00
achatterjee-grafana
cf6d3fb8fb
Added missing link item. (#33052) 2021-04-15 16:56:29 -04:00
Diana Payton
b3ac63dad7
Docs: Replace links with relrefs (#32916)
* Update configuration.md

* Update set-up-for-high-availability.md

* Update glossary.md

* Update glossary.md

* Update cloudwatch.md

* Update add-authentication-for-data-source-plugins.md

* Update add-support-for-explore-queries.md

* fix links

* fix links

* Update license-expiration.md

* Update license-restrictions.md

* Update _index.md

* Update trace-integration.md

* Update admin.md

* Update graph-time-series-as-bars.md

* Update graph-time-series-as-bars.md

* Update graph-time-series-as-lines.md

* Update graph-time-series-as-points.md

* Update release-notes-7-3-0.md

* fix links

* fix links
2021-04-14 08:13:18 -07:00
Torkel Ödegaard
9873809547
Docs: Sync master docs against next version (#32602)
Co-authored-by: Robby Milo <robbymilo@gmail.com>
2021-04-12 09:42:10 +02:00
achatterjee-grafana
29bf863a30
Added "message" to the create dashboard example. (#32452) 2021-03-29 15:00:27 -04:00
ying-jeanne
73a5fec2d7
Docs: /sources/http_api/folder.md (#32407) 2021-03-29 13:21:20 +02:00
Alexander Tymchuk
3efca53edf
Docs: /sources/http_api/user.md (#31152)
I believe it's a mistake in the docs, since http requests against those endpoints are not supposed to be authenticated with API keys. 

If I correctly understand Grafana's auth design, the API key is not issued/tied to a user, therefore there is no mechanism to detect who the user is when the request is authenticated with an API key.

Please note there may be other endpoints like this...
2021-03-26 13:15:10 -04:00
achatterjee-grafana
d912970aff
Added section Query a time series database by id (#31337)
* Added new section Query a time series database by id

* Rearranged content.

* changed database to data source

* Updated note with the word Grafana

* fixed a few typos.

* Removed "time series" as per review.

* Update docs/sources/http_api/data_source.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Changes from Diana's review.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-02-22 13:44:24 -05:00
Torkel Ödegaard
ea6a8eacbf
Docs: Annotations update (#31194)
Fixes #31188
2021-02-17 08:51:27 -05:00
Emil Tullstedt
2a55e00c78
Licensing: Document new v7.4 options and APIs (#30217)
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-01-19 18:09:05 +01:00
Kyle Brandt
1c1a800bc0
API: Add by UID routes for data sources (#29884)
- also add Get by UID+OrgID to datasource cache
- Refactor backend commands for Delete and Get to be unified
2021-01-13 13:16:27 -05:00
Diana Payton
97a104598a
Docs: Remove survey (#29549)
* removed the survey code

* Update _index.md
2020-12-09 07:55:50 -08:00
Agnès Toulet
d92beeee3d
API: add ID to snapshot API responses (#29600)
* API: add ID to snapshot API responses

* API: update snapshot tests
2020-12-04 16:22:58 +01:00
Torkel Ödegaard
94840b3a58
Docs: Fixes what'new menu and creates index page, adds first draft of release notes to docs (#29158)
* Docs: Fixes what'new menu and creates index page, adds first draft of release notes to docs

* Minor tweaks

* Fixed missing letter

* Updates

* Updated

Co-authored-by: Drone <drone@grafana.com>
2020-11-17 16:16:49 +01:00
Robby Milo
abee02dbcd
Docs: updates for file-based menu (#28500)
* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-11-09 12:26:49 -08:00
ndeevy
97262fb8fc
Docs: Made usage of config/configuration consistent #19270 (#28167)
Rebased ndeevy:docs-config/configuration-consistency-update from grafana/master to resolve conflicts

Co-authored-by: ndeevy <ndeevy@redhat.com>
2020-11-03 12:09:49 +01:00
Diana Payton
5254a7ec5d
Docs: Add survey content (#28446)
* Update change-home-dashboard.md

* added survey code

Added survey blurb.

* Update whats-new-in-v7-3.md

* minor edits
2020-10-22 13:22:34 -07:00
Pete Davids
65940c7726
Dashboard: Allow shortlink generation (#27409)
* intial frontend resolution/redirection logic

* backend scaffolding

* enough of the frontend to actually test end to end

* bugfixes

* add tests

* cleanup

* explore too hard for now

* fix build

* Docs: add docs

* FE test

* redirect directly from backend

* validate incoming uids

* add last_seen_at

* format documentation

* more documentation feedback

* very shaky migration of get route to middleware

* persist unix timestamps

* add id, orgId to table

* fixes for orgId scoping

* whoops forgot the middleware

* only redirect to absolute URLs under the AppUrl domain

* move lookup route to /goto/:uid, stop manually setting 404 response code

* renaming things according to PR feedback

* tricky deletion

* sneaky readd

* fix test

* more BE renaming

* FE updates -- no more @ts-ignore hacking :) and accounting for subpath

* Simplify code

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* Short URLs: Drop usage of bus

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* ShortURLService: Make injectable

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* Rename file

Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>

* Add handling of url parsing and creating of full shortURL to backend

* Update test, remove unused imports

* Update pkg/api/short_urls.go

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Add correct import

* Pass context to short url service

* Remove not needed error log

* Rename dto and field to denote URL rather than path

* Update api docs based on feedback/suggestion

* Rename files to singular

* Revert to send relative path to backend

* Fixes after review

* Return dto when creating short URL that includes the full url

Use full url to provide shorten URL to the user

* Fix after review

* Fix relative url path when creating new short url

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Ivana <ivana.huckova@gmail.com>
Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2020-10-14 12:48:48 +02:00
John S
4d3067e139
Docs: Refactor inconsistent unordered lists (#27826)
* Docs: Refactor inconsistent unordered lists

* add requested changes

* Update docs/sources/linking/data-link-variables.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/http_api/_index.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/guides/whats-new-in-v6-0.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/auth/auth-proxy.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* resolve weird line breaks

* revert unintentional change

* Update docs/sources/auth/auth-proxy.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/auth/auth-proxy.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/auth/auth-proxy.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 11:02:11 -07:00
DECarreras
54df058b95
Docs: Fixed lazy numbering in all documentation files (#27975) 2020-10-01 12:45:05 -04:00
denominator
1d2b839a1d
Docs: Fix note format for documentation (#27940) 2020-09-30 12:45:07 -07:00
Phil Nichol
7473e2ae60
Docs: Corrected incorrect uses of (setup|set up) (#27835) 2020-09-28 08:27:50 -07:00
Diana Payton
552e4cb84d
Docs: Remove feature folder (#27830)
* moved files out of tutorials folder

* link update

* updated weights

* moved Explore

* move files and fix links

* moved files out of features

* Revert "moved files out of features"

This reverts commit 5e44cbcc95.

* fixed links
2020-09-25 13:53:13 -07:00
Agnès Toulet
eb970a4985
Org API: enrich add user to org endpoints with user ID in the response (#27551) 2020-09-14 08:58:23 +02:00
Agnès Toulet
6dd109b927
API: return resource ID for auth key creation, folder permissions update and user invite complete endpoints (#27419)
* API: add ID to auth key and folder endpoints

* API: add test for folder permissions update

* API: add created user id for /invite/complete endpoint
2020-09-07 17:06:11 +02:00
Kirchen99
5da3276db1
Dashboard: Use same min refresh interval fallback in the API as in provisioning (#25926)
* Dashboard: Solve the discrepancy between provisioning and the API, Handle min refresh interval when creating/updating dashboard via API

* Docs: Add refresh field in the example dashboard http api docs

* Update create dashboard API docs

Add refresh field in the create dashboard example response

* Fix create dashboard API docs

* Fix create dashboard API docs

* Update docs/sources/http_api/dashboard.md

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-08-17 12:00:10 -07:00
Benjamin Blattberg
3403db190d
API: Support paging in the admin orgs list API (#26932)
* Add page/limit to org search

* Update docs

* Fix test per PR feedback
2020-08-12 10:59:07 +03:00
Agnès Toulet
8dc75f79f7
API: Enrich endpoints with ID (#26691) 2020-07-31 08:22:09 +02:00
Diana Payton
d0e15561c7
Docs: Put curl examples into separate topic (#26530) 2020-07-22 09:48:10 -07:00
Diana Payton
358c2d7031
Docs: Add cURL examples to folder_dashboard_search.md (#26461)
* Update folder_dashboard_search.md

* Update docs/sources/http_api/folder_dashboard_search.md

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>

* Update docs/sources/http_api/folder_dashboard_search.md

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update docs/sources/http_api/folder_dashboard_search.md

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>

* Update docs/sources/http_api/folder_dashboard_search.md

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update folder_dashboard_search.md

* Update folder_dashboard_search.md

Co-authored-by: Sofia Papagiannaki <papagian@users.noreply.github.com>
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-07-21 13:27:49 -07:00
Diana Payton
42295898b8
Docs: Update auth.md (#26034) 2020-07-06 07:56:26 -07:00
Josh Soref
686149966a
docs: spelling (#24383)
* Docs: spelling

* Docs: spelling (contribute/ directory)

* Drop whats-new-in changes
2020-06-30 14:42:50 -07:00
Diana Payton
78996516af
Docs: Update configuration.md (#25707)
* Update configuration.md

* moved configuration.md to administration folder

* updated links

* Added quota section

* Update upgrading.md

* Update configuration.md

* Update configuration.md

* Update configuration.md

* Updating links

* Update configuration.md

* Update configuration.md

* Update configuration.md

Reworked the security options

* Update configuration.md

* Update configuration.md

* Update provisioning.md

* Update provisioning.md

* Update configuration.md

* Update configuration.md

* Update docs/sources/administration/configuration.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2020-06-23 09:56:44 -07:00
Marcus Efraimsson
cc95754e0d
Provisioning: Adds support for enabling app plugins (#25649)
Adds support for enabling app plugins using provisioning. 

Ref #11409

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-06-22 17:49:13 +02:00
Marcus Olsson
79fea5df2a
Docs: Update guide on authenticating data source plugins (#24884)
* Update guide on authenticating data source plugins

* Fix broken references
2020-06-11 12:12:27 +02:00
Nagle Zhang
1b4fd9ad3c
Update team.md (#25277)
document didn't metion teams can assign an orgId.
2020-06-05 07:42:53 +02:00
Sofia Papagiannaki
8f72d621bf
Docs: Add example for updating dashboard panel alert rule (#25260) 2020-06-01 15:53:22 +03:00
Amal
820eb5c80e
Docs: Correcting abbreviations (#24748)
* Correction in abbreviation

* Minor correction in abbreviation

* Correcting abbreviation

* Correction in abbreviation

* Correcting abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Update stack_guide_graphite.md

* Update whats-new-in-v4-6.md

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Update ldap.md

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Correction in abbreviation

* Update docs/sources/guides/whats-new-in-v5.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-05-18 13:56:23 -07:00
Marcus Olsson
fc0c717bfb
Restructure plugin docs (#24381) 2020-05-07 18:45:52 +02:00
Emil Tullstedt
2284f46edb
Reporting: Update docs (#23993) 2020-05-06 09:28:33 +02:00
Sofia Papagiannaki
19f03e593c
Docs: update users API (#23570)
* Docs: update users api

* Apply suggestions from code review

Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2020-04-16 16:45:22 +03:00
Émile Fugulin
d721dd13cd
Allow API to assign new user to a specific organization (#21775)
* Allow API to assign new user to a specific organization

* Add defer block to test

* Add API tests and return 400 instead of 500 for bad orgId

* Minor test improvements
2020-04-15 12:11:45 +03:00