sk_api_schema 0.0.10 → 0.0.11

data/README.rdoc

@@ -1,17 +1,21 @@
 = SalesKing Api Schema
 
-SalesKing API description using JSON Schema(http://json-schema.org/)
+SalesKing API description using JSON Schema(http://json-schema.org/). A schema
+describes the resource in terms of available fields, CRUD actions and
+relationships with other resources.
 
 For ruby users this project provides a gem with some basic utility functions
 besides the schema. Other languages can take advantage of the raw json files.
 
-To get a fully working ruby client take a look at http://github.com/salesking/sk-api
-which will be replaced soon by a new gem at http://github.com/salesking/sk_api_activeresource
+== TODO
+
+The urls in the link sections, need some love, so please don't rely on them right now
 
 == Notice:
 
 This gem is used actively by SalesKing to deliver it's api resources BUT commits
 and changes in here might not be directly reflected.
+
 The gem version does not reflect the api version. The version, for now, is keept
 in the folder-name and as long as there are no major changes(breaking backwards
 compatibility), the version number will remain.

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/json/v1.0/product.json

@@ -48,6 +48,53 @@
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
       "type":"string"
+    },
+    "lock_version": {
+      "description": "Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.",
+      "type":"integer"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "products/{id}"
+    },
+    { "rel": "instances",
+      "href": "products",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Searches in number, name, description, price",
+          "type":"string"
+        },        
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['name','number','price', 'created_at', 'updated_at'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "products/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "products/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "products",
+      "method": "POST"
     }
-  }
+  ]
 }

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-01-24}
+  s.date = %q{2011-01-25}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-24 00:00:00 +01:00
+date: 2011-01-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency