README.rdoc in sk_api_schema-0.3.2 vs README.rdoc in sk_api_schema-0.3.3
- old
+ new
@@ -1,14 +1,13 @@
= SalesKing API Schema
-Our API is described with JSON Schema's (http://json-schema.org). A schema
-describes a resource(object) in a readable JSON format:
+Our API is described with JSON Schema's (http://json-schema.org), describing our objects(resources) in a readable JSON format:
- {
+ {
"title": "client",
"properties": { ...},
- "links": [ .. ]
+ "links": [ .. ]
}
The properties-section defines the fields. CRUD actions and
relationships with other resources are found in the link-section.
Look into the /json/ folder for the resources schema-files - https://github.com/salesking/sk_api_schema/tree/master/json/v1.0
@@ -36,12 +35,12 @@
The schema main version(NOT the gem version) can be set with the "v" url parameter
in any call, but is pretty useless as long as we are in v1.0
my.salesking.eu/api/clients?v='1.0'
-The gem has its own version number. A new gem version indicates a change, but
-we first try it on our staging environment before any live instances are
+The gem has its own version number. A new gem version indicates a change, but
+we first try it on our staging environment before any live instances are
updated and the schema becomes public available. The gem is used by SalesKing
to deliver it's data BUT changes might not be directly reflected as stated.
To see the current gem version use:
my.salesking.eu/api/schema?gem_version=1
@@ -55,11 +54,11 @@
my.salesking.eu/api/clients?fields[]=id&fields[]=organisation
Please try to only request the fields you really need, to save computing power!
-== Object Structure Basic's
+== Object Basic's
Primary object types in SK are:
* Documents
* Contacts
* Products
@@ -74,11 +73,11 @@
* Company
* Users
* Exports
* Templates
-== Enpoints & Links
+== Endpoints & Links
Following list gives you a quick overview of relations with nested urls an how
parameters work. You can find those in detail when looking at the link section
of each schema.
@@ -98,24 +97,26 @@
/clients/:id/documents
# all invoices of a client
/clients/:id/invoices
-
-== ToDo:
-
-Those relative urls in the link sections, need some love, so please don't rely on
-them to much right now.
-
== Install
gem install sk_api_schema
== Test
-Before you run the tests use bundler to install all required gems:
+{<img src="https://secure.travis-ci.org/salesking/sk_api_schema.png?branch=master" alt="Build Status" />}[http://travis-ci.org/salesking/sk_api_schema]
+
+Install required gems with bundler and go for it:
# git clone
# cd into sk_api_schema dir
- BUNDLE_GEMFILE=ci/Gemfile bundle install
- BUNDLE_GEMFILE=ci/Gemfile bundle exec rake spec
+ bundle install
+ rake spec
-Copyright (c) 2010-2011 Georg Leciejewski, released under the MIT license
+
+== ToDo:
+
+Those relative urls in the link sections, need some love, so please don't rely on
+them to much right now.
+
+Copyright (c) 2010-2012 Georg Leciejewski, released under the MIT license