WIP swagger-generated API docs

2019-09-27 14:42:01 -06:00 · 2019-09-27 14:42:01 -06:00 · 0b6db10137
parent b66160f501
commit 0b6db10137
5 changed files with 9946 additions and 66 deletions
--- a/api-docs/README.md
+++ b/api-docs/README.md
@ -0,0 +1,7 @@
+## Generate InfluxDB API docs
+
+- Versioned swagger files
+
+```
+npm install -g redoc-cli
+```
--- a/api-docs/template.hbs
+++ b/api-docs/template.hbs
@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf8" />
+  <title>{{title}}</title>
+  <meta name="description" content="The InfluxDB API provides a programmatic interface for interactions with InfluxDB {{templateOptions.version}}.">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="shortcut icon" href="/img/favicon.png" type="image/png" sizes="32x32">
+  <style>
+    body {
+      padding: 0;
+      margin: 0;
+    }
+  </style>
+  {{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Roboto+Mono:500,500i,700,700i|Roboto:400,400i,700,700i|Rubik:400,400i,500,500i,700,700i" rel="stylesheet">{{/unless}}
+  {{{redocHead}}}
+</head>
+
+<body>
+  {{{redocHTML}}}
+</body>
+
+</html>
--- a/api-docs/v2.0/swagger.yml
+++ b/api-docs/v2.0/swagger.yml
--- a/content/v2.0/reference/api/spec.html
+++ b/content/v2.0/reference/api/spec.html
--- a/content/v2.0/reference/api/_index.md
+++ b/content/v2.0/reference/api/_index.md
@ -27,5 +27,3 @@ To view the API documentation, [start InfluxDB](/v2.0/get-started/#start-influxd
 and visit the `/docs` endpoint in a browser.

 <a class="btn" href="http://localhost:9999/docs" target="\_blank">localhost:9999/docs</a>
-
-{{< children >}}