docs(http_api): convert to new docs format

This commit is contained in:
bergquist
2016-11-24 10:16:24 +01:00
parent df2b2e3058
commit 6081c6cb61
9 changed files with 95 additions and 46 deletions

View File

@ -1,8 +1,13 @@
---- +++
page_title: Admin APIs title = "Admin HTTP API "
page_description: Grafana Admin API Reference description = "Grafana Admin HTTP API"
page_keywords: grafana, admin, http, api, documentation keywords = ["grafana", "http", "documentation", "api", "admin"]
--- aliases = ["/http_api/admin/"]
type = "docs"
[menu.docs]
name = "Admin"
parent = "http_api"
+++
# Admin API # Admin API

View File

@ -1,8 +1,13 @@
---- +++
page_title: Authentication API title = "Authentication HTTP API "
page_description: Grafana HTTP API Reference description = "Grafana Authentication HTTP API"
page_keywords: grafana, admin, http, api, documentation keywords = ["grafana", "http", "documentation", "api", "authentication"]
--- aliases = ["/http_api/authentication/"]
type = "docs"
[menu.docs]
name = "Authentication"
parent = "http_api"
+++
# Authentication API # Authentication API

View File

@ -1,8 +1,13 @@
---- +++
page_title: Dashboard API title = "Dashboard HTTP API "
page_description: Grafana Dashboard API Reference description = "Grafana Dashboard HTTP API"
page_keywords: grafana, admin, http, api, documentation, dashboard keywords = ["grafana", "http", "documentation", "api", "dashboard"]
--- aliases = ["/http_api/dashboard/"]
type = "docs"
[menu.docs]
name = "Dashboard"
parent = "http_api"
+++
# Dashboard API # Dashboard API

View File

@ -1,8 +1,14 @@
---- +++
page_title: Data source API title = "Data source HTTP API "
page_description: Grafana Data source API Reference description = "Grafana Data source HTTP API"
page_keywords: grafana, admin, http, api, documentation, datasource keywords = ["grafana", "http", "documentation", "api", "data source"]
--- aliases = ["/http_api/datasource/"]
type = "docs"
[menu.docs]
name = "Data source"
parent = "http_api"
+++
# Data source API # Data source API

View File

@ -1,8 +1,14 @@
---- +++
page_title: Organisation API title = "Organisation HTTP API "
page_description: Grafana Organisation API Reference description = "Grafana Organisation HTTP API"
page_keywords: grafana, admin, http, api, documentation, orgs, organisation keywords = ["grafana", "http", "documentation", "api", "organisation"]
--- aliases = ["/http_api/organisation/"]
type = "docs"
[menu.docs]
name = "Organisation"
parent = "http_api"
+++
# Organisation API # Organisation API

View File

@ -1,8 +1,14 @@
---- +++
page_title: Other APIs title = "Other HTTP API "
page_description: Grafana Other API Reference description = "Grafana Other HTTP API"
page_keywords: grafana, admin, http, api, documentation, dashboards keywords = ["grafana", "http", "documentation", "api", "other"]
--- aliases = ["/http_api/other/"]
type = "docs"
[menu.docs]
name = "Other"
parent = "http_api"
+++
# Frontend Settings API # Frontend Settings API

View File

@ -1,15 +1,21 @@
---- +++
page_title: HTTP API title = "HTTP API "
page_description: Grafana HTTP API Reference description = "Grafana HTTP API"
page_keywords: grafana, admin, http, api, documentation keywords = ["grafana", "http", "documentation", "api", "overview"]
--- aliases = ["/http_api/overview/"]
type = "docs"
[menu.docs]
name = "Overview"
parent = "http_api"
+++
# HTTP API Reference # HTTP API Reference
The Grafana backend exposes an HTTP API, the same API is used by the frontend to do everything from saving The Grafana backend exposes an HTTP API, the same API is used by the frontend to do everything from saving
dashboards, creating users and updating data sources. dashboards, creating users and updating data sources.
###Supported HTTP APIs: ## Supported HTTP APIs:
* [Authentication API](/http_api/auth/) * [Authentication API](/http_api/auth/)
* [Dashboard API](/http_api/dashboard/) * [Dashboard API](/http_api/dashboard/)

View File

@ -1,8 +1,13 @@
---- +++
page_title: Preferences API title = "HTTP Preferences API "
page_description: Grafana Preferences API Reference description = "Grafana HTTP API"
page_keywords: grafana, preferences, http, api, documentation keywords = ["grafana", "http", "documentation", "api", "preferences"]
--- aliases = ["/http_api/preferences/"]
type = "docs"
[menu.docs]
name = "Preferences"
parent = "http_api"
+++
# User and Org Preferences API # User and Org Preferences API

View File

@ -1,8 +1,13 @@
---- +++
page_title: Snapshot API title = "HTTP Snapshot API "
page_description: Grafana Snapshot API Reference description = "Grafana HTTP API"
page_keywords: grafana, admin, http, api, documentation, snapshot, dashboard keywords = ["grafana", "http", "documentation", "api", "snapshot"]
--- aliases = ["/http_api/snapshot/"]
type = "docs"
[menu.docs]
name = "Snapshot"
parent = "http_api"
+++
# Snapshot API # Snapshot API