Commit Graph

176 Commits

Author SHA1 Message Date
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
oddlittlebird
1fc447eba4 Update datasource_permissions.md (#19336)
Minor grammar and format edits
2019-09-24 23:46:55 +02:00
Jérémy Lugand
0516315620 Docs: Uppercase HTTP acronyms (#19317) 2019-09-23 16:07:11 +02:00
Marcus Olsson
5bd94d9c0d
Fix docs issues (#19240) 2019-09-20 00:22:38 +02:00
Brenda Harjala
c9e566b156 Docs: Minor edits to the README and several md files (#19238)
* Update README.md

Capitalized the G and S in "Getting Started," and moved "guide" to match the section title in the docs.

* Fixed sentence structure. Changed "download" to "grafana.com/get" and changed "get" to "download".

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

*  Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)

* Docs: Replace "datasources" with "data sources" (#19111)
2019-09-20 00:04:56 +02:00
oddlittlebird
10d1cb23ba Update _index.md (#19045)
Added missing alias redirect
2019-09-13 18:48:19 +02:00
Marcus Efraimsson
67d6a43df6
Docs: Document LDAP config reload in admin http api (#18739)
Fixes #17221
2019-08-28 13:26:03 +02:00
Torkel Ödegaard
693d0a78af
Docs: Update changelog and docs for annotation region change (#18593) 2019-08-16 11:45:30 +02:00
Ryan McKinley
6335509a23 Annotations: use a single row to represent a region (#17673)
* SQLite migrations

* cleanup

* migrate end times

* switch to update with a query

* real migration

* anno migrations

* remove old docs

* set isRegion from time changes

* use <> for is not

* add comment and fix index decleration

* single validation place

* add test

* fix test

* add upgrading docs

* use AnnotationEvent

* fix import

* remove regionId from typescript
2019-08-16 10:49:30 +02:00
Marcus Efraimsson
8fd153edb7
API: Restrict anonymous user information access (#18422)
Existing /api/alert-notifications now requires at least editor access.
Existing /api/alert-notifiers now requires at least editor access.
New /api/alert-notifications/lookup returns less information than
/api/alert-notifications and can be access by any authenticated user.
Existing /api/org/users now requires org admin role.
New /api/org/users/lookup returns less information than
/api/org/users and can be access by users that are org admins,
admin in any folder or admin of any team.
UserPicker component now uses /api/org/users/lookup instead
of /api/org/users.

Fixes #17318
2019-08-12 20:03:48 +02:00
Sofia Papagiannaki
dc9ec7dc91
Auth: Allow expiration of API keys (#17678)
* Modify backend to allow expiration of API Keys

* Add middleware test for expired api keys

* Modify frontend to enable expiration of API Keys

* Fix frontend tests

* Fix migration and add index for `expires` field

* Add api key tests for database access

* Substitude time.Now() by a mock for test usage

* Front-end modifications

* Change input label to `Time to live`
* Change input behavior to comply with the other similar
* Add tooltip

* Modify AddApiKey api call response

Expiration should be *time.Time instead of string

* Present expiration date in the selected timezone

* Use kbn for transforming intervals to seconds

* Use `assert` library for tests

* Frontend fixes

Add checks for empty/undefined/null values

* Change expires column from datetime to integer

* Restrict api key duration input

It should be interval not number

* AddApiKey must complain if SecondsToLive is negative

* Declare ErrInvalidApiKeyExpiration

* Move configuration to auth section

* Update docs

* Eliminate alias for models in modified files

* Omit expiration from api response if empty

* Eliminate Goconvey from test file

* Fix test

Do not sleep, use mocked timeNow() instead

* Remove index for expires from api_key table

The index should be anyway on both org_id and expires fields.
However this commit eliminates completely the index for now
since not many rows are expected to be in this table.

* Use getTimeZone function

* Minor change in api key listing

The frontend should display a message instead of empty string
if the key does not expire.
2019-06-26 09:47:03 +03:00
Hugo Häggmark
41fb38d522
Docs: Clarifies from which version the Patch VERB is available (#17532)
* Docs: Clarifies from which version the Patch VERB is available

Closes: #17508

* Docs: Removes setting after PR comments
2019-06-12 11:14:30 +02:00
Johannes Schill
3da8cff6e9
Chore: Hugo upgrade (#17494)
* Fix: Upgrade hugo wip

* Chore: Rename index to _index for latest hugo

* Chore: Use relative refs, no starting slash

* Feat: Add possibility to mount layouts from grafana.org project
2019-06-12 08:01:44 +02:00
Shavonn Brown
a20309d7d2
Feature: Parse user agent string in user auth token api response (#16… (#17504)
* Feature: Parse user agent string in user auth token api response (#16222)

* Adding UA Parser Go modules attempt (#16222)

* Bring user agent vals up per req

* fix tests

* doc update

* update to flatten, no maps

* update doc
2019-06-11 14:12:52 +02:00
Carl Bergquist
2dc660d533
docs: remove my email from docs examples (#17325)
I dont want emails from companies who test
alert notifiers :)
2019-05-28 16:02:14 +02:00
bendem
8749574975 Docs: Fix grammar in docs (#17233)
Use of singular and added an article for consistency with other titles.
2019-05-22 17:54:08 +02:00
Marcus Efraimsson
e5971eef1f
docs: clarify page parameter version support for folder/dashboard search (#16836)
Adds a version disclaimer for the page parameter in folder/dashboard search docs.

Fixes #16827
2019-05-01 11:42:03 +02:00
Andrej Ocenas
42b745a098
Provisioning: Add API endpoint to reload provisioning configs (#16579)
* Add api to reaload provisioning

* Refactor and simplify the polling code

* Add test for the provisioning service

* Fix provider initialization and move some code to file reader

* Simplify the code and move initialization

* Remove unused code

* Update comment

* Add comment

* Change error messages

* Add DashboardProvisionerFactory type

* Update imports

* Use new assert lib

* Use mutext for synchronizing the reloading

* Fix typo

Co-Authored-By: aocenas <mr.ocenas@gmail.com>

* Add docs about the new api
2019-04-25 09:06:44 +02:00
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