sk_api_schema 0.6.0 → 0.6.1

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGELOG.md CHANGED
@@ -3,6 +3,9 @@
3
3
  A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
4
4
 
5
5
  2013-01
6
+ * add external_ref for line item
7
+ * email "send" parameter can be set to false or 0 to prevent sending
8
+ * email "from_addr" is not required
6
9
  * add new item types: devider_item, sub_total_item
7
10
  * add items for documents containing all items by type
8
11
  * add filter\[tags] to products, mark price as required
data/README.rdoc CHANGED
@@ -6,7 +6,7 @@ Our API (objects,resources) is described with JSON Schema (http://json-schema.or
6
6
  Each Object has its own description, with those top-level keys:
7
7
 
8
8
  {
9
- "title": "client", // object type
9
+ "name": "client", // object type
10
10
  "properties": { .. }, // field descriptions
11
11
  "links": [ .. ] // CRUD actions, relationships to other resources
12
12
  }
data/json/v1.0/email.json CHANGED
@@ -22,8 +22,7 @@
22
22
  "format":"text"
23
23
  },
24
24
  "from_addr":{
25
- "description": "From address",
26
- "required":true,
25
+ "description": "From address. If empty the email of the current user is taken.",
27
26
  "type":"string",
28
27
  "maxLength": 255
29
28
  },
@@ -176,7 +175,7 @@
176
175
  },
177
176
  "send":{
178
177
  "title" : "Send email",
179
- "description": "If present(any val) email is scheduled for sending."
178
+ "description": "Schedule email for sending. Omit this parameter or set value to 0 or false(String or Integer) to keep email as draft."
180
179
  },
181
180
  "archived_pdf":{
182
181
  "title" : "Attach archived pdf",
@@ -120,7 +120,7 @@
120
120
  "properties":{"$ref":"./line_item.json#properties"}
121
121
  },
122
122
  "items":{
123
- "description": "Items for the document. Access items of all types including divider and sub_total items.",
123
+ "description": "Items for the document. Access items of all types including divider and sub_total items. Item creation is currently only supported through line_items array.",
124
124
  "type":"array",
125
125
  "default": "any",
126
126
  "minItems": 0,
@@ -21,6 +21,11 @@
21
21
  "type":"string",
22
22
  "maxLength": 50
23
23
  },
24
+ "external_ref":{
25
+ "description": "Arbitrary number e.g. external product reference.",
26
+ "type":"string",
27
+ "maxLength": 255
28
+ },
24
29
  "description":{
25
30
  "description": "Item description",
26
31
  "type":"string",
@@ -1,7 +1,7 @@
1
1
  module SK
2
2
  module Api
3
3
  class Schema
4
- VERSION='0.6.0'
4
+ VERSION='0.6.1'
5
5
  end
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,107 +1,105 @@
1
- --- !ruby/object:Gem::Specification
1
+ --- !ruby/object:Gem::Specification
2
2
  name: sk_api_schema
3
- version: !ruby/object:Gem::Version
4
- version: 0.6.0
3
+ version: !ruby/object:Gem::Version
4
+ hash: 5
5
5
  prerelease:
6
+ segments:
7
+ - 0
8
+ - 6
9
+ - 1
10
+ version: 0.6.1
6
11
  platform: ruby
7
- authors:
12
+ authors:
8
13
  - Georg Leciejewski
9
14
  autorequire:
10
15
  bindir: bin
11
16
  cert_chain: []
12
- date: 2012-07-27 00:00:00.000000000 Z
13
- dependencies:
14
- - !ruby/object:Gem::Dependency
15
- name: activesupport
16
- requirement: !ruby/object:Gem::Requirement
17
- none: false
18
- requirements:
19
- - - ! '>='
20
- - !ruby/object:Gem::Version
21
- version: '0'
17
+
18
+ date: 2012-07-27 00:00:00 Z
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
22
21
  type: :runtime
22
+ requirement: &id001 !ruby/object:Gem::Requirement
23
+ none: false
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ hash: 3
28
+ segments:
29
+ - 0
30
+ version: "0"
31
+ version_requirements: *id001
23
32
  prerelease: false
24
- version_requirements: !ruby/object:Gem::Requirement
33
+ name: activesupport
34
+ - !ruby/object:Gem::Dependency
35
+ type: :development
36
+ requirement: &id002 !ruby/object:Gem::Requirement
25
37
  none: false
26
- requirements:
27
- - - ! '>='
28
- - !ruby/object:Gem::Version
29
- version: '0'
30
- - !ruby/object:Gem::Dependency
38
+ requirements:
39
+ - - ">="
40
+ - !ruby/object:Gem::Version
41
+ hash: 3
42
+ segments:
43
+ - 0
44
+ version: "0"
45
+ version_requirements: *id002
46
+ prerelease: false
31
47
  name: rdoc
32
- requirement: !ruby/object:Gem::Requirement
33
- none: false
34
- requirements:
35
- - - ! '>='
36
- - !ruby/object:Gem::Version
37
- version: '0'
48
+ - !ruby/object:Gem::Dependency
38
49
  type: :development
39
- prerelease: false
40
- version_requirements: !ruby/object:Gem::Requirement
50
+ requirement: &id003 !ruby/object:Gem::Requirement
41
51
  none: false
42
- requirements:
43
- - - ! '>='
44
- - !ruby/object:Gem::Version
45
- version: '0'
46
- - !ruby/object:Gem::Dependency
52
+ requirements:
53
+ - - ">="
54
+ - !ruby/object:Gem::Version
55
+ hash: 3
56
+ segments:
57
+ - 0
58
+ version: "0"
59
+ version_requirements: *id003
60
+ prerelease: false
47
61
  name: rspec
48
- requirement: !ruby/object:Gem::Requirement
49
- none: false
50
- requirements:
51
- - - ! '>='
52
- - !ruby/object:Gem::Version
53
- version: '0'
62
+ - !ruby/object:Gem::Dependency
54
63
  type: :development
55
- prerelease: false
56
- version_requirements: !ruby/object:Gem::Requirement
64
+ requirement: &id004 !ruby/object:Gem::Requirement
57
65
  none: false
58
- requirements:
59
- - - ! '>='
60
- - !ruby/object:Gem::Version
61
- version: '0'
62
- - !ruby/object:Gem::Dependency
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ hash: 3
70
+ segments:
71
+ - 0
72
+ version: "0"
73
+ version_requirements: *id004
74
+ prerelease: false
63
75
  name: simplecov
64
- requirement: !ruby/object:Gem::Requirement
65
- none: false
66
- requirements:
67
- - - ! '>='
68
- - !ruby/object:Gem::Version
69
- version: '0'
76
+ - !ruby/object:Gem::Dependency
70
77
  type: :development
71
- prerelease: false
72
- version_requirements: !ruby/object:Gem::Requirement
78
+ requirement: &id005 !ruby/object:Gem::Requirement
73
79
  none: false
74
- requirements:
75
- - - ! '>='
76
- - !ruby/object:Gem::Version
77
- version: '0'
78
- - !ruby/object:Gem::Dependency
79
- name: rake
80
- requirement: !ruby/object:Gem::Requirement
81
- none: false
82
- requirements:
83
- - - ! '>='
84
- - !ruby/object:Gem::Version
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ hash: 63
84
+ segments:
85
+ - 0
86
+ - 9
87
+ - 2
85
88
  version: 0.9.2
86
- type: :development
89
+ version_requirements: *id005
87
90
  prerelease: false
88
- version_requirements: !ruby/object:Gem::Requirement
89
- none: false
90
- requirements:
91
- - - ! '>='
92
- - !ruby/object:Gem::Version
93
- version: 0.9.2
94
- description: ! 'The SalesKing JSON Schema describes our business API in terms of available
95
- objects, their fields and links to url endpoints with related objects.
96
-
97
- Besides ruby users can use a small lib with utility methods to load and test the
98
- schema files.'
91
+ name: rake
92
+ description: |-
93
+ The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects.
94
+ Besides ruby users can use a small lib with utility methods to load and test the schema files.
99
95
  email: gl@salesking.eu
100
96
  executables: []
97
+
101
98
  extensions: []
102
- extra_rdoc_files:
99
+
100
+ extra_rdoc_files:
103
101
  - README.rdoc
104
- files:
102
+ files:
105
103
  - .gitignore
106
104
  - .travis.yml
107
105
  - CHANGELOG.md
@@ -143,29 +141,36 @@ files:
143
141
  - spec/spec_helper.rb
144
142
  homepage: http://github.com/salesking/sk_api_schema
145
143
  licenses: []
144
+
146
145
  post_install_message:
147
146
  rdoc_options: []
148
- require_paths:
147
+
148
+ require_paths:
149
149
  - lib
150
- required_ruby_version: !ruby/object:Gem::Requirement
150
+ required_ruby_version: !ruby/object:Gem::Requirement
151
151
  none: false
152
- requirements:
153
- - - ! '>='
154
- - !ruby/object:Gem::Version
155
- version: '0'
156
- segments:
152
+ requirements:
153
+ - - ">="
154
+ - !ruby/object:Gem::Version
155
+ hash: 3
156
+ segments:
157
157
  - 0
158
- hash: -3277987017950227307
159
- required_rubygems_version: !ruby/object:Gem::Requirement
158
+ version: "0"
159
+ required_rubygems_version: !ruby/object:Gem::Requirement
160
160
  none: false
161
- requirements:
162
- - - ! '>='
163
- - !ruby/object:Gem::Version
164
- version: '0'
161
+ requirements:
162
+ - - ">="
163
+ - !ruby/object:Gem::Version
164
+ hash: 3
165
+ segments:
166
+ - 0
167
+ version: "0"
165
168
  requirements: []
169
+
166
170
  rubyforge_project:
167
171
  rubygems_version: 1.8.24
168
172
  signing_key:
169
173
  specification_version: 3
170
174
  summary: SalesKing API - JSON Schema
171
175
  test_files: []
176
+