Merge pull request #2567 from yoshizzle/api45Docs

Added invoices, payments, envelopes...

Author: Dorthu

docs/src/data/endpoints/account.yaml

@@ -576,3 +576,87 @@ endpoints:
             curl https://$api_root/$version/account/event/123/read
           python: |
             event.mark_read()
+  /account/invoices:
+    group: Invoices
+    authenticated: true
+    description: >
+      View the collection of invoices.
+    methods:
+      GET:
+        response: invoice
+        paginationKey: invoice
+        description: >
+          Returns a list of invoices.
+        examples:
+          curl: |
+            curl https://$api_root/$version/account/invoices
+  /account/invoices/:id:
+    group: Invoices
+    type: resource
+    authenticated: true
+    description: >
+      Returns information about a specific invoice.
+    methods:
+      GET:
+        response: invoices
+        description: >
+          Returns information about this invoice.
+        examples:
+          curl: |
+            curl https://$api_root/$version/account/invoices/123
+  /account/invoices/:id/items:
+    group: Invoices
+    type: resource
+    authenticated: true
+    description: >
+      View the items associated with a specific invoice.
+    methods:
+      GET:
+        response: invoice_items
+        description: >
+          Returns a collection of invoice items.
+        examples:
+          curl: |
+            curl https://$api_root/$version/account/invoices/123/items
+  /account/payments:
+    group: Payments
+    type: Resource
+    authenticated: true
+    description: >
+      View the collection of payments.
+    methods:
+      GET:
+        response: payment
+        description: >
+          Returns information about this payment.
+        examples:
+          curl: |
+            curl https://$api_root/$version/account/payments
+      POST:
+        oauth: account:modify
+        response: payment
+        description: >
+          Make a payment.
+        examples:
+          curl: |
+            curl -H "Content-Type: application/json" \
+                -H "Authorization: Bearer $TOKEN" \
+                -X POST -d '{
+                    "usd": 100,
+                }' \
+                https://$api_root/$version/account/payments
+  /account/payments/:id:
+    group: Payments
+    type: Resource
+    authenticated: true
+    description: >
+      Returns information about a specific payment.
+    methods:
+      GET:
+        response: payment
+        description: >
+          Returns information about this payment.
+        examples:
+          curl: |
+            curl https://$api_root/$version/account/payments/123
+

docs/src/data/objects/invoice.yaml

@@ -0,0 +1,35 @@
+name: Invoice
+prefix: invoice
+description: >
+    An Invoice
+schema:
+  date:
+    type: String
+    value: "2015-09-29T11:21:01"
+    filterable: true
+    description: The date the invoice was generated.
+  overdue:
+    type: Boolean
+    value: false
+    filterable: true
+    description: Whether or not the invoice is overdue for payment.
+  paid:
+    type: Boolean
+    value: true
+    filterable: true
+    description: Whether or not the invoice has been paid.
+  id:
+    type: integer
+    value: 123
+    description: The invoice's ID.
+  total:
+    type: integer
+    value: 120
+    filterable: true
+    description: The amount of the invoice in U.S. Dollars.
+  label:
+    type: string
+    value: Invoice #1
+    filterable: true
+    editable: true
+    description: The invoice's display label.

docs/src/data/objects/invoice_item.yaml

@@ -0,0 +1,41 @@
+name: InvoiceItems
+prefix: invoiceitems
+description: >
+    An individual item from an Invoice
+schema:
+  to:
+    type: String
+    value: "2015-09-01T00:00:01"
+    description: The date the invoice item started, based on month.
+  from:
+    type: String
+    value: "2015-09-30T11:59:59:59"
+    description: The date the invoice item ended, based on month.
+  type:
+    type: Enum
+    subtype: Type
+    value: prepay
+    description: The type of service, either 'prepay' or 'misc'
+  amount:
+    type: integer
+    value: 20
+    description: The price, in U.S. Dollars, of unitprice multiplied by quantity.
+  unitprice:
+    type: integer
+    value: 10
+    description: The monthly service fee (in US Dollars) for this item.
+  label:
+    type: string
+    value: Linode 123
+    description: This invoice item's display label.
+    filterable: true
+    editable: true
+  quantity:
+    type: integer
+    value: 1
+    description: The quantity of this item for the specified invoice.
+enums:
+  Type:
+    prepay: The invoice was pre-paid.
+    misc: The invoice was not pre-paid.
+

docs/src/data/objects/kernel.yaml

@@ -11,10 +11,6 @@ schema:
   id:
     type: String
     value: linode/3.5.2-x86_64-linode26
-  description:
-    type: String
-    value: "null"
-    description: Additional, descriptive text about the kernel.
   xen:
     type: Boolean
     value: false
@@ -41,17 +37,11 @@ schema:
     value: x86_64
     description: The architecture of this kernel.
     filterable: true
-  current:
-    type: Boolean
-    value: true
-    filterable: true
-  deprecated:
+  pvops:
     type: Boolean
     value: false
+    description: If this kernel is suitable for paravirtualized operations.
     filterable: true
-  latest:
-    type: Boolean
-    value: true
 enums:
   architecture:
       x86_64: a 64 bit distribution

docs/src/data/objects/linode.yaml

@@ -26,18 +26,21 @@ schema:
       type: Integer
       value: 10000
       description: Disk IO Rate ops/sec (Range 0-100000, default 10000). 0 to disable.
-    transfer_in:
-      type: Integer
-      value: 0
-      description: Incoming Traffic Mbit/s (Range 0-40000, default 10). 0 to disable.
-    transfer_out:
-      type: Integer
-      value: 10
-      description: Outbound Traffic Mbit/s (Range 0-10000, default 10). 0 to disable.
-    transfer_quota:
-      type: Integer
-      value: 80
-      description: Transfer Quota % (Range 0-400, default 80). 0 to disable.
+    transfer:
+      type: Object
+      description: Thresholds for sending email alerts.
+      in:
+        type: Integer
+        value: 0
+        description: Incoming Traffic Mbit/s (Range 0-40000, default 10). 0 to disable.
+      out:
+        type: Integer
+        value: 10
+        description: Outbound Traffic Mbit/s (Range 0-10000, default 10). 0 to disable.
+      quota:
+        type: Integer
+        value: 80
+        description: Transfer Quota % (Range 0-400, default 80). 0 to disable.
   backups:
     type: Object
     seeAlso: "/reference/endpoints/linode/instances/$id/backups"
@@ -114,10 +117,6 @@ schema:
     value: running
     filterable: true
     _pylib_volatile: true
-  transfer_total:
-    type: Integer
-    description: The amount of outbound traffic used this month.
-    value: 20000
   updated:
     type: Datetime
     value: 2015-10-27T09:59:26
@@ -128,11 +127,26 @@ schema:
     subtype: Hypervisor
     description: The hypervisor this Linode is running on.
     value: kvm
-  disk:
-    type: Integer
-    value: 24576
-    description: Available disk space, in MB
-    filterable: false
+  specs:
+    type: Object
+    description: Specifications for this Linode.
+    disk:
+      type: Integer
+      value: 24576
+      description: Available disk space, in MB
+      filterable: false
+    memory:
+      type: Integer
+      value: 1024
+      description: Total RAM for this Linode.
+    vcpus:
+      type: Integer
+      value: 1
+      description: Number of VCPUs for this Linode.
+    transfer:
+      type: Integer
+      description: The amount of outbound traffic used this month.
+      value: 20000
 enums:
   Status:
     offline: The Linode is powered off.

docs/src/data/objects/linode_config.yaml

@@ -87,11 +87,6 @@ schema:
     type: String
     value: "/dev/sda"
     description: Root device to boot. Corresponding disk must be attached.
-  root_device_ro:
-    editable: true
-    type: Boolean
-    value: false
-    description: Controls whether to mount the root disk read-only.
   run_level:
     editable: true
     type: Enum

docs/src/data/objects/payment.yaml

@@ -0,0 +1,19 @@
+name: Payment
+prefix: payment
+description: >
+    A Payment
+schema:
+  date:
+    type: String
+    value: "2015-09-29T11:21:01"
+    filterable: true
+    description: The date the payment was processed.
+  id:
+    type: integer
+    value: 123
+    description: The payment's ID.
+  amount:
+    type: integer
+    value: 120
+    filterable: true
+    description: The amount (in US Dollars) of the payment.

docs/src/data/objects/type.yaml

@@ -16,39 +16,45 @@ schema:
   class:
     type: Enum
     subtype: Class
-  price_hourly:
-    type: Float
-    value: 1.44
-    description: Cost (in cents) per hour.
-    filterable: true
-  label:
-    type: String
-    value: Linode 2048
-    description: Human-friendly name of this type.
-    filterable: true
-  backups_option:
+  price:
     type: Object
-    description: Cost of enabling backups for this type.
-    price_hourly:
+    description: Cost (in US dollars) for this type.
+    hourly:
       type: Float
-      value: 0.004
+      value: 1.44
       description: Cost (in cents) per hour.
       filterable: true
-    price_monthly:
+    monthly:
       type: Integer
-      value: 2.5
+      value: 1000
       description: Cost (in US dollars) per month.
       filterable: true
+  label:
+    type: String
+    value: Linode 2048
+    description: Human-friendly name of this type.
+    filterable: true
+  addons:
+    type: Object
+    description: Cost of enabling addon services for this type.
+    price:
+      type: Object
+      description: Cost of enabling backups for this type.
+      hourly:
+        type: Float
+        value: 0.004
+        description: Cost (in cents) per hour.
+        filterable: true
+      monthly:
+        type: Integer
+        value: 2.5
+        description: Cost (in US dollars) per month.
+        filterable: true
   network_out:
     type: Integer
     value: 125
     description: If applicable, Mbits outbound bandwidth.
     filterable: true
-  price_monthly:
-    type: Integer
-    value: 1000
-    description: Cost (in US dollars) per month.
-    filterable: true
   memory:
     type: Integer
     value: 2048