Commit Graph

212 Commits

Author SHA1 Message Date
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
Arve Knudsen
3dde8585ff
Docs: Document default limit of /api/folders (#23435)
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
2020-04-10 17:43:00 +02:00
Jeet Parekh
f1989f1bfc
docs: change URL occurences to uppercase (#22151)
* change URL occurences to uppercase

* Update docs/sources/tutorials/iis.md

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

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-02-14 08:11:08 -08:00
Diana Payton
e1518666dd
Docs: Update dashboard.md (#21951) 2020-02-11 10:36:18 -08:00
Samuel Alfageme
261191ffd7 Docs: misc. nitpicks to the HTTP API docs (#21758)
* Replace bash/json with http in http_api codeblocks

Since http is used elsewhere on the API docs and makes the
markdown rendering look different on the blocks that use bash/json

* Fix the annotations API link on 'Features'

- Noticed the Features/Dashboard Features/Annotations link pointing to
the HTTP API was linking itself instead of '../http_api/annotations.md'.
- Also add a link on Dashboard Export and Import to its HTTP API.

* Add missing links to features in API Index

Noticed there was 3 missing references in the API docs index.
- https://grafana.com/docs/grafana/latest/http_api/playlist
- https://grafana.com/docs/grafana/latest/http_api/datasource_permissions
- https://grafana.com/docs/grafana/latest/http_api/external_group_sync

Last two are Grafana Enterprise -only, so created a separate subsection
for them.
2020-01-27 13:41:15 +01:00
Diana Payton
aada45a4cb
Docs: Update plugin installation and CLI (#21179)
* Update plugin docs

* Updated plugins installation documentation

Moved all Grafana CLI commands into cli.md, moved API script into user.md, rewrote installation.md as an actual task that refers the user to the plugins installation page

* Update cli.md

* Update cli.md

* Update docs/sources/administration/cli.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/administration/cli.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/http_api/user.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update docs/sources/http_api/user.md

Co-Authored-By: Dan Cech <dcech@grafana.com>

* Update cli.md

* Fixed links

* Update cli.md

* Update cli.md

* Update cli.md

* Update cli.md

Co-authored-by: Dan Cech <dan@aussiedan.com>
2020-01-10 09:41:39 -08:00
Diana Payton
ea934048f0
Docs: Update alerting_notification_channels.md (#21245)
* Update alerting_notification_channels.md

Minor edits and fixed stacked heading issue.

* Update docs/sources/http_api/alerting_notification_channels.md

Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2019-12-31 07:30:53 -08:00
Alexandre de Verteuil
4f10dca058 Fix internal links in http_api/dashboard.md (#21255) 2019-12-30 08:38:08 +01:00
Marcus Efraimsson
4835539248
Docs: Fix aliases/redirects (#21241)
Makes all aliases rooted to /docs/grafana/latest.

Fixes #21240
2019-12-30 08:17:03 +01:00
Sofia Papagiannaki
3f48033b38
Docs: Update datasource API examples (#20951)
* Update requests and responses

* Add basic auth example
2019-12-10 15:30:06 +02:00
Robby Milo
cbd81ffeb8 Docs: update content to work with website repo (#20693)
Updates the docs to work with the website repo - mainly 
relative link updates.
Adds a menu.yaml file to build the sidebar menu (no longer 
using front matter weight).
2019-12-05 13:09:57 +01:00
Marcus Efraimsson
1b8701d4c8
Docs: Update change user password payload in http api (#20666)
Fixes #19995
2019-11-26 17:21:25 +01:00
Sofia Papagiannaki
d1c523838b
API: Optionally list expired keys (#20468)
* API: Optionally list expired keys

* Update docs
2019-11-20 13:14:57 +02:00
Yuvaraj Subramanian
6a2a3abccb Docs: Update folder.md (#19674)
Typo fixes
2019-10-08 10:21:47 +02:00
brew-install-buzzwords
618652d16e Docs: Replace ampersands with and (#19609) 2019-10-03 18:20:52 +02:00
gotjosh
4181b30b75
API: Add createdAt and updatedAt to api/users/lookup (#19496)
* API: Add `createdAt` and `updatedAt` to api/users/lookup

In the past, we have added both `updatedAt` (#19004) and `createdAt` (#19475) to /api/users/:id

Turns out, api/users/lookup uses the same DTO for both. This fixes the serialization of both `createdAt` and `updatedAt`for this endpoint.

Also, adds a test to ensure no further regressions.

* Updated API documentation
2019-09-30 20:54:09 +01:00