sk_api_schema 0.0.11 → 0.0.12

data/README.rdoc

@@ -7,22 +7,35 @@ 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.
 
-== TODO
+== Tutorial & Docs
 
-The urls in the link sections, need some love, so please don't rely on them right now
+http://dev.blog.salesking.eu/api/
 
-== Notice:
+== Versioning
+
+The API-version, is kept in the folder-name and as long as there are no major
+changes(breaking backwards compatibility), the version number will remain.
+
+The gem has its own version, not reflecting the api version. It is used in
+SalesKing to deliver it's resources BUT changes might not be directly reflected.
+A new gem version indicates a change, but we first try it on our staging environment
+before any live instances are updated.
+
+You can get the current schema at your SalesKing api url:
+  my.salesking.eu/api/schema
+  my.salesking.eu/api/clients/schema
 
-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 version to use can be set with the "v" url parameter:
+  my.salesking.eu/api/clients?v='1.0'
+
+
+== Notice:
 
-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.
+Those relative urls in the link sections, need some love, so please don't rely on
+them to much right now.
 
 Especially within the next couple of weeks (until beginning of march) you will
-see some more resources made available. Links within each resource, will
-also be available but still need some cleanup.
+see bugfixes since more resources where made available.
 
 == Install
 

data/VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

data/json/v1.0/client.json

@@ -12,7 +12,7 @@
       "type":"string"
     },
     "organisation": {
-      "description": "Name of a company. At least this or the lastname field must be filled for new records",
+      "description": "Name of a company. This or lastname must be present",
       "required" : true,
       "type":"string"
     },
@@ -58,7 +58,7 @@
       "type":"string"
     },
     "tag_list": {
-      "description": "Space seperated list of tags.",
+      "description": "Space separated list of tags.",
       "type":"string"
     },   
     "created_at": {
@@ -79,11 +79,15 @@
       "type":"string"
     },
     "bank_name": {
-      "description": "Name of the bank.",
+      "description": "Bank name",
+      "type":"string"
+    },
+    "bank_number": {
+      "description": "Bank number",
       "type":"string"
     },
     "bank_account_number": {
-      "description": "Number of the bank account.",
+      "description": "Bank account number.",
       "type":"string"
     },
     "bank_iban": {
@@ -95,7 +99,7 @@
       "type":"string"
     },
     "bank_owner": {
-      "description": "Owner of the bank account.",
+      "description": "Bank account owner",
       "type":"string"
     },
     "phone_fax": {
@@ -107,7 +111,7 @@
       "type":"string"
     },
     "phone_home": {
-      "description": "Private phone number.",
+      "description": "Private phone number",
       "type":"string"
     },
     "phone_mobile": {

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.11"
+  s.version = "0.0.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-01-25}
+  s.date = %q{2011-01-29}
   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: 9
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 +01:00
+date: 2011-01-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency