Merge pull request #2644 from RobertDeRose/feature/image-endpoints

Added initial set of Image endpoint Docs

Author: Dorthu

docs/prebuild.js

@@ -359,6 +359,12 @@ const endpointMap = {
     routePath: `${ROUTE_BASE_PATH}/profile`,
     groups: {},
   },
+  images: {
+    name: 'Images',
+    path: '/images',
+    routePath: `${ROUTE_BASE_PATH}/images`,
+    groups: {},
+  },
 };
 
 allEndpoints.forEach(function (endpointContainer) {

docs/src/data/endpoints/images.yaml

@@ -0,0 +1,65 @@
+name: Images
+description: >
+  Image endpoints provide a means of managing the images associated with a
+  user's account.
+endpoints:
+  /images:
+    authenticated: true
+    description: |
+      Image collection endpoints
+    methods:
+      GET:
+        response: image
+        oauth: 'images:view'
+        description: |
+          Returns a list of images.
+        examples:
+          curl: |
+            curl https://$api_root/$version/images
+          python: |
+            import linode
+            TODO
+  /images/$id:
+    type: resource
+    description: |
+      Image manipulation endpoints
+    methods:
+      GET:
+        oauth: 'images:view'
+        response: image
+        description: |
+          Returns a specific image resource
+        examples:
+          curl: |
+            curl https://$api_root/$version/images/$image_id
+          python: |
+            import linode
+            TODO
+      PUT:
+        oauth: 'images:modify'
+        description: |
+          Modifies a given image
+        examples:
+          curl: |
+            curl -H "Content-Type: application/json" \
+              -H "Authorization: Bearer TOKEN" \
+              -X PUT -d '{
+                "label": "a_new_label",
+                "description": "A new description"
+              }'
+              https://$api_root/$version/images/$image_id
+          python: |
+            import linode
+            TODO
+      DELETE:
+        oauth: 'images:delete'
+        description: |
+          Deletes a given image
+        examples:
+          curl: |
+            curl -H "Authorization: Bearer $TOKEN" \
+                -X DELETE
+                https://$api_root/$version/images/$image_id
+          python: |
+            import linode
+            TODO

docs/src/data/objects/image.yaml

@@ -0,0 +1,53 @@
+name: Image
+description: >
+  Image objects describe an image that was made based off a device on a Linode
+schema:
+  id:
+    type: Integer
+    value: 12345
+    description: The ID of this image
+  label:
+    type: String
+    value: ubuntu_17.4_with_rails_5
+    description: |
+      A short description of the image with a max of 200 characters. Labels
+      cannot contain special characters.
+    filterable: true
+    editable: true
+  description:
+    type: String
+    value: Ubuntu 17.4 with Ruby on Rails 5
+    description: |
+      A detailed description of this image with a max of 65000 characters.
+    editable: true
+  status:
+    type: Enum
+    subtype: Status
+    value: available
+    description: The status of the image.
+  filesystem:
+    type: String
+    value: ext4
+    description: The filesystem type of the image.
+  created:
+    type: string
+    value: "2015-09-29T11:21:01"
+    description: When the image was created.
+  updated:
+    type: string
+    value: "2015-09-29T11:21:01"
+    description: The last time the image was modified.
+  type:
+    type: Enum
+    subtype: Type
+    value: automatic
+    description: How the image was created.
+  is_public:
+    type: Boolean
+    value: true
+    filterable: true
+    description: True if the image is public.
+  last_used:
+    type: string
+    value: "2015-09-29T11:21:01"
+    description: The last time this image was used.