Browse Source

docs(http_api): convert to new docs format

bergquist 9 years ago
parent
commit
6081c6cb61

+ 10 - 5
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
 # Admin API
 
 

+ 10 - 5
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
 # Authentication API
 
 

+ 10 - 5
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
 # Dashboard API
 
 

+ 11 - 5
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
 # Data source API
 
 

+ 11 - 5
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
 # Organisation API
 
 

+ 11 - 5
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
 # Frontend Settings API
 
 

+ 12 - 6
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
 # 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/)

+ 10 - 5
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
 # User and Org Preferences API
 
 

+ 10 - 5
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
 # Snapshot API