Merge pull request #2634 from yoshizzle/longview

Longview

Author: Dorthu

docs/prebuild.js

@@ -317,6 +317,12 @@ const endpointMap = {
     routePath: `${ROUTE_BASE_PATH}/domains`,
     groups: {},
   },
+  longview: {
+    name: 'Longview',
+    path: '/longview',
+    routePath: `${ROUTE_BASE_PATH}/longview`,
+    groups: {},
+  },
   nodebalancers: {
     name: 'NodeBalancers',
     path: '/nodebalancers',

docs/src/data/endpoints/longview.yaml

@@ -0,0 +1,35 @@
+# vim: set et ts=2 sw=2 tw=80 :
+name: Longview
+description: >
+  Longview endpoints provide a means of managing Longview client objects on your account.
+endpoints:
+  /longview/clients:
+    authenticated: true
+    description: >
+      Manage the collection of Longview client objects your account may access.
+    methods:
+      GET:
+        response: longviewclient
+        paginationKey: longviewclients
+        oauth: longviewclients:view
+        description: >
+          Returns a list of Longview clients.
+        examples:
+          curl: |
+            curl -H "Authorization: Bearer $TOKEN" \
+                https://$api_root/$version/longview/clients
+  /longview/clients/$id:
+    type: resource
+    authenticated: true
+    description: >
+      Manage a particular Longview client your account may access.
+    methods:
+      GET:
+        response: longviewclient
+        oauth: longviewclients:view
+        description: >
+          Returns information about this Longview client.
+        examples:
+          curl: |
+            curl -H "Authorization: Bearer $TOKEN" \
+                https://$api_root/$version/longview/clients/$longviewclient_id

docs/src/data/objects/longviewclient.yaml

@@ -0,0 +1,46 @@
+# vim: set et ts=2 sw=2 tw=80 :
+name: LongviewClient
+description: >
+  Longview objects describe a single Longview client on your account.
+schema:
+  id:
+    type: Integer
+    value: 123456
+    description: An integer.
+  label:
+    editable: true
+    type: String
+    value: 'longview12345'
+    description: The Longview client's display label. Must be 3-32 ASCII characters limited to letters, numbers, underscores, and dashes, starting and ending with a letter, and without two dashes or underscores in a row.
+  api_key:
+    editable: false
+    type: String
+    value: 'D09E9730-CF01-E0AB-7763FBAFD4000000'
+    description: The api key required to install the Longview Agent on a Linode.
+  apps:
+    type: Object
+    description: >
+      A collection of applications the Longview client is configured to monitor. Currently reports on nginx, apache, and mysql
+    nginx:
+      type: Boolean
+      value: true
+      description: Whether or not nginx is monitored by the Longview client.
+    apache:
+      type: Boolean
+      value: false
+      description: Whether or not apache is monitored by the Longview client.
+    mysql:
+      type: Boolean
+      value: true
+      description: Whether or not mysql is monitored by the Longview client.
+  created:
+    editable: false
+    type: String
+    value: '2017-10-01T14:00:00'
+    description: The date the Longview client was created.
+  updated:
+    editable: false
+    type: String
+    value: '2017-10-01T14:02:33'
+    description: The date the Longview client was updated.
+