solidus_api_v2 0.2.0

data/docs/source/includes/_option_types.md

@@ -0,0 +1,267 @@
+# Option Types
+
+## List Option Types
+
+```shell
+curl "https://kabuni.com/api/v2/option_types"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_types",
+      "attributes": {
+        "name": "tshirt-size",
+        "presentation": "Size",
+        "position": 1
+      },
+      "relationships": {
+        "option_values": {
+          "data": [
+            {
+              "type": "spree_option_values",
+              "id": "1"
+            }
+          ]
+        },
+        "products": {
+          "data": [
+            {
+              "type": "spree_products",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the option types in the database.
+
+## Show Option Type
+
+```shell
+curl "https://kabuni.com/api/v2/option_types/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_types",
+    "attributes": {
+      "name": "tshirt-size",
+      "presentation": "Size",
+      "position": 1
+    },
+    "relationships": {
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "products": {
+        "data": [
+          {
+            "type": "spree_products",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Fetch an option type in the database.
+
+## List Option Values of a Option Type
+
+```shell
+curl "https://kabuni.com/api/v2/option_types/1/option_values"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_values",
+      "attributes": {
+        "name": "Small",
+        "presentation": "S",
+        "position": 1
+      },
+      "relationships": {
+        "option_type": {
+          "data": {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+See all of the option values that an option type owns.
+
+## Show Option Values of a Option Type
+
+```shell
+curl "https://kabuni.com/api/v2/option_types/1/option_values/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_values",
+    "attributes": {
+      "name": "Small",
+      "presentation": "S",
+      "position": 1
+    },
+    "relationships": {
+      "option_type": {
+        "data": {
+          "type": "spree_option_types",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Fetch an option value that an option type owns.
+
+## List Products of a Option Type
+
+```shell
+curl "https://kabuni.com/api/v2/option_types/1/products"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_products",
+      "attributes": {
+        "name": "Ruby on Rails Tote",
+        "description": "Velit nemo odio ducimus nobis non doloremque beatae sunt. Totam quia voluptatum perferendis tempore sed voluptate consequuntur. Sit id corporis autem veritatis reprehenderit.",
+        "slug": "ruby-on-rails-tote",
+        "meta_description": null,
+        "meta_keywords": null,
+        "store_name": "Whole New Home"
+      },
+      "relationships": {
+        "master": {
+          "data": {
+            "type": "spree_variants",
+            "id": "1"
+          }
+        },
+        "variants": {
+          "data": []
+        },
+        "taxons": {
+          "data": [
+            {
+              "type": "spree_taxons",
+              "id": "1"
+            }
+          ]
+        },
+        "option_types": {
+          "data": [
+            {
+              "type": "spree_option_types",
+              "id": "1"
+            }
+          ]
+        },
+        "images": {
+          "data": [
+            {
+              "type": "spree_images",
+              "id": "1"
+            }
+          ]
+        }
+      }
+    }
+  ]
+}
+```
+
+See all of the products that an option type owns.
+
+## Show Product of a Option Type
+
+```shell
+curl "https://kabuni.com/api/v2/option_types/1/products/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_products",
+    "attributes": {
+      "name": "Ruby on Rails Tote",
+      "description": "Velit nemo odio ducimus nobis non doloremque beatae sunt. Totam quia voluptatum perferendis tempore sed voluptate consequuntur. Sit id corporis autem veritatis reprehenderit.",
+      "slug": "ruby-on-rails-tote",
+      "meta_description": null,
+      "meta_keywords": null,
+      "store_name": "Whole New Home"
+    },
+    "relationships": {
+      "master": {
+        "data": {
+          "type": "spree_variants",
+          "id": "1"
+        }
+      },
+      "variants": {
+        "data": []
+      },
+      "taxons": {
+        "data": [
+          {
+            "type": "spree_taxons",
+            "id": "1"
+          }
+        ]
+      },
+      "option_types": {
+        "data": [
+          {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Find a product that an option type owns.

data/docs/source/includes/_option_values.md

@@ -0,0 +1,227 @@
+# Option Values
+
+## List Option Values
+
+```shell
+curl "https://kabuni.com/api/v2/option_values"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_option_values",
+      "attributes": {
+        "name": "Small",
+        "presentation": "S",
+        "position": 1
+      },
+      "relationships": {
+        "option_type": {
+          "data": {
+            "type": "spree_option_types",
+            "id": "1"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the option values.
+
+## Show Option Value
+
+```shell
+curl "https://kabuni.com/api/v2/option_values/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_values",
+    "attributes": {
+      "name": "Small",
+      "presentation": "S",
+      "position": 1
+    },
+    "relationships": {
+      "option_type": {
+        "data": {
+          "type": "spree_option_types",
+          "id": "1"
+        }
+      }
+    }
+  }
+}
+```
+
+Find an option value by its `id`.
+
+## Show Option Type of an Option Value
+
+```shell
+curl "https://kabuni.com/api/v2/option_values/1/option_type"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_option_types",
+    "attributes": {
+      "name": "tshirt-size",
+      "presentation": "Size",
+      "position": 1
+    },
+    "relationships": {
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "products": {
+        "data": [
+          {
+            "type": "spree_products",
+            "id": "1"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+Find the option type of an option value by the option value's `id`.
+
+## List Variants of an Option Value
+
+```shell
+curl "https://kabuni.com/api/v2/option_values/1/variants"
+```
+
+```json
+{
+  "data": [
+    {
+      "id": "1",
+      "type": "spree_variants",
+      "attributes": {
+        "sku": "ROR-00001",
+        "weight": "0.0",
+        "height": null,
+        "width": null,
+        "depth": null,
+        "is_master": false,
+        "position": 2,
+        "name": "Ruby on Rails Baseball Jersey",
+        "price": "15.99",
+        "display_price": "$15.99 CAD"
+      },
+      "relationships": {
+        "prices": {
+          "data": [
+            {
+              "type": "spree_prices",
+              "id": "33"
+            }
+          ]
+        },
+        "option_values": {
+          "data": [
+            {
+              "type": "spree_option_values",
+              "id": "1"
+            }
+          ]
+        },
+        "images": {
+          "data": [
+            {
+              "type": "spree_images",
+              "id": "1"
+            }
+          ]
+        },
+        "product": {
+          "data": {
+            "type": "spree_products",
+            "id": "3"
+          }
+        }
+      }
+    }
+  ]
+}
+```
+
+List all of the variants that belong to an option value via the option value's `id`.
+
+## Show Variant of an Option Value
+
+```shell
+curl "https://kabuni.com/api/v2/option_values/1/variants/1"
+```
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "spree_variants",
+    "attributes": {
+      "sku": "ROR-00001",
+      "weight": "0.0",
+      "height": null,
+      "width": null,
+      "depth": null,
+      "is_master": false,
+      "position": 2,
+      "name": "Ruby on Rails Baseball Jersey",
+      "price": "15.99",
+      "display_price": "$15.99 CAD"
+    },
+    "relationships": {
+      "prices": {
+        "data": [
+          {
+            "type": "spree_prices",
+            "id": "33"
+          }
+        ]
+      },
+      "option_values": {
+        "data": [
+          {
+            "type": "spree_option_values",
+            "id": "1"
+          }
+        ]
+      },
+      "images": {
+        "data": [
+          {
+            "type": "spree_images",
+            "id": "1"
+          }
+        ]
+      },
+      "product": {
+        "data": {
+          "type": "spree_products",
+          "id": "3"
+        }
+      }
+    }
+  }
+}
+```
+
+Show a variant that belongs to an option value via the option value's `id`.

data/docs/source/includes/_orders.md

@@ -0,0 +1,75 @@
+# Orders
+
+## Show Order
+
+```shell
+curl "https://kabuni.com/api/v2/orders/:id"
+  -d token=abc123
+```
+
+```json
+{
+  "data" : {
+    "attributes" : {
+      "additional_tax_total" : "0.0",
+      "adjustment_total" : "0.0",
+      "approved_at" : null,
+      "canceled_at" : null,
+      "channel" : "spree",
+      "completed_at" : "2015-09-08T04:04:01.162Z",
+      "confirmation_delivered" : false,
+      "considered_risky" : false,
+      "currency" : "CAD",
+      "display_additional_tax_total" : "$0.00 CAD",
+      "display_adjustment_total" : "$0.00 CAD",
+      "display_included_tax_total" : "$0.00 CAD",
+      "display_item_total" : "$10.00 CAD",
+      "display_promo_total" : "$0.00 CAD",
+      "display_shipment_total" : "$100.00 CAD",
+      "display_total" : "$110.00 CAD",
+      "email" : "spree@example.com",
+      "included_tax_total" : "0.0",
+      "item_count" : 0,
+      "item_total" : "10.0",
+      "number" : "#R123456789",
+      "payment_state" : null,
+      "payment_total" : "0.0",
+      "promo_total" : "0.0",
+      "shipment_state" : null,
+      "shipment_total" : "100.0",
+      "special_instructions" : null,
+      "state" : "complete",
+      "store_name" : "Example Store",
+      "total" : "110.0"
+    },
+    "relationships" : {
+      "bill_address" : {
+        "data" : {
+          "type" : "spree_addresses"
+        }
+      },
+      "line_items" : {
+        "data" : [
+          {
+            "type" : "spree_line_items"
+          }
+        ]
+      },
+      "ship_address" : {
+        "data" : {
+          "type" : "spree_addresses"
+        }
+      },
+      "user" : {
+        "data" : {
+          "type" : "spree_users"
+        }
+      }
+    },
+    "type" : "spree_orders"
+  }
+}
+```
+
+This will get an order via the id supplied.
+Please note that you can ony access the orders that you own.

data/docs/source/includes/_pagination.md

@@ -0,0 +1,10 @@
+# Pagination
+
+```shell
+curl "https://kabuni.com/api/v2/kitten?page[number]2&page[size]=20"
+```
+
+This projects supports the [JSON API's `page` keyword](http://jsonapi.org/format/#fetching-pagination).
+To specify the page number, set a `page[number]` value.
+To specify the page size (the amount of records returned), set a `page[size]` value; the default is 24.
+If you would like the links to the `self`, `next`, `prev`, `first`, and `last` it is not yet supported.