From 6081c6cb618548c60f0790a68576175b38d022ee Mon Sep 17 00:00:00 2001 From: bergquist Date: Thu, 24 Nov 2016 10:16:24 +0100 Subject: [PATCH] docs(http_api): convert to new docs format --- docs/sources/http_api/admin.md | 15 ++++++++++----- docs/sources/http_api/auth.md | 15 ++++++++++----- docs/sources/http_api/dashboard.md | 15 ++++++++++----- docs/sources/http_api/data_source.md | 16 +++++++++++----- docs/sources/http_api/org.md | 16 +++++++++++----- docs/sources/http_api/other.md | 16 +++++++++++----- docs/sources/http_api/overview.md | 18 ++++++++++++------ docs/sources/http_api/preferences.md | 15 ++++++++++----- docs/sources/http_api/snapshot.md | 15 ++++++++++----- 9 files changed, 95 insertions(+), 46 deletions(-) diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md index fb1b0659cd9..2d15b19454c 100644 --- a/docs/sources/http_api/admin.md +++ b/docs/sources/http_api/admin.md @@ -1,8 +1,13 @@ ----- -page_title: Admin APIs -page_description: Grafana Admin API Reference -page_keywords: grafana, admin, http, api, documentation ---- ++++ +title = "Admin HTTP API " +description = "Grafana Admin HTTP API" +keywords = ["grafana", "http", "documentation", "api", "admin"] +aliases = ["/http_api/admin/"] +type = "docs" +[menu.docs] +name = "Admin" +parent = "http_api" ++++ # Admin API diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md index df874d1653e..becc3758830 100644 --- a/docs/sources/http_api/auth.md +++ b/docs/sources/http_api/auth.md @@ -1,8 +1,13 @@ ----- -page_title: Authentication API -page_description: Grafana HTTP API Reference -page_keywords: grafana, admin, http, api, documentation ---- ++++ +title = "Authentication HTTP API " +description = "Grafana Authentication HTTP API" +keywords = ["grafana", "http", "documentation", "api", "authentication"] +aliases = ["/http_api/authentication/"] +type = "docs" +[menu.docs] +name = "Authentication" +parent = "http_api" ++++ # Authentication API diff --git a/docs/sources/http_api/dashboard.md b/docs/sources/http_api/dashboard.md index d62a8a967f4..5e9891e0a89 100644 --- a/docs/sources/http_api/dashboard.md +++ b/docs/sources/http_api/dashboard.md @@ -1,8 +1,13 @@ ----- -page_title: Dashboard API -page_description: Grafana Dashboard API Reference -page_keywords: grafana, admin, http, api, documentation, dashboard ---- ++++ +title = "Dashboard HTTP API " +description = "Grafana Dashboard HTTP API" +keywords = ["grafana", "http", "documentation", "api", "dashboard"] +aliases = ["/http_api/dashboard/"] +type = "docs" +[menu.docs] +name = "Dashboard" +parent = "http_api" ++++ # Dashboard API diff --git a/docs/sources/http_api/data_source.md b/docs/sources/http_api/data_source.md index 2a8f79f71f5..9fb1acb4b68 100644 --- a/docs/sources/http_api/data_source.md +++ b/docs/sources/http_api/data_source.md @@ -1,8 +1,14 @@ ----- -page_title: Data source API -page_description: Grafana Data source API Reference -page_keywords: grafana, admin, http, api, documentation, datasource ---- ++++ +title = "Data source HTTP API " +description = "Grafana Data source HTTP API" +keywords = ["grafana", "http", "documentation", "api", "data source"] +aliases = ["/http_api/datasource/"] +type = "docs" +[menu.docs] +name = "Data source" +parent = "http_api" ++++ + # Data source API diff --git a/docs/sources/http_api/org.md b/docs/sources/http_api/org.md index 36188075124..340d97438ae 100644 --- a/docs/sources/http_api/org.md +++ b/docs/sources/http_api/org.md @@ -1,8 +1,14 @@ ----- -page_title: Organisation API -page_description: Grafana Organisation API Reference -page_keywords: grafana, admin, http, api, documentation, orgs, organisation ---- ++++ +title = "Organisation HTTP API " +description = "Grafana Organisation HTTP API" +keywords = ["grafana", "http", "documentation", "api", "organisation"] +aliases = ["/http_api/organisation/"] +type = "docs" +[menu.docs] +name = "Organisation" +parent = "http_api" ++++ + # Organisation API diff --git a/docs/sources/http_api/other.md b/docs/sources/http_api/other.md index 8852b6ccb38..65d18f94ea4 100644 --- a/docs/sources/http_api/other.md +++ b/docs/sources/http_api/other.md @@ -1,8 +1,14 @@ ----- -page_title: Other APIs -page_description: Grafana Other API Reference -page_keywords: grafana, admin, http, api, documentation, dashboards ---- ++++ +title = "Other HTTP API " +description = "Grafana Other HTTP API" +keywords = ["grafana", "http", "documentation", "api", "other"] +aliases = ["/http_api/other/"] +type = "docs" +[menu.docs] +name = "Other" +parent = "http_api" ++++ + # Frontend Settings API diff --git a/docs/sources/http_api/overview.md b/docs/sources/http_api/overview.md index 7f5a3ecfac8..967ed81f392 100644 --- a/docs/sources/http_api/overview.md +++ b/docs/sources/http_api/overview.md @@ -1,15 +1,21 @@ ----- -page_title: HTTP API -page_description: Grafana HTTP API Reference -page_keywords: grafana, admin, http, api, documentation ---- ++++ +title = "HTTP API " +description = "Grafana HTTP API" +keywords = ["grafana", "http", "documentation", "api", "overview"] +aliases = ["/http_api/overview/"] +type = "docs" +[menu.docs] +name = "Overview" +parent = "http_api" ++++ + # HTTP API Reference 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. -###Supported HTTP APIs: +## Supported HTTP APIs: * [Authentication API](/http_api/auth/) * [Dashboard API](/http_api/dashboard/) diff --git a/docs/sources/http_api/preferences.md b/docs/sources/http_api/preferences.md index 6bb00ed8132..a4b953cdaed 100644 --- a/docs/sources/http_api/preferences.md +++ b/docs/sources/http_api/preferences.md @@ -1,8 +1,13 @@ ----- -page_title: Preferences API -page_description: Grafana Preferences API Reference -page_keywords: grafana, preferences, http, api, documentation ---- ++++ +title = "HTTP Preferences API " +description = "Grafana HTTP API" +keywords = ["grafana", "http", "documentation", "api", "preferences"] +aliases = ["/http_api/preferences/"] +type = "docs" +[menu.docs] +name = "Preferences" +parent = "http_api" ++++ # User and Org Preferences API diff --git a/docs/sources/http_api/snapshot.md b/docs/sources/http_api/snapshot.md index 8f18c6ed81f..f0b8304cd24 100644 --- a/docs/sources/http_api/snapshot.md +++ b/docs/sources/http_api/snapshot.md @@ -1,8 +1,13 @@ ----- -page_title: Snapshot API -page_description: Grafana Snapshot API Reference -page_keywords: grafana, admin, http, api, documentation, snapshot, dashboard ---- ++++ +title = "HTTP Snapshot API " +description = "Grafana HTTP API" +keywords = ["grafana", "http", "documentation", "api", "snapshot"] +aliases = ["/http_api/snapshot/"] +type = "docs" +[menu.docs] +name = "Snapshot" +parent = "http_api" ++++ # Snapshot API