Commit Graph

207 Commits

Author SHA1 Message Date
Daniel Strobusch 748425cd66
[docs] remove misplaced heading. (#93166) 2024-09-11 12:59:29 +03:00
Ieva 3197c5de8d
RBAC: Add available scopes to RBAC docs (#93131)
* update the list with some allowed RBAC scopes

* extend the http api docs as well

* display without bulletpoints

* add prettier ignores
2024-09-10 08:50:03 +00:00
Pepe Cano e87140bf75
API Docs: create `Authentication` page and order sidebar menu (#92900)
* API Docs: create `Authentication` page and order sidebar menu

* fix minor typos

* Update capitalization

We don't capitalize titles as per https://grafana.com/docs/writers-toolkit/write/style-guide/capitalization-punctuation/

* Update docs/sources/developers/http_api/examples/_index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/developers/http_api/authentication.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

---------

Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-09-06 08:17:20 +02:00
Mihai Doarna ebd17adecf
API keys: Return 410 Gone status from POST /auth/keys endpoint (#92965)
* return 410 Gone status from POST /auth/keys endpoint

* generate swagger

* remove postAPIkeyResponse

* re-generate swagger

* remove docs for api key creation endpoint
2024-09-05 13:10:24 +03:00
Ieva b99d1249db
Docs: Update the docs for folder creation permissions (#92703)
* update the docs to reflect permissions needed to create subfolders

* Minor language fix

---------

Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
2024-08-30 10:55:32 +00:00
Pepe Cano 6a29e4aecf
IAM docs: Transform `API keys` to `Migrate API keys` docs (#92380)
* IAM docs: Transform `API keys` to `Migrate API keys` docs

* Update links to `API keys` in other doc pages

* Grafana UI: update help button link

* Update OpenAPI/Swagger links

* Update docs/sources/administration/service-accounts/migrate-api-keys.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update `relref` links to the new URL

* fix space before em dash

spaces before or after em dashes are not recommended (https://developers.google.com/style/dashes)

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
2024-08-30 11:37:36 +02:00
Pepe Cano fcb4b3d39e
Docs: keep the HTTP API list updated (#92635)
* Docs: keep the HTTP API list updated

* Update menu title to be consistent with the HTTP API list

* Update docs/sources/developers/http_api/preferences.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/developers/http_api/snapshot.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

---------

Co-authored-by: Irene Rodriguez <irene.rodriguez@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-08-30 10:27:24 +02:00
Jack Baldry 5e89a9060b
Remove all documented references to `time_options` (#92657) 2024-08-29 13:47:26 +01:00
Ieva a72b557886
Docs: Extend docs with service account limitations (#92630)
* extend docs with service account limitations

* linting

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* PR feedback

* more PR feedback

* linting

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-08-29 09:50:11 +00:00
Eric Leijonmarck 6a19278f23
API Keys: Removal & Redirect of Create endpoint (#92144)
* API keys: redirecting of create endpont

* update naming and using admonition

* fmt

* Apply suggestions from code review

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

---------

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
2024-08-28 12:20:36 +01:00
Kristina 1dd830b9f1
Correlations: Migrate config type to root (#91855)
* WIP

* Validate new field, and add value in provisioning if not defined in correct spot

* Simplify logic, use correct value

* fix tests

* Fix linter errors

* fix swagger and tests

* 😬

* Auto-generation isnt doing this..

* Fix linter

* test if nullable is the issue…

* Change structure on the frontend fields

* Try with backtick

* try programatic quoting

* Try only quote non-ints

* quoting, no backticks

* Remove debugging
2024-08-26 08:02:48 -05:00
Ieva 5bae9f11bc
Docs: Add docs for bulk updating team members (#91499)
add docs for bulk updating team members
2024-08-12 09:58:55 +01:00
Joao Silva 85d0e17dc4
Bookmarks: Store URLs instead of ids (#91121) 2024-07-31 13:56:39 +01:00
Joao Silva 546f4aa700
Navigation: Show list of pinned items on MegaMenu (#90280)
* Navigation: Show list of pinned ites on the navigation

* Rename section to 'Bookmarks'

* Internationalization

* Rename everything to bookmarks

* Update public/app/core/reducers/navBarTree.ts

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>

* Ignore empty message as well

* Dont update navigation if there is an error patching

---------

Co-authored-by: Alex Khomenko <Clarity-89@users.noreply.github.com>
2024-07-22 11:43:40 +01:00
Joao Silva 9004b58851
Navigation: Backend to save navigation customization into preferences (#89783) 2024-07-03 10:40:51 +01:00
Ieva 10857c5400
Docs: Use bearer auth not basic auth in IAM doc examples (#88984)
use bearer auth not basic auth in examples
2024-06-11 10:35:22 +03:00
Misi eacf6e0a4d
Auth: Add org to role mappings support to GitHub integration (#88537)
* wip: add extra tests for verifying current logic

* Add OrgRole mapping and tests

* Update docs

* Clean up

* Update docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md

Co-authored-by: Mihai Doarna <mihai.doarna@grafana.com>

* Update docs with None role

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Fix

* Prettier docs

* Cleanup tests

---------

Co-authored-by: Mihai Doarna <mihai.doarna@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-06-03 14:24:58 +02:00
Mihai Doarna d83288b8c5
Docs: Improve the SSO settings API docs (#87599)
* improve SSO settings API docs

* address feedback
2024-05-31 11:22:54 +03:00
Jack Baldry 01cd2efbef
[docs/sources/developers] Replace docs/reference shortcode with ref URIs (#88088) 2024-05-20 16:29:57 +01:00
Ezequiel Victorero 42d75ac737
Dashboards: Add feature restore dashboards backend (#83131)
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
2024-05-16 14:36:26 -03:00
nextMJ 309adcaa7f
Typo fix in User API doc example (#81890)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-04-24 06:13:51 +01:00
Pepe Cano a56a842d5f
Alerting docs: fix `docs/shared` API to render the current version (#85526) 2024-04-03 16:04:58 +02:00
chalapat 65c0669f01
Server: Reload TLS certs without a server restart (#83589)
* server: reload of grafana server certs when renewed without restart.

Signed-off-by: Rao, B V Chalapathi <b_v_chalapathi.rao@nokia.com>

* server: reload of grafana server certs when renewed without restart.

Signed-off-by: Rao, B V Chalapathi <b_v_chalapathi.rao@nokia.com>

* Update http_server.go

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update http_server.go

Address the comments

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Dan Cech <dan@aussiedan.com>

* Update http_server.go

Align the spaces

* Update http_server.go

* Update http_server.go

* Update pkg/api/http_server.go

Co-authored-by: Dan Cech <dan@aussiedan.com>

---------

Signed-off-by: Rao, B V Chalapathi <b_v_chalapathi.rao@nokia.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Dan Cech <dan@aussiedan.com>
2024-03-22 17:13:22 +02:00
Gilles De Mey 8765c48389
Alerting: Remove legacy alerting (#83671)
Removes legacy alerting, so long and thanks for all the fish! 🐟

---------

Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
Co-authored-by: Sonia Aguilar <soniaAguilarPeiron@users.noreply.github.com>
Co-authored-by: Armand Grillet <armandgrillet@users.noreply.github.com>
Co-authored-by: William Wernert <rwwiv@users.noreply.github.com>
Co-authored-by: Yuri Tseretyan <yuriy.tseretyan@grafana.com>
2024-03-14 15:36:35 +01:00
Armand Grillet e33e219a9a
Remove legacy alerting docs (#84190) 2024-03-12 05:37:41 +01:00
Misi 0b71354c8d
Docs: Improve SSO Settings docs (#83914)
* Improve docs

* remove trailing slash

* Update relref
2024-03-09 19:24:48 +01:00
Jack Baldry 2a1d4f85c7
Update links to default Grafana branch (#83025) 2024-02-29 17:08:45 +02:00
omahs 2a429cd7db
Fix typos (#83621)
Co-authored-by: Isabel Matwawana <isabel.matwawana@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-29 10:47:22 +00:00
Takashi Idobe f209a5a8b8
fix typos (#83414) 2024-02-26 10:52:44 -07:00
Arati R ff916d9c15
Docs: Update docs for creating nested folders (#82310) 2024-02-15 15:21:01 +01:00
Lucy Chen f2ac24f9a0
Documentation: Incorrect API example for Public Dashboard (#82335)
fix doc
2024-02-13 13:08:49 -05:00
Pepe Cano 9c92329bee
Alerting docs: `Provision alerting resources` updates (#82221)
* Alert provisioning: initial restructuring

* Fix products labels

* Restructure `Import and export Grafana Alerting resources`

* Change URL to `export-alerting-resources`

* Complete `Export alerting resources`

* Export alerting resources

* Update `configuration files` provisioning

* Terraform Provisioning

* Change to `Provision/Import/Export` terms and some notes

* Replace `config` to `configuration`

* Set (menu)Title `Export alerting resources`

* Minor change on note about `Export Alerting endpoints`

* Fix `doc-validator` issues

* Fix grammar

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Fix numbered lists and `Note:` without admonition

* Convert text-based notes (`Note:`) to `admonition` blocks

* Replace text-based `Note:` with adminitions

* Remove `file-provisioning` grafana-cloud links

* Update `Export alerting resources` intro

* nitpicky format order

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2024-02-12 10:27:18 +01:00
Clarence 2d25ce8aab
chore: update typos found in docs (#81850) 2024-02-05 21:46:35 +02:00
brendamuir ba70ee9b50
Docs: adds update to x-provenance (#81863)
* Docs: adds update to x-provenance

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-02-05 15:06:28 +01:00
Tania 14a36b4040
Folders: Forbid performing operations on folders via dashboards HTTP API (#81264)
* Forbid creating folders via dashboard api

* Update delete endpoint

* Update docs
2024-02-04 01:16:19 +01:00
Jara Suárez de Puga García b821e1621c
Alerting Provisioning API: documentation Update. (#80388)
* Update alerting_provisioning.md

* Introduction and references

* UID variable consistency formatting

* Folder and Group variables consistency formatting

* Delete Note from Contact Point section

* api/v1/provisioning/folder/:folderUid/rule-groups/:group clarifications and extension. Request #8218

* Prettier format document

* {name} to :name and format

* Comma

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2024-01-25 09:40:20 -08:00
Ashley Harrison 3e073c4dc1
Nested Folders: Update documentation (#81054)
* docs updates!

* Apply suggestions from code review

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Apply suggestions from code review

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* simplify

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2024-01-25 09:20:37 +00:00
Dai Nguyen 0aaebbb9a2
Docs: Updating Service Account API to include a note for Grafana Cloud instances (#80685)
* Update Bearer Token serviceaccount.md

To update the Service Account API to include a note stating that a Bearer token for Grafana Cloud instances is needed.

* Update docs/sources/developers/http_api/serviceaccount.md

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2024-01-23 22:44:20 +02:00
colin-stuart 6e8e4a8b77
Auth: Add docs for the SSO Settings List endpoint (#80927)
* add docs for SSO Settings List endpoint

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

---------

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
2024-01-22 12:20:16 -05:00
colin-stuart 097f3c7e06
Auth: Add docs for the SSO Settings get endpoint (#80240)
* add docs for sso-settings get endpoint

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

* Update docs/sources/developers/http_api/sso-settings.md

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>

---------

Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
2024-01-16 13:27:28 -05:00
Pascal Zimmermann 1129f80746
docs: Adjust the update command documentation of the public dashboard endpoint (#77925) 2024-01-12 19:07:16 +02:00
Mihai Doarna 930efc3824
Auth: Add docs for the SSO Settings update endpoint (#79980)
add docs for sso settings update endpoint
2024-01-10 16:03:03 +02:00
Pangidoan Butar 5589c0a8f2
Updating swagger endpoint (#80008)
The user should navigate to /swagger-ui instead of /swagger
2024-01-09 12:07:40 -08:00
Kristina aa2f74a6c6
Navigation: More updates to the docs for admin subsections (#78857)
* Add more subnav to docs

* Add bold around UX text
2023-11-30 08:19:07 -06:00
Mihai Doarna df4eba4654
Add documentation for the SSO settings delete API method (#78521)
add documentation for the sso settings delete API method
2023-11-29 17:57:29 +02:00
Ryan McKinley b8e8d84ef7
Swagger: Show k8s APIs (#78091) 2023-11-15 06:42:35 -08:00
Ieva 9c47161c14
Docs: deprecate API key reference docs and update API tutorial to use service accounts (#77429)
* deprecate API key reference docs and update API tutorial to use service accounts

* Update create-api-tokens-for-org.md
2023-10-31 15:29:08 +02:00
Ieva 7a9ec6b4e0
RBAC: update data source permission API reference (#76613)
* update data source permission docs

* Update datasource_permissions.md

* Update docs/sources/developers/http_api/datasource_permissions.md

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>
2023-10-24 16:51:12 +03:00
Jo 79b2974215
Teams: Allow Services to register deletes (#76325)
* add team RegisterDelete

* fix-docs
2023-10-11 15:57:03 +02:00
Misi e1aad9c9bf
Docs: Update RBAC documentation (#75869)
* Align docs to current permissions in code

* Update permissions list

* Add example responses, fix link

* Apply suggestions from code review

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update based on reviews

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-10-04 17:53:26 +02:00
Jack Baldry 4432c4c75c
Fix developer links and newly discovered spelling errors (#75875)
* Fix developer links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix newly discovered spelling errors

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-03 13:49:27 +01:00
Gabriel MABILLE 6ffd4a23de
Team: Support `sort` query param for teams search endpoint (#75622)
* Teams: Implement backend sorting

* Add docs

* Make name ordering case insensitive

* lint

* Fix no lowercasing on memberCount

* Add test to double check the filters or correctly OrderBy
2023-09-28 18:20:51 +03:00
Gabriel MABILLE 96cbe70b14
User: Support `sort` query param for user and org user, search endpoints (#75229)
* User: Add sort option to user search

* Switch to an approach that uses the dashboard search options

* Cable user sort on the org endpoint

* Alias user table with u in org store

* Add test and cover orgs/:orgID/users/search endpoint

* Add test to userimpl store

* Simplify the store_test with sortopts.ParseSortQueryParam

* Account for PR feedback

* Positive check

* Update docs

* Update docs

* Switch to ErrOrFallback

Co-authored-by: Karl Persson <kalle.persson@grafana.com>

---------

Co-authored-by: Karl Persson <kalle.persson@grafana.com>
2023-09-28 10:16:18 +02:00
Ryan McKinley bbdd1fc3b1
Playlist: Remove unused/deprecated api and unused wrapper (#75503) 2023-09-27 15:28:16 +00:00
Piotr Jamróz 946da57b6a
Correlations: Allow creating correlations for provisioned data sources (#73737)
* Allow creating correlations for provisioned data sources

* Update docs

* Fix linting

* Add missing props

* Add missing props

* Fix linting

* Fix linting

* Clarify error name

* Removed error handling for a non-existing use case

* Create a list of deleted data datasources based on all configs

* Add org_id to correlations

* Add tests

* Allow org_id to be null in case org_id=0 is used

* Create organization to ensure stable id is generated

* Fix linting

* Ensure backwards compatibility

* Add deprecation information

* Update comments

* Override existing datasSource variable so the UID is retrieved correctly

* Migrate correlations indices

* Default org_id when migrating

* Remove redundant default

* Make PK non-nullable

* Post merge fixes

* Separate data sources / correlations provisioning

* Adjust comments

* Store new data sources in spy store so it can be used to test correlations as well

* Fix linting

* Update tests

* Ensure response is closed

* Avoid creating duplicates during provisioning

* Fix updating provisioned column and update tests

* Rename error message

* Fix linting errors

* Fix linting errors and rename variable

* Update test

* Update pkg/services/sqlstore/migrations/correlations_mig.go

Co-authored-by: Giordano Ricci <me@giordanoricci.com>

* Remove unused error

* Fix lining

---------

Co-authored-by: Giordano Ricci <me@giordanoricci.com>
2023-09-13 15:10:09 +02:00
brendamuir ab963a8558
Alerting docs: quick corrections to oncall integration (#74758)
* Alerting docs: quick corrections to oncall integration

* corrects spelling errors
2023-09-12 19:46:03 +02:00
Sofia Papagiannaki 376f9a75db
Folders: Do not allow modifying the folder UID via the API (#74684)
* Folders: Do not allow changing the folder UID via the API

* Update Swagger/OpenAPI docs

* Update HTTP API docs
2023-09-12 14:28:33 +03:00
Ezequiel Victorero a4c8f04565
PublicDashboards: Create initial API docs (#74424) 2023-09-08 16:10:44 -03:00
Ashley Harrison a7425f875e
Browse Dashboards: Update docs to remove reference to `General` folder (#74528)
* update documentation to remove mention of General folder

* update swagger-tags
2023-09-08 03:57:16 +01:00
David Allen b0715816d8
Documentation linting on library_element docs (#74407)
* vale lint documentation changes

* run prettier

---------

Co-authored-by: unknown <antonio.caleromerello@grafana.com>
2023-09-06 20:49:05 +03:00
sarah-spang d8fd4c2cbe
Docs: Include Cloud support with RBAC API (#73522)
Update access_control.md

Update to show that RBAC HTTP API can be used with a Cloud account also.
2023-08-29 12:18:07 -07:00
Torkel Ödegaard 74d453f056
DashboardSchema: Remove old unused legacy props style and timepicker.enable (#73879)
* DashboardScheam: Remove old unused legacy props style and timepicker.enable

* Update

* fix test
2023-08-28 12:18:17 +02:00
bojankezele cb040a72bd
access control api: Correction of typo in list your permissions endpoint (#64399)
Correction of API endpoint

Correction of an API endpoint in 'List your permissions' section. Current endpoint results in 404 page
2023-08-25 16:40:09 +02:00
Ezequiel Victorero bb3a2d31d7
Docs: Update dashboards api create/update (#73345) 2023-08-17 12:20:00 -05:00
Clément Duveau 5eef8291e2
Add a warning in the documentation (#72975)
A partner complained in the name of a customer. They have 6k datasources and it took them some time to figure out why they only had 5k coming back.

This commit add a warning for this edge case, content is pretty clear.
2023-08-08 14:15:45 -07:00
tonypowa b6c8ac6dd1
Alerting: added description to api resource (#70597)
* added description to api resource

* prettier now
2023-08-03 10:15:26 +02:00
tonypowa 956b865a2e
Docs update: /docs/sources/developers/http_api/user.md (#72430)
updated endpoint authentication
2023-08-02 13:26:16 -07:00
Zvonimir Burić a13130f503
Update team_sync.md (#70423) 2023-07-31 16:33:03 +01:00
bla2ej 50bd27b665
API: fix docs of users API (#62365) (#62816)
* API: fix docs of users API (#62365)

Behaviour described in the issue is correct.
So with this we add comment explaining this behaviour.

Resolves: #62365

* fixing formating

* Update docs/sources/developers/http_api/user.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-07-28 07:03:56 -07:00
Matthew Jacobson cfb1656968
Alerting: Add notification policy provisioning file export (#70009)
* Alerting: Add notification policy provisioning file export

- Add provisioning API endpoint for exporting notification policies.
- Add option in notification policy view ellipsis dropdown for exporting.
- Update various provisioning documentation.
2023-07-24 17:56:53 -04:00
Matthew Jacobson 13121d3234
Alerting: Add contact point provisioning file export (#71692)
* Add contact point provisioning file export apis

* Regenerate api

* docs

* frontend

* add mock to tests

* Fix missing row-level export button on viewer role w/ prov. read

* Address review comments

---------

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
2023-07-20 14:35:56 -04:00
Clément Duveau 62c6e04d70
Docs: fix broken links (#71911)
* Fix different broken links and missing pages

* Pin version in docs link for release announcements

* fixing validator error

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-20 12:39:59 -04:00
Sofia Papagiannaki 3a50d7ea84
Docs: Update HTTP API docs for nested folders (#67412)
* Docs: Update HTTP API docs for nested folders

* Apply suggestions from code review

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-19 12:20:21 +03:00
Jack Baldry 7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix introduction pages products

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00
Kristina f18a02149a
Correlations: Create paginated API (#65241)
* Add pagination params and apply to sql

* Create getCorrelationsResponse that returns metadata

* Set up pagination, change correlations fetch to only get source datasource correlations

* Move correlations from root to pane, only fetch correlations for one datasource when initialized or datasource is changed

* Fix tests

* Fix remaining tests

* Use functional component to handle state

* Remove unneeded mocks, fix tests

* Change perPage to limit

* Fix Go Tests

* Fix linter

* Remove parameter

* Account for mixed datasources

* Delete unused hook

* add source UID filter to API, start backing out front end hook changes

* add source IDs to API, use when loading or changing datasource

* Fix prettier

* Mock correlations response

* Get correlations for all datasources in mixed scenario

* Add documentation for new parameters

* Attempt to fix swagger

* Fix correlations page

* add swagger and openapi docs

* Add mocks to failing test

* Change API for consistency, remove extra hooks and unused function

* Add max to limit and re-gen api docs

* Move the page to the previous page if deleting all the rows on the page

* Only fetch if remove does not have value

* Change page to a reference hook

* Fix documentation, a test and some logic thinking page could be 0
2023-07-05 09:37:17 -05:00
Frederic Hemberger ad8211cce7
docs/serviceaccount.md - Incorrect key "role" for creating token (#68809)
The key "role" in the JSON body doesn't make sense for creating service account *tokens* (and the method will happily create one without it). It is only required for creating the service account itself.
2023-06-30 16:14:31 +01:00
brendamuir 6dc65d4d5d
Docs: fixes provisioning table display (#70065)
* Docs: fixes provisioning table display

* Demonstrate correct usage

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* adds responsive table to rest of tables

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-06-14 18:18:16 +02:00
brendamuir 5a2e66676e
Docs:fixes alerting support escalations (#69770)
* Docs:fixes alerting support escalations

* updates recording rule text

* adds link

* fixes link

* Update docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fixes relref

* adds link to prometheus docs

* fixes relref

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-06-09 10:58:05 +02:00
Vardan Torosyan 0e5e5175b1
Docs: Bring back the alias for external group sync HTTP API page (#69434)
* Docs: Bring back the alias for external group sync HTTP API page

* Update docs/sources/developers/http_api/team_sync.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-06-02 15:01:33 +02:00
Vardan Torosyan 8235f774aa
Docs: Rename External Group Sync references to Team Sync (#69395) 2023-06-01 10:48:32 -05:00
Pascal Zimmermann 4aa207ed83
Docs: Update the service account HTTP API documentation (#63235)
* doc: Add the service account deletion function

* doc: Add new service account documentation
2023-05-26 09:33:40 -07:00
brendamuir 863f826e62
Docs Alerting: Fixes table in alerting API docs (#68962)
Fixes table in alerting API docs
2023-05-25 08:01:25 +02:00
Jack Baldry 6c4cf4f8b9
Enable doc-validator for alerting directories (#68964)
* Enable doc-validator for alerting directories

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Adds missing description frontmatter

* Fix some more links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix some more links

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixes anchors

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2023-05-24 14:12:30 +01:00
Matt Dodson 1c4bb9ca00
[feat] docs; update admonition syntax (#68842)
* [feat] docs; update admonition syntax

- Standardizes according to style conventions: https://grafana.com/docs/writers-toolkit/style-guide/style-conventions/#admonitions
- Prepares docs for better, uniform admonition style.

* Remove false positives and irregularities

* false positive removal

* Update docs/sources/datasources/mysql/_index.md

* Update docs/sources/developers/angular_deprecation/angular-plugins.md

* fix link errors

* Prettify some nested blockquotes

* remoe unnecessary admonition
2023-05-22 15:45:28 -05:00
Sofia Papagiannaki 14fb4ff779
API: Add deprecation notice for updating folder UID (#68543)
* API: Add deprecation notice for updating folder UID
2023-05-16 18:28:18 +03:00
Giordano Ricci b5a2c3c7f5
Query History: Remove migration (#67470) 2023-04-28 16:03:51 +01:00
Michael Mandrus e9971dd153
Docs: Create documentation for enterprise caching HTTP API (#67169)
* create http docs for query caching

* fix endpoints

* Update docs/sources/developers/http_api/query_and_resource_caching.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* run prettier

* super small change to reflect incoming API update

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
2023-04-27 17:28:26 +03:00
Ieva 9a29dd7d6e
Docs: Documentation updates for nested folder permissions (#66599)
doc updates for nested folder permissions
2023-04-21 06:29:52 -04:00
brendamuir 9b529ef0cd
Docs: adds legacy wording to api docs (#66937)
adds legacy wording to api docs
2023-04-20 14:06:35 +03:00
Alex Moreno f64a89727e
Alerting: Allow provenance disable in alerting provisioning API (#63650)
* Allow provenance None in alert rule update and rule group replace

* Allow provenance None in contact point update

* Allow updating policies to none by sending x-disable-provenance header

* Allow mute timings to disable provenance with x-disable-provenance header

* Allow disabling provenance by using x-disable-provenance header

* Add provenance helper to lower the cyclomatic complexity

* Do not downgrade provenance except un ReplaceRuleGroup

* Add function explanation and change error handling

* Add docs for x-disable-provenance changes (#66300)

* Add docs for x-disable-provenance changes

* Apply suggestions from code review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update _index.md

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>

* Update docs/sources/alerting/set-up/provision-alerting-resources/_index.md

Co-authored-by: George Robinson <george.robinson@grafana.com>

* Add error message check in tests

* Change docs

---------

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
2023-04-18 15:10:36 +02:00
Gábor Farkas 0cff917f2a
Elasticsearch: Removed reference to obsolete esVersion value (#65415)
* elastic: removed reference to obsolete esVersion value

* removed unused code

* cleaned up tests
2023-03-28 17:04:56 +03:00
Jack Baldry ebb54aea8d
Fix website build errors both for Grafana and content mounted in Grafana Cloud (#64794)
* Fix reference to Grafana CLI

- Make relref for relative permalink
- Use relative path for unambiguous resolution

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix alerting relref anchor format

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Avoid ambiguous relref lookups by forcing relative resolution

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove reference to non-existent shared page

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix links broken in Grafana Cloud using absolute relrefs

By resolving the relref absolutely, it refers to the same location
regardless of mounted directory.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove trailing slash for bundle independent resolution

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* For now, avoid Hugo checking cross repository /docs/grafana-cloud link

The path is unlikely to change in the short term and this makes CI
completely green for now.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* No need to specify path for in page anchors

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix prose

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-03-15 17:06:31 +00:00
Sofia Papagiannaki 8aae7be4e5
API: Enable serving Swagger UI by default and add docs and guidelines (#63489)
* Enable serving Swagger UI by default

It used to be served behind the `swaggerUi` feature toggle.

* Remove `swaggerUi` feature toggle

* Add docs and guidelines for updating swagger

* Apply suggestions from code review

Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
2023-03-01 16:36:37 +02:00
Julien Duchesne 4b0faf1c9e
Playlist docs: Remove `orgId` (#63298)
Playlist: Remove `orgId`

That attribute is not returned by the API
2023-02-14 13:42:56 +01:00
Jack Baldry 4037e5e325
Add canonical URL to all HTTP API docs (#62957)
Facilitates mounting these docs in the Grafana Cloud documentation set
without affecting SEO.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-02-06 17:14:36 +00:00
Sonia Aguilar 753c84f825
Alerting: Pass yaml as a query param in export request (#62751)
* Set YAML as default value for exporting alert rules

* use YAML format for rule list export

Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>

* lint

* Add new format query param to swagger+docs

* Fix broken test

---------

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
Co-authored-by: Matt Jacobson <matthew.jacobson@grafana.com>
2023-02-02 16:10:02 +00:00
ismail simsek 91221bc436
Expressions: Fixes the issue showing expressions editor (#62510)
* Use suggested value for uid

* update the snapshot

* use __expr__

* replace all -100 with __expr__

* update snapshot

* more changes

* revert redundant change

* Use expr.DatasourceUID where it's possible

* generate files
2023-01-31 18:50:10 +01:00
Matthew Jacobson c006df375a
Alerting: Create endpoints for exporting in provisioning file format (#58623)
This adds provisioning endpoints for downloading alert rules and alert rule groups in a 
format that is compatible with file provisioning. Each endpoint supports both json and 
yaml response types via Accept header as well as a query parameter 
download=true/false that will set Content-Disposition to recommend initiating a download 
or inline display.

This also makes some package changes to keep structs with potential to drift closer 
together. Eventually, other alerting file structs should also move into this new file 
package, but the rest require some refactoring that is out of scope for this PR.
2023-01-27 11:39:16 -05:00
George Robinson d4256b352d
Docs: Rename Message templates to Notification templates (#59477)
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
2023-01-18 17:26:34 +00:00
Emil Tullstedt fc47e0d35e
Docs: Update curl example to use --user for basic auth (#61226) 2023-01-11 11:18:26 +01:00