Merge pull request #2641 from Dorthu/feature/longview-subscription

Documents Longview Subscription management

Author: Dorthu

docs/src/data/endpoints/account.yaml

@@ -39,7 +39,8 @@ endpoints:
                   "network_helper": true,
                   "phone": "555-555-1212",
                   "state": "PA",
-                  "zip": 19102
+                  "zip": 19102,
+                  "longview_subscription": "longview-10"
                   }
                 }' \
                 https://$api_root/$version/account/settings

docs/src/data/endpoints/longview.yaml

@@ -4,6 +4,7 @@ description: >
   Longview endpoints provide a means of managing Longview client objects on your account.
 endpoints:
   /longview/clients:
+    group: Clients
     authenticated: true
     description: >
       Manage the collection of Longview client objects your account may access.
@@ -37,7 +38,10 @@ endpoints:
                   "label": "newlabel",
                 }' \
                 https://$api_root/$version/longview/clients
+          python: |
+            # coming soon
   /longview/clients/$id:
+    group: Clients
     type: resource
     authenticated: true
     description: >
@@ -64,6 +68,8 @@ endpoints:
                     "label": "awesome_new_label",
                 }' \
                 https://$api_root/$version/longview/clients/$longviewclient_id
+          python: |
+            # coming soon
       DELETE:
         oauth: longviewclients:delete
         dangerous: true
@@ -74,3 +80,39 @@ endpoints:
             curl -H "Authorization: Bearer $TOKEN" \
                 -X DELETE \
                 https://$api_root/$version/longview/clients/$longviewclient_id
+          python: |
+            # coming soon
+  /longview/subscriptions:
+    group: Subscription
+    type: collection
+    authenticated: false
+    description: >
+      View available longview subscriptions.
+    methods:
+      GET:
+        response: LongviewSubscription
+        description: >
+          View a list of available Longview subscription levels.
+        examples:
+          curl: |
+            curl -H "Authorization: Bearer $TOKEN" \
+                 https://$api_root/$version/longview/subscriptions
+          python: |
+            # coming soon
+  /longview/subscriptions/:id:
+    group: Subscription
+    type: resource
+    authenticated: false
+    description: >
+      View information on a single Longview subscription level.
+    methods:
+      GET:
+        response: LongviewSubscription
+        description: >
+          View information on a single Longview subscription level.
+        examples:
+          curl: |
+            curl -H "Authorization: Bearer $TOKEN" \
+                 https://$api_root/$version/longview/subscriptions/longview-10
+          python: |
+            # coming soon

docs/src/data/objects/account.yaml

@@ -43,3 +43,7 @@ schema:
   balance:
     value: 0.00
     type: float
+  longview_subscription:
+    value: null
+    type: string
+    description: The Longview Pro tier you are currently subscribed to.

docs/src/data/objects/longviewsubscription.yaml

@@ -0,0 +1,31 @@
+name: LongviewSubscription
+description: >
+  A Longview Subscription represents one level of consuming the Longview service.
+  Longview's free tier offers limited clients, data retention, and data resolution,
+  and subscribing to a higher tier allows more information to be gathered and
+  stored perpetually.
+schema:
+  id:
+    type: String
+    value: longview-10
+  clients:
+    type: Integer
+    value: 10
+    description: The number of Longview Clients included in this subscription.
+  label:
+    type: String
+    value: Longview Pro 10 pack
+    description: A description of this subscription tier.
+  price:
+    type: Object
+    description: Cost (in US dollars) for this subscription.
+    hourly:
+      type: Float
+      value: 0.06
+      description: Cost (in cents) per hour.
+      filterable: true
+    monthly:
+      type: Integer
+      value: 40
+      description: Cost (in US dollars) per month.
+      filterable: true