raml_ruby 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.travis.yml +2 -0
- data/README.md +1 -9
- data/Rakefile +7 -0
- data/lib/raml.rb +6 -26
- data/lib/raml/exceptions.rb +1 -0
- data/lib/raml/mixin/bodies.rb +3 -3
- data/lib/raml/mixin/documentable.rb +3 -8
- data/lib/raml/mixin/global.rb +14 -10
- data/lib/raml/mixin/headers.rb +1 -1
- data/lib/raml/mixin/merge.rb +4 -4
- data/lib/raml/mixin/secured_by.rb +27 -0
- data/lib/raml/mixin/validation.rb +27 -27
- data/lib/raml/node.rb +22 -80
- data/lib/raml/node/abstract_method.rb +7 -7
- data/lib/raml/node/abstract_resource.rb +17 -7
- data/lib/raml/node/body.rb +12 -10
- data/lib/raml/node/documentation.rb +0 -8
- data/lib/raml/node/method.rb +5 -7
- data/lib/raml/node/parameter/abstract_parameter.rb +22 -24
- data/lib/raml/node/parametized_reference.rb +3 -3
- data/lib/raml/node/resource.rb +0 -2
- data/lib/raml/node/resource_type.rb +9 -9
- data/lib/raml/node/resource_type_reference.rb +2 -2
- data/lib/raml/node/response.rb +0 -2
- data/lib/raml/node/root.rb +66 -57
- data/lib/raml/node/schema.rb +3 -9
- data/lib/raml/node/schema_reference.rb +2 -2
- data/lib/raml/node/security_scheme.rb +47 -0
- data/lib/raml/node/security_scheme_reference.rb +5 -0
- data/lib/raml/node/trait.rb +8 -8
- data/lib/raml/node/trait_reference.rb +2 -2
- data/lib/raml/parser.rb +25 -16
- data/lib/raml/version.rb +1 -1
- data/raml_ruby.gemspec +3 -7
- data/test/apis/box-api.raml +1447 -1447
- data/test/apis/instagram-api.raml +48 -48
- data/test/apis/stripe-api.raml +4266 -4266
- data/test/apis/twilio-rest-api.raml +47 -47
- data/test/apis/twitter-rest-api.raml +1883 -1883
- data/test/raml/body_spec.rb +22 -39
- data/test/raml/documentation_spec.rb +2 -12
- data/test/raml/method_spec.rb +112 -93
- data/test/raml/parameter/abstract_parameter_spec.rb +9 -34
- data/test/raml/parameter/query_parameter_spec.rb +0 -15
- data/test/raml/parameter/uri_parameter_spec.rb +1 -16
- data/test/raml/resource_spec.rb +59 -41
- data/test/raml/resource_type_spec.rb +13 -13
- data/test/raml/response_spec.rb +23 -36
- data/test/raml/root_spec.rb +85 -18
- data/test/raml/security_scheme_spec.rb +71 -0
- data/test/raml/spec_helper.rb +2 -1
- data/test/raml/template_spec.rb +92 -92
- data/test/raml/trait_spec.rb +7 -7
- metadata +14 -74
- data/templates/abstract_parameter.slim +0 -68
- data/templates/body.slim +0 -15
- data/templates/collapse.slim +0 -10
- data/templates/documentation.slim +0 -2
- data/templates/method.slim +0 -38
- data/templates/resource.slim +0 -33
- data/templates/response.slim +0 -13
- data/templates/root.slim +0 -39
- data/templates/style.sass +0 -119
data/lib/raml/node/schema.rb
CHANGED
@@ -12,12 +12,6 @@ module Raml
|
|
12
12
|
/<xs:schema [^>]*xmlns:xs="http:\/\/www\.w3\.org\/2001\/XMLSchema"[^>]*>/ === @value
|
13
13
|
end
|
14
14
|
|
15
|
-
# Returns HTML documenting the node and child nodes.
|
16
|
-
# @return [String] HTML documentation.
|
17
|
-
def document
|
18
|
-
highlight @value, parent.media_type
|
19
|
-
end
|
20
|
-
|
21
15
|
private
|
22
16
|
|
23
17
|
def validate_value
|
@@ -32,10 +26,10 @@ module Raml
|
|
32
26
|
# fix up schema versions URLs that don't end in "#""
|
33
27
|
version = "#{version}#" if version =~ /\Ahttps?:\/\/json-schema\.org\/draft-\d\d\/schema\z/
|
34
28
|
|
35
|
-
meta_schema = JSON::Validator.
|
29
|
+
meta_schema = JSON::Validator.validator_for_name(version).metaschema
|
36
30
|
JSON::Validator.validate! meta_schema, parsed_schema
|
37
31
|
rescue JSON::ParserError, JSON::Schema::SchemaError, JSON::Schema::ValidationError => e
|
38
|
-
raise InvalidSchema, "Could not parse JSON Schema: #{e}"
|
32
|
+
raise InvalidSchema, "Could not parse JSON Schema: #{e}"
|
39
33
|
end
|
40
34
|
end
|
41
|
-
end
|
35
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
module Raml
|
2
|
+
class SecurityScheme < Template
|
3
|
+
class Instance < PropertiesNode
|
4
|
+
inherit_class_attributes
|
5
|
+
|
6
|
+
include Validation
|
7
|
+
|
8
|
+
# @!attribute [rw] description
|
9
|
+
# @return [String,nil] how the description of the security scheme.
|
10
|
+
scalar_property :description
|
11
|
+
|
12
|
+
# @!attribute [rw] type
|
13
|
+
# @return [String,nil] describes the type of the security scheme.
|
14
|
+
scalar_property :type
|
15
|
+
|
16
|
+
# @!attribute [r] described_by
|
17
|
+
# @return [Hash<String, Raml::Trait>] the trait-like description of the
|
18
|
+
# security scheme.
|
19
|
+
|
20
|
+
# @!attribute [r] settings
|
21
|
+
# @return [Hash<String, Any] the settings for the security scheme
|
22
|
+
|
23
|
+
non_scalar_property :described_by, :settings
|
24
|
+
|
25
|
+
private
|
26
|
+
|
27
|
+
def parse_described_by(value)
|
28
|
+
validate_hash :described_by, value, String, Hash
|
29
|
+
value.map { |uname, udata| Trait.new uname, udata, self }
|
30
|
+
end
|
31
|
+
|
32
|
+
def parse_settings(value)
|
33
|
+
validate_hash :settings, value, String
|
34
|
+
value
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
# Instantiate a new resource type with the given parameters.
|
39
|
+
# @param params [Hash] the parameters to interpolate in the resource type.
|
40
|
+
# @return [Raml::SecurityScheme::Instance] the instantiated resouce type.
|
41
|
+
def instantiate(params)
|
42
|
+
instance = Instance.new( *interpolate(params), @parent )
|
43
|
+
# instance.apply_resource_type # TODO: do we need apply_security_scheme?
|
44
|
+
instance
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
data/lib/raml/node/trait.rb
CHANGED
@@ -1,18 +1,18 @@
|
|
1
1
|
module Raml
|
2
2
|
class Trait < Template
|
3
|
-
|
4
|
-
|
3
|
+
class Instance < AbstractMethod
|
4
|
+
inherit_class_attributes
|
5
5
|
|
6
6
|
# @!attribute [rw] usage
|
7
7
|
# @return [String,nil] how the trait should be used.
|
8
|
-
|
9
|
-
|
8
|
+
scalar_property :usage
|
9
|
+
end
|
10
10
|
|
11
11
|
# Instantiate a new trait with the given parameters.
|
12
12
|
# @param params [Hash] the parameters to interpolate in the trait.
|
13
13
|
# @return [Raml::Trait::Instance] the instantiated trait.
|
14
|
-
|
15
|
-
|
16
|
-
|
14
|
+
def instantiate(params)
|
15
|
+
Instance.new( *interpolate(params), @parent )
|
16
|
+
end
|
17
17
|
end
|
18
|
-
end
|
18
|
+
end
|
data/lib/raml/parser.rb
CHANGED
@@ -9,7 +9,7 @@ module Raml
|
|
9
9
|
|
10
10
|
data = YAML.load data
|
11
11
|
expand_includes data, file_dir
|
12
|
-
|
12
|
+
|
13
13
|
Root.new data
|
14
14
|
end
|
15
15
|
|
@@ -22,27 +22,36 @@ module Raml
|
|
22
22
|
def expand_includes(val, cwd)
|
23
23
|
case val
|
24
24
|
when Hash
|
25
|
-
val.merge!(val, &
|
25
|
+
val.merge!(val, &expand_includes_transform_hash(cwd))
|
26
26
|
when Array
|
27
|
-
val.map!(&
|
27
|
+
val.map!(&expand_includes_transform_array(cwd))
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def expand_includes_transform_array(cwd)
|
32
|
+
proc do |arg|
|
33
|
+
expand_includes_transform(arg, cwd)
|
28
34
|
end
|
29
35
|
end
|
30
|
-
|
31
|
-
def
|
36
|
+
|
37
|
+
def expand_includes_transform_hash(cwd)
|
32
38
|
proc do |arg1, arg2|
|
33
|
-
|
34
|
-
child_wd = cwd
|
35
|
-
|
36
|
-
if val.is_a? Raml::Parser::Include
|
37
|
-
child_wd = expand_includes_working_dir cwd, val.path
|
38
|
-
val = val.content cwd
|
39
|
-
end
|
40
|
-
|
41
|
-
expand_includes val, child_wd
|
42
|
-
|
43
|
-
val
|
39
|
+
expand_includes_transform(arg2, cwd)
|
44
40
|
end
|
45
41
|
end
|
42
|
+
|
43
|
+
def expand_includes_transform(val, cwd)
|
44
|
+
child_wd = cwd
|
45
|
+
|
46
|
+
if val.is_a? Raml::Parser::Include
|
47
|
+
child_wd = expand_includes_working_dir cwd, val.path
|
48
|
+
val = val.content cwd
|
49
|
+
end
|
50
|
+
|
51
|
+
expand_includes val, child_wd
|
52
|
+
|
53
|
+
val
|
54
|
+
end
|
46
55
|
|
47
56
|
def expand_includes_working_dir(current_wd, include_pathname)
|
48
57
|
include_path = File.dirname include_pathname
|
data/lib/raml/version.rb
CHANGED
data/raml_ruby.gemspec
CHANGED
@@ -18,15 +18,11 @@ Gem::Specification.new do |spec|
|
|
18
18
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
19
|
spec.require_paths = ["lib"]
|
20
20
|
|
21
|
-
spec.add_dependency 'activesupport', '
|
22
|
-
spec.add_dependency 'json-schema' , '~> 2.
|
23
|
-
spec.add_dependency 'kramdown' , '~> 1.4'
|
24
|
-
spec.add_dependency 'rouge' , '~> 1.7'
|
25
|
-
spec.add_dependency 'sass' , '~> 3.4'
|
26
|
-
spec.add_dependency 'slim' , '~> 2.0'
|
21
|
+
spec.add_dependency 'activesupport', '>= 4.1'
|
22
|
+
spec.add_dependency 'json-schema' , '~> 2.5'
|
27
23
|
spec.add_dependency 'uri_template' , '~> 0.7'
|
28
24
|
|
29
|
-
spec.add_development_dependency 'bundler', "~> 1.
|
25
|
+
spec.add_development_dependency 'bundler', "~> 1.11"
|
30
26
|
spec.add_development_dependency 'rake' , '~> 10.0'
|
31
27
|
spec.add_development_dependency 'rspec' , '~> 3.0'
|
32
28
|
spec.add_development_dependency 'rr' , '~> 1.1'
|
data/test/apis/box-api.raml
CHANGED
@@ -148,25 +148,25 @@ resourceTypes:
|
|
148
148
|
body:
|
149
149
|
schema: |
|
150
150
|
{
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
151
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
152
|
+
"type": "object" ,
|
153
|
+
"properties": {
|
154
|
+
"name": {
|
155
|
+
"description": "The desired name for the folder.",
|
156
|
+
"type": "string",
|
157
157
|
"required": true
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
158
|
+
},
|
159
|
+
"parent": {
|
160
|
+
"description": "The parent folder.",
|
161
|
+
"type": "object",
|
162
162
|
"required": true
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
163
|
+
},
|
164
|
+
"id": {
|
165
|
+
"description": "The ID of the parent folder.",
|
166
|
+
"type": "string",
|
167
167
|
"required": true
|
168
|
-
|
169
|
-
|
168
|
+
}
|
169
|
+
}
|
170
170
|
}
|
171
171
|
responses:
|
172
172
|
200:
|
@@ -353,41 +353,41 @@ resourceTypes:
|
|
353
353
|
body:
|
354
354
|
schema: |
|
355
355
|
{
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
356
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
357
|
+
"type": "object" ,
|
358
|
+
"properties": {
|
359
|
+
"name": {
|
360
|
+
"description": "The desired name for the folder.",
|
361
|
+
"type": "string",
|
362
362
|
"required": true
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
363
|
+
},
|
364
|
+
"parent": {
|
365
|
+
"description": "The parent folder.",
|
366
|
+
"type": "object",
|
367
367
|
"required": true
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
368
|
+
},
|
369
|
+
"id": {
|
370
|
+
"description": "The ID of the parent folder.",
|
371
|
+
"type": "string",
|
372
372
|
"required": true
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
373
|
+
},
|
374
|
+
"description": {
|
375
|
+
"description": "The description of the folder.",
|
376
|
+
"type": "string"
|
377
|
+
},
|
378
|
+
"shared_link": {
|
379
|
+
"description": "An object representing this item'''s shared link and associated permissions.",
|
380
|
+
"type": "object"
|
381
|
+
},
|
382
|
+
"access": {
|
383
|
+
"description": "The level of access required for this shared link.",
|
384
|
+
"type": [ "open", "company", "collaborators"]
|
385
|
+
},
|
386
|
+
"unshared_at": {
|
387
|
+
"description": "The day that this link should be disabled at. Timestamps are rounded off to the given day.",
|
388
|
+
"type": "timestamp"
|
389
|
+
}
|
390
|
+
}
|
391
391
|
}
|
392
392
|
responses:
|
393
393
|
200:
|
@@ -498,22 +498,22 @@ resourceTypes:
|
|
498
498
|
body:
|
499
499
|
schema: |
|
500
500
|
{
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
501
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
502
|
+
"type": "object" ,
|
503
|
+
"properties": {
|
504
|
+
"name": {
|
505
|
+
"description": "The new name for this item.",
|
506
|
+
"type": "string"
|
507
|
+
},
|
508
|
+
"parent": {
|
509
|
+
"description": "The new parent folder for this item.",
|
510
|
+
"type": "object"
|
511
|
+
},
|
512
|
+
"id": {
|
513
|
+
"description": "The id of the new parent folder.",
|
514
|
+
"type": "string"
|
515
|
+
}
|
516
|
+
}
|
517
517
|
}
|
518
518
|
responses:
|
519
519
|
201:
|
@@ -584,24 +584,24 @@ resourceTypes:
|
|
584
584
|
body:
|
585
585
|
schema: |
|
586
586
|
{
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
587
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
588
|
+
"type": "object" ,
|
589
|
+
"properties": {
|
590
|
+
"name": {
|
591
|
+
"description": "An optional new name for the folder.",
|
592
|
+
"type": "string"
|
593
|
+
},
|
594
|
+
"parent": {
|
595
|
+
"description": "Object representing the new location of the folder.",
|
596
|
+
"type": "string",
|
597
597
|
"required": true
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
598
|
+
},
|
599
|
+
"id": {
|
600
|
+
"description": "The ID of the destination folder.",
|
601
|
+
"type": "string",
|
602
602
|
"required": true
|
603
|
-
|
604
|
-
|
603
|
+
}
|
604
|
+
}
|
605
605
|
}
|
606
606
|
responses:
|
607
607
|
200:
|
@@ -997,50 +997,50 @@ resourceTypes:
|
|
997
997
|
body:
|
998
998
|
schema: |
|
999
999
|
{
|
1000
|
-
|
1001
|
-
|
1002
|
-
|
1003
|
-
|
1004
|
-
|
1005
|
-
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1017
|
-
|
1018
|
-
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1024
|
-
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1039
|
-
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
|
1000
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1001
|
+
"type": "object" ,
|
1002
|
+
"properties": {
|
1003
|
+
"name": {
|
1004
|
+
"description": "The new name for the file.",
|
1005
|
+
"type": "string"
|
1006
|
+
},
|
1007
|
+
"description": {
|
1008
|
+
"description": "The new description for the file.",
|
1009
|
+
"type": "string"
|
1010
|
+
},
|
1011
|
+
"parent": {
|
1012
|
+
"description": "The parent folder of this file.",
|
1013
|
+
"type": "object"
|
1014
|
+
},
|
1015
|
+
"id": {
|
1016
|
+
"description": "The ID of the parent folder.",
|
1017
|
+
"type": "string"
|
1018
|
+
},
|
1019
|
+
"shared_link": {
|
1020
|
+
"description": "An object representing this item'''s shared link and associated permissions.",
|
1021
|
+
"type": "object"
|
1022
|
+
},
|
1023
|
+
"access": {
|
1024
|
+
"description": "The level of access required for this shared link.",
|
1025
|
+
"type": ["open", "company", "collaborators" ]
|
1026
|
+
},
|
1027
|
+
"unshared_at": {
|
1028
|
+
"description": "The day that this link should be disabled at. Timestamps are rounded off to the given day.",
|
1029
|
+
"type": "timestamp"
|
1030
|
+
},
|
1031
|
+
"permissions": {
|
1032
|
+
"description": "The set of permissions that apply to this link.",
|
1033
|
+
"type": "object"
|
1034
|
+
},
|
1035
|
+
"permissions.download": {
|
1036
|
+
"description": "Whether this link allows downloads.",
|
1037
|
+
"type": "boolean"
|
1038
|
+
},
|
1039
|
+
"permissions.preview": {
|
1040
|
+
"description": "Whether this link allows previews.",
|
1041
|
+
"type": "boolean"
|
1042
|
+
}
|
1043
|
+
}
|
1044
1044
|
}
|
1045
1045
|
responses:
|
1046
1046
|
200:
|
@@ -1138,22 +1138,22 @@ resourceTypes:
|
|
1138
1138
|
body:
|
1139
1139
|
schema: |
|
1140
1140
|
{
|
1141
|
-
|
1142
|
-
|
1143
|
-
|
1144
|
-
|
1145
|
-
|
1146
|
-
|
1147
|
-
|
1148
|
-
|
1149
|
-
|
1150
|
-
|
1151
|
-
|
1152
|
-
|
1153
|
-
|
1154
|
-
|
1155
|
-
|
1156
|
-
|
1141
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1142
|
+
"type": "object" ,
|
1143
|
+
"properties": {
|
1144
|
+
"name": {
|
1145
|
+
"description": "The new name for this item.",
|
1146
|
+
"type": "string"
|
1147
|
+
},
|
1148
|
+
"parent": {
|
1149
|
+
"description": "The new parent folder for this item.",
|
1150
|
+
"type": "object"
|
1151
|
+
},
|
1152
|
+
"id": {
|
1153
|
+
"description": "The id of the new parent folder.",
|
1154
|
+
"type": "string"
|
1155
|
+
}
|
1156
|
+
}
|
1157
1157
|
}
|
1158
1158
|
responses:
|
1159
1159
|
201:
|
@@ -1290,24 +1290,24 @@ resourceTypes:
|
|
1290
1290
|
body:
|
1291
1291
|
schema: |
|
1292
1292
|
{
|
1293
|
-
|
1294
|
-
|
1295
|
-
|
1296
|
-
|
1297
|
-
|
1298
|
-
|
1293
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1294
|
+
"type": "object" ,
|
1295
|
+
"properties": {
|
1296
|
+
"parent": {
|
1297
|
+
"description": "Folder object representing the new location of the file.",
|
1298
|
+
"type": "string",
|
1299
1299
|
"required": true
|
1300
|
-
|
1301
|
-
|
1302
|
-
|
1303
|
-
|
1300
|
+
},
|
1301
|
+
"id": {
|
1302
|
+
"description": "The ID of the destination folder.",
|
1303
|
+
"type": "string",
|
1304
1304
|
"required": true
|
1305
|
-
|
1306
|
-
|
1307
|
-
|
1308
|
-
|
1309
|
-
|
1310
|
-
|
1305
|
+
},
|
1306
|
+
"name": {
|
1307
|
+
"description": "An optional new name for the file",
|
1308
|
+
"type": "string"
|
1309
|
+
}
|
1310
|
+
}
|
1311
1311
|
}
|
1312
1312
|
responses:
|
1313
1313
|
200:
|
@@ -1705,27 +1705,27 @@ resourceTypes:
|
|
1705
1705
|
body:
|
1706
1706
|
schema: |
|
1707
1707
|
{
|
1708
|
-
|
1709
|
-
|
1710
|
-
|
1711
|
-
|
1712
|
-
|
1713
|
-
|
1708
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1709
|
+
"type": "object" ,
|
1710
|
+
"properties": {
|
1711
|
+
"item": {
|
1712
|
+
"description": "The item that this comment will be placed on.",
|
1713
|
+
"type": "object",
|
1714
1714
|
"required": true
|
1715
|
-
|
1716
|
-
|
1717
|
-
|
1718
|
-
|
1719
|
-
|
1720
|
-
|
1721
|
-
|
1722
|
-
|
1723
|
-
|
1724
|
-
|
1725
|
-
|
1726
|
-
|
1727
|
-
|
1728
|
-
|
1715
|
+
},
|
1716
|
+
"type": {
|
1717
|
+
"description": "The type of the item that this comment will be placed on.",
|
1718
|
+
"type": [ "file", "comment" ]
|
1719
|
+
},
|
1720
|
+
"id": {
|
1721
|
+
"description": "The id of the item that this comment will be placed on.",
|
1722
|
+
"type": "string"
|
1723
|
+
},
|
1724
|
+
"message": {
|
1725
|
+
"description": "The text body of the comment.",
|
1726
|
+
"type": "string"
|
1727
|
+
}
|
1728
|
+
}
|
1729
1729
|
}
|
1730
1730
|
responses:
|
1731
1731
|
200:
|
@@ -1751,71 +1751,71 @@ resourceTypes:
|
|
1751
1751
|
}
|
1752
1752
|
schema: |
|
1753
1753
|
{
|
1754
|
-
|
1755
|
-
|
1756
|
-
|
1757
|
-
|
1758
|
-
|
1759
|
-
|
1760
|
-
|
1761
|
-
|
1762
|
-
|
1763
|
-
|
1764
|
-
|
1765
|
-
|
1766
|
-
|
1767
|
-
|
1768
|
-
|
1769
|
-
|
1770
|
-
|
1771
|
-
|
1772
|
-
|
1773
|
-
|
1774
|
-
|
1775
|
-
|
1776
|
-
|
1777
|
-
|
1778
|
-
|
1779
|
-
|
1780
|
-
|
1781
|
-
|
1782
|
-
|
1783
|
-
|
1784
|
-
|
1785
|
-
|
1786
|
-
|
1787
|
-
|
1788
|
-
|
1789
|
-
|
1790
|
-
|
1791
|
-
|
1792
|
-
|
1793
|
-
|
1794
|
-
|
1795
|
-
|
1796
|
-
|
1797
|
-
|
1798
|
-
|
1799
|
-
|
1800
|
-
|
1801
|
-
|
1802
|
-
|
1803
|
-
|
1804
|
-
|
1805
|
-
|
1806
|
-
|
1807
|
-
|
1808
|
-
|
1809
|
-
|
1810
|
-
|
1811
|
-
|
1812
|
-
|
1813
|
-
|
1814
|
-
|
1815
|
-
|
1816
|
-
|
1817
|
-
|
1818
|
-
|
1754
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1755
|
+
"type": "object",
|
1756
|
+
"properties": {
|
1757
|
+
"type": {
|
1758
|
+
"description": "For comments is 'comment'.",
|
1759
|
+
"type": "string"
|
1760
|
+
},
|
1761
|
+
"id": {
|
1762
|
+
"description": "A unique string identifying this comment.",
|
1763
|
+
"type": "string"
|
1764
|
+
},
|
1765
|
+
"is_reply_comment": {
|
1766
|
+
"description": "Whether or not this comment is a reply to another comment.",
|
1767
|
+
"type": "boolean"
|
1768
|
+
},
|
1769
|
+
"message": {
|
1770
|
+
"description": "The comment text that the user typed.",
|
1771
|
+
"type": "string"
|
1772
|
+
},
|
1773
|
+
"tagged_message": {
|
1774
|
+
"description": "The string representing the comment text with @mentions included.",
|
1775
|
+
"required": false,
|
1776
|
+
"type": "string"
|
1777
|
+
},
|
1778
|
+
"created_by": {
|
1779
|
+
"properties": {
|
1780
|
+
"type": {
|
1781
|
+
"type": "string"
|
1782
|
+
},
|
1783
|
+
"id": {
|
1784
|
+
"type": "string"
|
1785
|
+
},
|
1786
|
+
"name": {
|
1787
|
+
"type": "string"
|
1788
|
+
},
|
1789
|
+
"login": {
|
1790
|
+
"type": "string"
|
1791
|
+
}
|
1792
|
+
},
|
1793
|
+
"description": "A mini user object representing the author of the comment.",
|
1794
|
+
"type": "object"
|
1795
|
+
},
|
1796
|
+
"dcreated_at": {
|
1797
|
+
"description": "The time this comment was created.",
|
1798
|
+
"type": "timestamp"
|
1799
|
+
},
|
1800
|
+
"item": {
|
1801
|
+
"properties": {
|
1802
|
+
"id": {
|
1803
|
+
"type": "string"
|
1804
|
+
},
|
1805
|
+
"type": {
|
1806
|
+
"type": "string"
|
1807
|
+
}
|
1808
|
+
},
|
1809
|
+
"description": "The object this comment was placed on.",
|
1810
|
+
"type": "object"
|
1811
|
+
},
|
1812
|
+
"modified_at": {
|
1813
|
+
"description": "The time this comment was last modified.",
|
1814
|
+
"type": "timestamp"
|
1815
|
+
}
|
1816
|
+
},
|
1817
|
+
"required": false,
|
1818
|
+
"type": "object"
|
1819
1819
|
}
|
1820
1820
|
/{commentId}:
|
1821
1821
|
type: base
|
@@ -1829,15 +1829,15 @@ resourceTypes:
|
|
1829
1829
|
body:
|
1830
1830
|
schema: |
|
1831
1831
|
{
|
1832
|
-
|
1833
|
-
|
1834
|
-
|
1835
|
-
|
1836
|
-
|
1837
|
-
|
1832
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1833
|
+
"type": "object" ,
|
1834
|
+
"properties": {
|
1835
|
+
"message": {
|
1836
|
+
"description": "The desired text for the comment message.",
|
1837
|
+
"type": "string",
|
1838
1838
|
"required": true
|
1839
|
-
|
1840
|
-
|
1839
|
+
}
|
1840
|
+
}
|
1841
1841
|
}
|
1842
1842
|
responses:
|
1843
1843
|
200:
|
@@ -1863,71 +1863,71 @@ resourceTypes:
|
|
1863
1863
|
}
|
1864
1864
|
schema: |
|
1865
1865
|
{
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1870
|
-
|
1871
|
-
|
1872
|
-
|
1873
|
-
|
1874
|
-
|
1875
|
-
|
1876
|
-
|
1877
|
-
|
1878
|
-
|
1879
|
-
|
1880
|
-
|
1881
|
-
|
1882
|
-
|
1883
|
-
|
1884
|
-
|
1885
|
-
|
1886
|
-
|
1887
|
-
|
1888
|
-
|
1889
|
-
|
1890
|
-
|
1891
|
-
|
1892
|
-
|
1893
|
-
|
1894
|
-
|
1895
|
-
|
1896
|
-
|
1897
|
-
|
1898
|
-
|
1899
|
-
|
1900
|
-
|
1901
|
-
|
1902
|
-
|
1903
|
-
|
1904
|
-
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1908
|
-
|
1909
|
-
|
1910
|
-
|
1911
|
-
|
1912
|
-
|
1913
|
-
|
1914
|
-
|
1915
|
-
|
1916
|
-
|
1917
|
-
|
1918
|
-
|
1919
|
-
|
1920
|
-
|
1921
|
-
|
1922
|
-
|
1923
|
-
|
1924
|
-
|
1925
|
-
|
1926
|
-
|
1927
|
-
|
1928
|
-
|
1929
|
-
|
1930
|
-
|
1866
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1867
|
+
"type": "object",
|
1868
|
+
"properties": {
|
1869
|
+
"type": {
|
1870
|
+
"description": "For comments is 'comment'.",
|
1871
|
+
"type": "string"
|
1872
|
+
},
|
1873
|
+
"id": {
|
1874
|
+
"description": "A unique string identifying this comment.",
|
1875
|
+
"type": "string"
|
1876
|
+
},
|
1877
|
+
"is_reply_comment": {
|
1878
|
+
"description": "Whether or not this comment is a reply to another comment.",
|
1879
|
+
"type": "boolean"
|
1880
|
+
},
|
1881
|
+
"message": {
|
1882
|
+
"description": "The comment text that the user typed.",
|
1883
|
+
"type": "string"
|
1884
|
+
},
|
1885
|
+
"tagged_message": {
|
1886
|
+
"description": "The string representing the comment text with @mentions included.",
|
1887
|
+
"required": false,
|
1888
|
+
"type": "string"
|
1889
|
+
},
|
1890
|
+
"created_by": {
|
1891
|
+
"properties": {
|
1892
|
+
"type": {
|
1893
|
+
"type": "string"
|
1894
|
+
},
|
1895
|
+
"id": {
|
1896
|
+
"type": "string"
|
1897
|
+
},
|
1898
|
+
"name": {
|
1899
|
+
"type": "string"
|
1900
|
+
},
|
1901
|
+
"login": {
|
1902
|
+
"type": "string"
|
1903
|
+
}
|
1904
|
+
},
|
1905
|
+
"description": "A mini user object representing the author of the comment.",
|
1906
|
+
"type": "object"
|
1907
|
+
},
|
1908
|
+
"dcreated_at": {
|
1909
|
+
"description": "The time this comment was created.",
|
1910
|
+
"type": "timestamp"
|
1911
|
+
},
|
1912
|
+
"item": {
|
1913
|
+
"properties": {
|
1914
|
+
"id": {
|
1915
|
+
"type": "string"
|
1916
|
+
},
|
1917
|
+
"type": {
|
1918
|
+
"type": "string"
|
1919
|
+
}
|
1920
|
+
},
|
1921
|
+
"description": "The object this comment was placed on.",
|
1922
|
+
"type": "object"
|
1923
|
+
},
|
1924
|
+
"modified_at": {
|
1925
|
+
"description": "The time this comment was last modified.",
|
1926
|
+
"type": "timestamp"
|
1927
|
+
}
|
1928
|
+
},
|
1929
|
+
"required": false,
|
1930
|
+
"type": "object"
|
1931
1931
|
}
|
1932
1932
|
get:
|
1933
1933
|
description: |
|
@@ -1957,71 +1957,71 @@ resourceTypes:
|
|
1957
1957
|
}
|
1958
1958
|
schema: |
|
1959
1959
|
{
|
1960
|
-
|
1961
|
-
|
1962
|
-
|
1963
|
-
|
1964
|
-
|
1965
|
-
|
1966
|
-
|
1967
|
-
|
1968
|
-
|
1969
|
-
|
1970
|
-
|
1971
|
-
|
1972
|
-
|
1973
|
-
|
1974
|
-
|
1975
|
-
|
1976
|
-
|
1977
|
-
|
1978
|
-
|
1979
|
-
|
1980
|
-
|
1981
|
-
|
1982
|
-
|
1983
|
-
|
1984
|
-
|
1985
|
-
|
1986
|
-
|
1987
|
-
|
1988
|
-
|
1989
|
-
|
1990
|
-
|
1991
|
-
|
1992
|
-
|
1993
|
-
|
1994
|
-
|
1995
|
-
|
1996
|
-
|
1997
|
-
|
1998
|
-
|
1999
|
-
|
2000
|
-
|
2001
|
-
|
2002
|
-
|
2003
|
-
|
2004
|
-
|
2005
|
-
|
2006
|
-
|
2007
|
-
|
2008
|
-
|
2009
|
-
|
2010
|
-
|
2011
|
-
|
2012
|
-
|
2013
|
-
|
2014
|
-
|
2015
|
-
|
2016
|
-
|
2017
|
-
|
2018
|
-
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
2022
|
-
|
2023
|
-
|
2024
|
-
|
1960
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
1961
|
+
"type": "object",
|
1962
|
+
"properties": {
|
1963
|
+
"type": {
|
1964
|
+
"description": "For comments is 'comment'.",
|
1965
|
+
"type": "string"
|
1966
|
+
},
|
1967
|
+
"id": {
|
1968
|
+
"description": "A unique string identifying this comment.",
|
1969
|
+
"type": "string"
|
1970
|
+
},
|
1971
|
+
"is_reply_comment": {
|
1972
|
+
"description": "Whether or not this comment is a reply to another comment.",
|
1973
|
+
"type": "boolean"
|
1974
|
+
},
|
1975
|
+
"message": {
|
1976
|
+
"description": "The comment text that the user typed.",
|
1977
|
+
"type": "string"
|
1978
|
+
},
|
1979
|
+
"tagged_message": {
|
1980
|
+
"description": "The string representing the comment text with @mentions included.",
|
1981
|
+
"required": false,
|
1982
|
+
"type": "string"
|
1983
|
+
},
|
1984
|
+
"created_by": {
|
1985
|
+
"properties": {
|
1986
|
+
"type": {
|
1987
|
+
"type": "string"
|
1988
|
+
},
|
1989
|
+
"id": {
|
1990
|
+
"type": "string"
|
1991
|
+
},
|
1992
|
+
"name": {
|
1993
|
+
"type": "string"
|
1994
|
+
},
|
1995
|
+
"login": {
|
1996
|
+
"type": "string"
|
1997
|
+
}
|
1998
|
+
},
|
1999
|
+
"description": "A mini user object representing the author of the comment.",
|
2000
|
+
"type": "object"
|
2001
|
+
},
|
2002
|
+
"dcreated_at": {
|
2003
|
+
"description": "The time this comment was created.",
|
2004
|
+
"type": "timestamp"
|
2005
|
+
},
|
2006
|
+
"item": {
|
2007
|
+
"properties": {
|
2008
|
+
"id": {
|
2009
|
+
"type": "string"
|
2010
|
+
},
|
2011
|
+
"type": {
|
2012
|
+
"type": "string"
|
2013
|
+
}
|
2014
|
+
},
|
2015
|
+
"description": "The object this comment was placed on.",
|
2016
|
+
"type": "object"
|
2017
|
+
},
|
2018
|
+
"modified_at": {
|
2019
|
+
"description": "The time this comment was last modified.",
|
2020
|
+
"type": "timestamp"
|
2021
|
+
}
|
2022
|
+
},
|
2023
|
+
"required": false,
|
2024
|
+
"type": "object"
|
2025
2025
|
}
|
2026
2026
|
delete:
|
2027
2027
|
description: |
|
@@ -2040,43 +2040,43 @@ resourceTypes:
|
|
2040
2040
|
body:
|
2041
2041
|
schema: |
|
2042
2042
|
{
|
2043
|
-
|
2044
|
-
|
2045
|
-
|
2046
|
-
|
2047
|
-
|
2048
|
-
|
2043
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2044
|
+
"type": "object",
|
2045
|
+
"properties": {
|
2046
|
+
"item": {
|
2047
|
+
"description": "The item to add the collaboration on.",
|
2048
|
+
"type": "object",
|
2049
2049
|
"required": true
|
2050
|
-
|
2051
|
-
|
2052
|
-
|
2053
|
-
|
2050
|
+
},
|
2051
|
+
"id": {
|
2052
|
+
"description": "The ID of the item to add the collaboration on.",
|
2053
|
+
"type": "string",
|
2054
2054
|
"required": true
|
2055
|
-
|
2056
|
-
|
2057
|
-
|
2058
|
-
|
2055
|
+
},
|
2056
|
+
"type": {
|
2057
|
+
"description": "Must be 'folder'.",
|
2058
|
+
"type": "string",
|
2059
2059
|
"required": true
|
2060
|
-
|
2061
|
-
|
2062
|
-
|
2063
|
-
|
2060
|
+
},
|
2061
|
+
"accessible_by": {
|
2062
|
+
"description": "The user who this collaboration applies to.",
|
2063
|
+
"type": "object",
|
2064
2064
|
"required": true
|
2065
|
-
|
2066
|
-
|
2067
|
-
|
2068
|
-
|
2065
|
+
},
|
2066
|
+
"role": {
|
2067
|
+
"description": "The access level of this collaboration.",
|
2068
|
+
"type": ["editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ],
|
2069
2069
|
"required": true
|
2070
|
-
|
2071
|
-
|
2072
|
-
|
2073
|
-
|
2074
|
-
|
2075
|
-
|
2076
|
-
|
2077
|
-
|
2078
|
-
|
2079
|
-
|
2070
|
+
},
|
2071
|
+
"id": {
|
2072
|
+
"description": "The ID of this user.",
|
2073
|
+
"type": "string"
|
2074
|
+
},
|
2075
|
+
"login": {
|
2076
|
+
"description": "An email address (does not need to be a Box user).",
|
2077
|
+
"type": "string"
|
2078
|
+
}
|
2079
|
+
}
|
2080
2080
|
}
|
2081
2081
|
responses:
|
2082
2082
|
200:
|
@@ -2113,99 +2113,99 @@ resourceTypes:
|
|
2113
2113
|
}
|
2114
2114
|
schema: |
|
2115
2115
|
{
|
2116
|
-
|
2117
|
-
|
2118
|
-
|
2119
|
-
|
2120
|
-
|
2121
|
-
|
2122
|
-
|
2123
|
-
|
2124
|
-
|
2125
|
-
|
2126
|
-
|
2127
|
-
|
2128
|
-
|
2129
|
-
|
2130
|
-
|
2131
|
-
|
2132
|
-
|
2133
|
-
|
2134
|
-
|
2135
|
-
|
2136
|
-
|
2137
|
-
|
2138
|
-
|
2139
|
-
|
2140
|
-
|
2141
|
-
|
2142
|
-
|
2143
|
-
|
2144
|
-
|
2145
|
-
|
2146
|
-
|
2147
|
-
|
2148
|
-
|
2149
|
-
|
2150
|
-
|
2151
|
-
|
2152
|
-
|
2153
|
-
|
2154
|
-
|
2155
|
-
|
2156
|
-
|
2157
|
-
|
2158
|
-
|
2159
|
-
|
2160
|
-
|
2161
|
-
|
2162
|
-
|
2163
|
-
|
2164
|
-
|
2165
|
-
|
2166
|
-
|
2167
|
-
|
2168
|
-
|
2169
|
-
|
2170
|
-
|
2171
|
-
|
2172
|
-
|
2173
|
-
|
2174
|
-
|
2175
|
-
|
2176
|
-
|
2177
|
-
|
2178
|
-
|
2179
|
-
|
2180
|
-
|
2181
|
-
|
2182
|
-
|
2183
|
-
|
2184
|
-
|
2185
|
-
|
2186
|
-
|
2187
|
-
|
2188
|
-
|
2189
|
-
|
2190
|
-
|
2191
|
-
|
2192
|
-
|
2193
|
-
|
2194
|
-
|
2195
|
-
|
2196
|
-
|
2197
|
-
|
2198
|
-
|
2199
|
-
|
2200
|
-
|
2201
|
-
|
2202
|
-
|
2203
|
-
|
2204
|
-
|
2205
|
-
|
2206
|
-
|
2207
|
-
|
2208
|
-
|
2116
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2117
|
+
"type": "object" ,
|
2118
|
+
"properties": {
|
2119
|
+
"type": {
|
2120
|
+
"description": "For collaborations is 'collaboration'",
|
2121
|
+
"type": "string"
|
2122
|
+
},
|
2123
|
+
"id": {
|
2124
|
+
"description": "A unique string identifying this collaboration.",
|
2125
|
+
"type": "string"
|
2126
|
+
},
|
2127
|
+
"created_by": {
|
2128
|
+
"properties": {
|
2129
|
+
"type": {
|
2130
|
+
"type": "string"
|
2131
|
+
},
|
2132
|
+
"id": {
|
2133
|
+
"type": "string"
|
2134
|
+
},
|
2135
|
+
"name": {
|
2136
|
+
"type": "string"
|
2137
|
+
},
|
2138
|
+
"login": {
|
2139
|
+
"type": "string"
|
2140
|
+
}
|
2141
|
+
},
|
2142
|
+
"description": "The user who created this collaboration.",
|
2143
|
+
"type": "object"
|
2144
|
+
},
|
2145
|
+
"created_at": {
|
2146
|
+
"description": "The time this collaboration was created.",
|
2147
|
+
"type": "timestamp"
|
2148
|
+
},
|
2149
|
+
"modified_at": {
|
2150
|
+
"description": "The time this collaboration was last modified.",
|
2151
|
+
"type": "timestamp"
|
2152
|
+
},
|
2153
|
+
"expires_at": {
|
2154
|
+
"description": "The time this collaboration will expire.",
|
2155
|
+
"type": "timestamp"
|
2156
|
+
},
|
2157
|
+
"status": {
|
2158
|
+
"description": "The status of this collab.",
|
2159
|
+
"enum": [ "accepted", "pending", "rejected" ]
|
2160
|
+
},
|
2161
|
+
"accecible_by": {
|
2162
|
+
"properties": {
|
2163
|
+
"type": {
|
2164
|
+
"type": "string"
|
2165
|
+
},
|
2166
|
+
"id": {
|
2167
|
+
"type": "string"
|
2168
|
+
},
|
2169
|
+
"name": {
|
2170
|
+
"type": "string"
|
2171
|
+
},
|
2172
|
+
"login": {
|
2173
|
+
"type": "string"
|
2174
|
+
}
|
2175
|
+
},
|
2176
|
+
"description": "The user who the collaboration applies to.",
|
2177
|
+
"type": "object"
|
2178
|
+
},
|
2179
|
+
"role": {
|
2180
|
+
"description": "The level of access this user has.",
|
2181
|
+
"enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ]
|
2182
|
+
},
|
2183
|
+
"acknowledged_at": {
|
2184
|
+
"description": "When the 'status' of this collab was changed.",
|
2185
|
+
"type": "timestamp"
|
2186
|
+
},
|
2187
|
+
"item": {
|
2188
|
+
"properties": {
|
2189
|
+
"type": {
|
2190
|
+
"type": "string"
|
2191
|
+
},
|
2192
|
+
"id": {
|
2193
|
+
"type": "string"
|
2194
|
+
},
|
2195
|
+
"sequence_id": {
|
2196
|
+
"type": "string"
|
2197
|
+
},
|
2198
|
+
"etag": {
|
2199
|
+
"type": "string"
|
2200
|
+
},
|
2201
|
+
"name": {
|
2202
|
+
"type": "string"
|
2203
|
+
}
|
2204
|
+
},
|
2205
|
+
"description": "The folder this collaboration is related to",
|
2206
|
+
"type": "object"
|
2207
|
+
}
|
2208
|
+
}
|
2209
2209
|
}
|
2210
2210
|
/{collabId}:
|
2211
2211
|
type: base
|
@@ -2221,19 +2221,19 @@ resourceTypes:
|
|
2221
2221
|
body:
|
2222
2222
|
schema: |
|
2223
2223
|
{
|
2224
|
-
|
2225
|
-
|
2226
|
-
|
2227
|
-
|
2228
|
-
|
2229
|
-
|
2230
|
-
|
2231
|
-
|
2232
|
-
|
2233
|
-
|
2234
|
-
|
2224
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2225
|
+
"type": "object" ,
|
2226
|
+
"properties": {
|
2227
|
+
"role": {
|
2228
|
+
"description": "The access level of this collaboration",
|
2229
|
+
"enum": ["editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ]
|
2230
|
+
},
|
2231
|
+
"status": {
|
2232
|
+
"description": "Whether this collaboration has been accepted.",
|
2233
|
+
"enum": ["accepted", "pending", "rejected" ]
|
2234
|
+
}
|
2235
2235
|
|
2236
|
-
|
2236
|
+
}
|
2237
2237
|
}
|
2238
2238
|
responses:
|
2239
2239
|
200:
|
@@ -2270,99 +2270,99 @@ resourceTypes:
|
|
2270
2270
|
}
|
2271
2271
|
schema: |
|
2272
2272
|
{
|
2273
|
-
|
2274
|
-
|
2275
|
-
|
2276
|
-
|
2277
|
-
|
2278
|
-
|
2279
|
-
|
2280
|
-
|
2281
|
-
|
2282
|
-
|
2283
|
-
|
2284
|
-
|
2285
|
-
|
2286
|
-
|
2287
|
-
|
2288
|
-
|
2289
|
-
|
2290
|
-
|
2291
|
-
|
2292
|
-
|
2293
|
-
|
2294
|
-
|
2295
|
-
|
2296
|
-
|
2297
|
-
|
2298
|
-
|
2299
|
-
|
2300
|
-
|
2301
|
-
|
2302
|
-
|
2303
|
-
|
2304
|
-
|
2305
|
-
|
2306
|
-
|
2307
|
-
|
2308
|
-
|
2309
|
-
|
2310
|
-
|
2311
|
-
|
2312
|
-
|
2313
|
-
|
2314
|
-
|
2315
|
-
|
2316
|
-
|
2317
|
-
|
2318
|
-
|
2319
|
-
|
2320
|
-
|
2321
|
-
|
2322
|
-
|
2323
|
-
|
2324
|
-
|
2325
|
-
|
2326
|
-
|
2327
|
-
|
2328
|
-
|
2329
|
-
|
2330
|
-
|
2331
|
-
|
2332
|
-
|
2333
|
-
|
2334
|
-
|
2335
|
-
|
2336
|
-
|
2337
|
-
|
2338
|
-
|
2339
|
-
|
2340
|
-
|
2341
|
-
|
2342
|
-
|
2343
|
-
|
2344
|
-
|
2345
|
-
|
2346
|
-
|
2347
|
-
|
2348
|
-
|
2349
|
-
|
2350
|
-
|
2351
|
-
|
2352
|
-
|
2353
|
-
|
2354
|
-
|
2355
|
-
|
2356
|
-
|
2357
|
-
|
2358
|
-
|
2359
|
-
|
2360
|
-
|
2361
|
-
|
2362
|
-
|
2363
|
-
|
2364
|
-
|
2365
|
-
|
2273
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2274
|
+
"type": "object" ,
|
2275
|
+
"properties": {
|
2276
|
+
"type": {
|
2277
|
+
"description": "For collaborations is 'collaboration'",
|
2278
|
+
"type": "string"
|
2279
|
+
},
|
2280
|
+
"id": {
|
2281
|
+
"description": "A unique string identifying this collaboration.",
|
2282
|
+
"type": "string"
|
2283
|
+
},
|
2284
|
+
"created_by": {
|
2285
|
+
"properties": {
|
2286
|
+
"type": {
|
2287
|
+
"type": "string"
|
2288
|
+
},
|
2289
|
+
"id": {
|
2290
|
+
"type": "string"
|
2291
|
+
},
|
2292
|
+
"name": {
|
2293
|
+
"type": "string"
|
2294
|
+
},
|
2295
|
+
"login": {
|
2296
|
+
"type": "string"
|
2297
|
+
}
|
2298
|
+
},
|
2299
|
+
"description": "The user who created this collaboration.",
|
2300
|
+
"type": "object"
|
2301
|
+
},
|
2302
|
+
"created_at": {
|
2303
|
+
"description": "The time this collaboration was created.",
|
2304
|
+
"type": "timestamp"
|
2305
|
+
},
|
2306
|
+
"modified_at": {
|
2307
|
+
"description": "The time this collaboration was last modified.",
|
2308
|
+
"type": "timestamp"
|
2309
|
+
},
|
2310
|
+
"expires_at": {
|
2311
|
+
"description": "The time this collaboration will expire.",
|
2312
|
+
"type": "timestamp"
|
2313
|
+
},
|
2314
|
+
"status": {
|
2315
|
+
"description": "The status of this collab.",
|
2316
|
+
"enum": [ "accepted", "pending", "rejected" ]
|
2317
|
+
},
|
2318
|
+
"accecible_by": {
|
2319
|
+
"properties": {
|
2320
|
+
"type": {
|
2321
|
+
"type": "string"
|
2322
|
+
},
|
2323
|
+
"id": {
|
2324
|
+
"type": "string"
|
2325
|
+
},
|
2326
|
+
"name": {
|
2327
|
+
"type": "string"
|
2328
|
+
},
|
2329
|
+
"login": {
|
2330
|
+
"type": "string"
|
2331
|
+
}
|
2332
|
+
},
|
2333
|
+
"description": "The user who the collaboration applies to.",
|
2334
|
+
"type": "object"
|
2335
|
+
},
|
2336
|
+
"role": {
|
2337
|
+
"description": "The level of access this user has.",
|
2338
|
+
"enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ]
|
2339
|
+
},
|
2340
|
+
"acknowledged_at": {
|
2341
|
+
"description": "When the 'status' of this collab was changed.",
|
2342
|
+
"type": "timestamp"
|
2343
|
+
},
|
2344
|
+
"item": {
|
2345
|
+
"properties": {
|
2346
|
+
"type": {
|
2347
|
+
"type": "string"
|
2348
|
+
},
|
2349
|
+
"id": {
|
2350
|
+
"type": "string"
|
2351
|
+
},
|
2352
|
+
"sequence_id": {
|
2353
|
+
"type": "string"
|
2354
|
+
},
|
2355
|
+
"etag": {
|
2356
|
+
"type": "string"
|
2357
|
+
},
|
2358
|
+
"name": {
|
2359
|
+
"type": "string"
|
2360
|
+
}
|
2361
|
+
},
|
2362
|
+
"description": "The folder this collaboration is related to",
|
2363
|
+
"type": "object"
|
2364
|
+
}
|
2365
|
+
}
|
2366
2366
|
}
|
2367
2367
|
delete:
|
2368
2368
|
description: |
|
@@ -2417,99 +2417,99 @@ resourceTypes:
|
|
2417
2417
|
}
|
2418
2418
|
schema: |
|
2419
2419
|
{
|
2420
|
-
|
2421
|
-
|
2422
|
-
|
2423
|
-
|
2424
|
-
|
2425
|
-
|
2426
|
-
|
2427
|
-
|
2428
|
-
|
2429
|
-
|
2430
|
-
|
2431
|
-
|
2432
|
-
|
2433
|
-
|
2434
|
-
|
2435
|
-
|
2436
|
-
|
2437
|
-
|
2438
|
-
|
2439
|
-
|
2440
|
-
|
2441
|
-
|
2442
|
-
|
2443
|
-
|
2444
|
-
|
2445
|
-
|
2446
|
-
|
2447
|
-
|
2448
|
-
|
2449
|
-
|
2450
|
-
|
2451
|
-
|
2452
|
-
|
2453
|
-
|
2454
|
-
|
2455
|
-
|
2456
|
-
|
2457
|
-
|
2458
|
-
|
2459
|
-
|
2460
|
-
|
2461
|
-
|
2462
|
-
|
2463
|
-
|
2464
|
-
|
2465
|
-
|
2466
|
-
|
2467
|
-
|
2468
|
-
|
2469
|
-
|
2470
|
-
|
2471
|
-
|
2472
|
-
|
2473
|
-
|
2474
|
-
|
2475
|
-
|
2476
|
-
|
2477
|
-
|
2478
|
-
|
2479
|
-
|
2480
|
-
|
2481
|
-
|
2482
|
-
|
2483
|
-
|
2484
|
-
|
2485
|
-
|
2486
|
-
|
2487
|
-
|
2488
|
-
|
2489
|
-
|
2490
|
-
|
2491
|
-
|
2492
|
-
|
2493
|
-
|
2494
|
-
|
2495
|
-
|
2496
|
-
|
2497
|
-
|
2498
|
-
|
2499
|
-
|
2500
|
-
|
2501
|
-
|
2502
|
-
|
2503
|
-
|
2504
|
-
|
2505
|
-
|
2506
|
-
|
2507
|
-
|
2508
|
-
|
2509
|
-
|
2510
|
-
|
2511
|
-
|
2512
|
-
|
2420
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2421
|
+
"type": "object" ,
|
2422
|
+
"properties": {
|
2423
|
+
"type": {
|
2424
|
+
"description": "For collaborations is 'collaboration'",
|
2425
|
+
"type": "string"
|
2426
|
+
},
|
2427
|
+
"id": {
|
2428
|
+
"description": "A unique string identifying this collaboration.",
|
2429
|
+
"type": "string"
|
2430
|
+
},
|
2431
|
+
"created_by": {
|
2432
|
+
"properties": {
|
2433
|
+
"type": {
|
2434
|
+
"type": "string"
|
2435
|
+
},
|
2436
|
+
"id": {
|
2437
|
+
"type": "string"
|
2438
|
+
},
|
2439
|
+
"name": {
|
2440
|
+
"type": "string"
|
2441
|
+
},
|
2442
|
+
"login": {
|
2443
|
+
"type": "string"
|
2444
|
+
}
|
2445
|
+
},
|
2446
|
+
"description": "The user who created this collaboration.",
|
2447
|
+
"type": "object"
|
2448
|
+
},
|
2449
|
+
"created_at": {
|
2450
|
+
"description": "The time this collaboration was created.",
|
2451
|
+
"type": "timestamp"
|
2452
|
+
},
|
2453
|
+
"modified_at": {
|
2454
|
+
"description": "The time this collaboration was last modified.",
|
2455
|
+
"type": "timestamp"
|
2456
|
+
},
|
2457
|
+
"expires_at": {
|
2458
|
+
"description": "The time this collaboration will expire.",
|
2459
|
+
"type": "timestamp"
|
2460
|
+
},
|
2461
|
+
"status": {
|
2462
|
+
"description": "The status of this collab.",
|
2463
|
+
"enum": [ "accepted", "pending", "rejected" ]
|
2464
|
+
},
|
2465
|
+
"accecible_by": {
|
2466
|
+
"properties": {
|
2467
|
+
"type": {
|
2468
|
+
"type": "string"
|
2469
|
+
},
|
2470
|
+
"id": {
|
2471
|
+
"type": "string"
|
2472
|
+
},
|
2473
|
+
"name": {
|
2474
|
+
"type": "string"
|
2475
|
+
},
|
2476
|
+
"login": {
|
2477
|
+
"type": "string"
|
2478
|
+
}
|
2479
|
+
},
|
2480
|
+
"description": "The user who the collaboration applies to.",
|
2481
|
+
"type": "object"
|
2482
|
+
},
|
2483
|
+
"role": {
|
2484
|
+
"description": "The level of access this user has.",
|
2485
|
+
"enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ]
|
2486
|
+
},
|
2487
|
+
"acknowledged_at": {
|
2488
|
+
"description": "When the 'status' of this collab was changed.",
|
2489
|
+
"type": "timestamp"
|
2490
|
+
},
|
2491
|
+
"item": {
|
2492
|
+
"properties": {
|
2493
|
+
"type": {
|
2494
|
+
"type": "string"
|
2495
|
+
},
|
2496
|
+
"id": {
|
2497
|
+
"type": "string"
|
2498
|
+
},
|
2499
|
+
"sequence_id": {
|
2500
|
+
"type": "string"
|
2501
|
+
},
|
2502
|
+
"etag": {
|
2503
|
+
"type": "string"
|
2504
|
+
},
|
2505
|
+
"name": {
|
2506
|
+
"type": "string"
|
2507
|
+
}
|
2508
|
+
},
|
2509
|
+
"description": "The folder this collaboration is related to",
|
2510
|
+
"type": "object"
|
2511
|
+
}
|
2512
|
+
}
|
2513
2513
|
}
|
2514
2514
|
/search:
|
2515
2515
|
type: base
|
@@ -2808,109 +2808,109 @@ resourceTypes:
|
|
2808
2808
|
}
|
2809
2809
|
schema: |
|
2810
2810
|
{
|
2811
|
-
|
2812
|
-
|
2813
|
-
|
2814
|
-
|
2815
|
-
|
2816
|
-
|
2817
|
-
|
2818
|
-
|
2819
|
-
|
2820
|
-
|
2821
|
-
|
2822
|
-
|
2823
|
-
|
2824
|
-
|
2825
|
-
|
2826
|
-
|
2827
|
-
|
2828
|
-
|
2829
|
-
|
2830
|
-
|
2831
|
-
|
2832
|
-
|
2833
|
-
|
2834
|
-
|
2835
|
-
|
2836
|
-
|
2837
|
-
|
2838
|
-
|
2839
|
-
|
2840
|
-
|
2841
|
-
|
2842
|
-
|
2843
|
-
|
2844
|
-
|
2845
|
-
|
2846
|
-
|
2847
|
-
|
2848
|
-
|
2849
|
-
|
2850
|
-
|
2851
|
-
|
2852
|
-
|
2853
|
-
|
2854
|
-
|
2855
|
-
|
2856
|
-
|
2857
|
-
|
2858
|
-
|
2859
|
-
|
2860
|
-
|
2861
|
-
|
2862
|
-
|
2863
|
-
|
2864
|
-
|
2865
|
-
|
2866
|
-
|
2867
|
-
|
2868
|
-
|
2869
|
-
|
2870
|
-
|
2871
|
-
|
2872
|
-
|
2873
|
-
|
2874
|
-
|
2875
|
-
|
2876
|
-
|
2877
|
-
|
2878
|
-
|
2879
|
-
|
2880
|
-
|
2881
|
-
|
2882
|
-
|
2883
|
-
|
2884
|
-
|
2885
|
-
|
2886
|
-
|
2887
|
-
|
2888
|
-
|
2889
|
-
|
2890
|
-
|
2891
|
-
|
2892
|
-
|
2893
|
-
|
2894
|
-
|
2895
|
-
|
2896
|
-
|
2897
|
-
|
2898
|
-
|
2899
|
-
|
2900
|
-
|
2901
|
-
|
2902
|
-
|
2903
|
-
|
2904
|
-
|
2905
|
-
|
2906
|
-
|
2907
|
-
|
2908
|
-
|
2909
|
-
|
2910
|
-
|
2911
|
-
|
2912
|
-
|
2913
|
-
|
2811
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2812
|
+
"type": "object" ,
|
2813
|
+
"properties": {
|
2814
|
+
"type": {
|
2815
|
+
"description": "For users is 'user'.",
|
2816
|
+
"type": "string"
|
2817
|
+
},
|
2818
|
+
"id": {
|
2819
|
+
"description": "A unique string identifying this user.",
|
2820
|
+
"type": "string"
|
2821
|
+
},
|
2822
|
+
"name": {
|
2823
|
+
"description": "The name of this user.",
|
2824
|
+
"type": "string"
|
2825
|
+
},
|
2826
|
+
"login": {
|
2827
|
+
"description": "The email address this user uses to login.",
|
2828
|
+
"type": "string"
|
2829
|
+
},
|
2830
|
+
"created_at": {
|
2831
|
+
"description": "The time this user was created.",
|
2832
|
+
"type": "timestamp"
|
2833
|
+
},
|
2834
|
+
"modified_at": {
|
2835
|
+
"description": "The time this user was last modified.",
|
2836
|
+
"type": "timestamp"
|
2837
|
+
},
|
2838
|
+
"role": {
|
2839
|
+
"description": "This user'''s enterprise role.",
|
2840
|
+
"enum": [ "admin", "coadmin", "user" ]
|
2841
|
+
},
|
2842
|
+
"language": {
|
2843
|
+
"description": "The language of this user. ISO 639-1 Language Code.",
|
2844
|
+
"type": "string"
|
2845
|
+
},
|
2846
|
+
"space_amount": {
|
2847
|
+
"description": "The user'''s total available space amount in bytes.",
|
2848
|
+
"type": "integer"
|
2849
|
+
},
|
2850
|
+
"space_used": {
|
2851
|
+
"description": "The amount of space in use by the user.",
|
2852
|
+
"type": "integer"
|
2853
|
+
},
|
2854
|
+
"max_upload_size": {
|
2855
|
+
"description": "The maximum individual file size in bytes this user can have.",
|
2856
|
+
"type": "integer"
|
2857
|
+
},
|
2858
|
+
"tracking_codes": {
|
2859
|
+
"description": "An array of key/value pairs set by the user'''s admin.",
|
2860
|
+
"type": "array"
|
2861
|
+
},
|
2862
|
+
"can_see_managed_users": {
|
2863
|
+
"description": "Whether this user can see other enterprise users in its contact list.",
|
2864
|
+
"type": "boolean"
|
2865
|
+
},
|
2866
|
+
"is_sync_enabled": {
|
2867
|
+
"description": "Whether or not this user can use Box Sync",
|
2868
|
+
"type": "boolean"
|
2869
|
+
},
|
2870
|
+
"status": {
|
2871
|
+
"description": "Can be active or inactive.",
|
2872
|
+
"enum": [ "actibe", "inactive" ]
|
2873
|
+
},
|
2874
|
+
"job_title": {
|
2875
|
+
"description": "The user'''s job title.",
|
2876
|
+
"type": "string"
|
2877
|
+
},
|
2878
|
+
"phone": {
|
2879
|
+
"description": "The user'''s phone number.",
|
2880
|
+
"type": "string"
|
2881
|
+
},
|
2882
|
+
"address": {
|
2883
|
+
"description": "The user'''s address.",
|
2884
|
+
"type": "string"
|
2885
|
+
},
|
2886
|
+
"avatar_url": {
|
2887
|
+
"description": "URL of this user'''s avatar image.",
|
2888
|
+
"type": "string"
|
2889
|
+
},
|
2890
|
+
"is_exempt_from_device_limits": {
|
2891
|
+
"description": "Whether to exempt this user from Enterprise device limits.",
|
2892
|
+
"type": "boolean"
|
2893
|
+
},
|
2894
|
+
"is_exempt_from_login_verification": {
|
2895
|
+
"description": "Whether or not this user must use two-factor authentication.",
|
2896
|
+
"type": "boolean"
|
2897
|
+
},
|
2898
|
+
"enterprise": {
|
2899
|
+
"properties": {
|
2900
|
+
"type": {
|
2901
|
+
"type": "string"
|
2902
|
+
},
|
2903
|
+
"id": {
|
2904
|
+
"type": "string"
|
2905
|
+
},
|
2906
|
+
"name": {
|
2907
|
+
"type": "string"
|
2908
|
+
}
|
2909
|
+
},
|
2910
|
+
"description": "Mini representation of this user'''s enterprise, including the ID of its enterprise",
|
2911
|
+
"type": "object"
|
2912
|
+
}
|
2913
|
+
}
|
2914
2914
|
}
|
2915
2915
|
/me:
|
2916
2916
|
type: base
|
@@ -2943,109 +2943,109 @@ resourceTypes:
|
|
2943
2943
|
}
|
2944
2944
|
schema: |
|
2945
2945
|
{
|
2946
|
-
|
2947
|
-
|
2948
|
-
|
2949
|
-
|
2950
|
-
|
2951
|
-
|
2952
|
-
|
2953
|
-
|
2954
|
-
|
2955
|
-
|
2956
|
-
|
2957
|
-
|
2958
|
-
|
2959
|
-
|
2960
|
-
|
2961
|
-
|
2962
|
-
|
2963
|
-
|
2964
|
-
|
2965
|
-
|
2966
|
-
|
2967
|
-
|
2968
|
-
|
2969
|
-
|
2970
|
-
|
2971
|
-
|
2972
|
-
|
2973
|
-
|
2974
|
-
|
2975
|
-
|
2976
|
-
|
2977
|
-
|
2978
|
-
|
2979
|
-
|
2980
|
-
|
2981
|
-
|
2982
|
-
|
2983
|
-
|
2984
|
-
|
2985
|
-
|
2986
|
-
|
2987
|
-
|
2988
|
-
|
2989
|
-
|
2990
|
-
|
2991
|
-
|
2992
|
-
|
2993
|
-
|
2994
|
-
|
2995
|
-
|
2996
|
-
|
2997
|
-
|
2998
|
-
|
2999
|
-
|
3000
|
-
|
3001
|
-
|
3002
|
-
|
3003
|
-
|
3004
|
-
|
3005
|
-
|
3006
|
-
|
3007
|
-
|
3008
|
-
|
3009
|
-
|
3010
|
-
|
3011
|
-
|
3012
|
-
|
3013
|
-
|
3014
|
-
|
3015
|
-
|
3016
|
-
|
3017
|
-
|
3018
|
-
|
3019
|
-
|
3020
|
-
|
3021
|
-
|
3022
|
-
|
3023
|
-
|
3024
|
-
|
3025
|
-
|
3026
|
-
|
3027
|
-
|
3028
|
-
|
3029
|
-
|
3030
|
-
|
3031
|
-
|
3032
|
-
|
3033
|
-
|
3034
|
-
|
3035
|
-
|
3036
|
-
|
3037
|
-
|
3038
|
-
|
3039
|
-
|
3040
|
-
|
3041
|
-
|
3042
|
-
|
3043
|
-
|
3044
|
-
|
3045
|
-
|
3046
|
-
|
3047
|
-
|
3048
|
-
|
2946
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
2947
|
+
"type": "object" ,
|
2948
|
+
"properties": {
|
2949
|
+
"type": {
|
2950
|
+
"description": "For users is 'user'.",
|
2951
|
+
"type": "string"
|
2952
|
+
},
|
2953
|
+
"id": {
|
2954
|
+
"description": "A unique string identifying this user.",
|
2955
|
+
"type": "string"
|
2956
|
+
},
|
2957
|
+
"name": {
|
2958
|
+
"description": "The name of this user.",
|
2959
|
+
"type": "string"
|
2960
|
+
},
|
2961
|
+
"login": {
|
2962
|
+
"description": "The email address this user uses to login.",
|
2963
|
+
"type": "string"
|
2964
|
+
},
|
2965
|
+
"created_at": {
|
2966
|
+
"description": "The time this user was created.",
|
2967
|
+
"type": "timestamp"
|
2968
|
+
},
|
2969
|
+
"modified_at": {
|
2970
|
+
"description": "The time this user was last modified.",
|
2971
|
+
"type": "timestamp"
|
2972
|
+
},
|
2973
|
+
"role": {
|
2974
|
+
"description": "This user'''s enterprise role.",
|
2975
|
+
"enum": [ "admin", "coadmin", "user" ]
|
2976
|
+
},
|
2977
|
+
"language": {
|
2978
|
+
"description": "The language of this user. ISO 639-1 Language Code.",
|
2979
|
+
"type": "string"
|
2980
|
+
},
|
2981
|
+
"space_amount": {
|
2982
|
+
"description": "The user'''s total available space amount in bytes.",
|
2983
|
+
"type": "integer"
|
2984
|
+
},
|
2985
|
+
"space_used": {
|
2986
|
+
"description": "The amount of space in use by the user.",
|
2987
|
+
"type": "integer"
|
2988
|
+
},
|
2989
|
+
"max_upload_size": {
|
2990
|
+
"description": "The maximum individual file size in bytes this user can have.",
|
2991
|
+
"type": "integer"
|
2992
|
+
},
|
2993
|
+
"tracking_codes": {
|
2994
|
+
"description": "An array of key/value pairs set by the user'''s admin.",
|
2995
|
+
"type": "array"
|
2996
|
+
},
|
2997
|
+
"can_see_managed_users": {
|
2998
|
+
"description": "Whether this user can see other enterprise users in its contact list.",
|
2999
|
+
"type": "boolean"
|
3000
|
+
},
|
3001
|
+
"is_sync_enabled": {
|
3002
|
+
"description": "Whether or not this user can use Box Sync",
|
3003
|
+
"type": "boolean"
|
3004
|
+
},
|
3005
|
+
"status": {
|
3006
|
+
"description": "Can be active or inactive.",
|
3007
|
+
"enum": [ "actibe", "inactive" ]
|
3008
|
+
},
|
3009
|
+
"job_title": {
|
3010
|
+
"description": "The user'''s job title.",
|
3011
|
+
"type": "string"
|
3012
|
+
},
|
3013
|
+
"phone": {
|
3014
|
+
"description": "The user'''s phone number.",
|
3015
|
+
"type": "string"
|
3016
|
+
},
|
3017
|
+
"address": {
|
3018
|
+
"description": "The user'''s address.",
|
3019
|
+
"type": "string"
|
3020
|
+
},
|
3021
|
+
"avatar_url": {
|
3022
|
+
"description": "URL of this user'''s avatar image.",
|
3023
|
+
"type": "string"
|
3024
|
+
},
|
3025
|
+
"is_exempt_from_device_limits": {
|
3026
|
+
"description": "Whether to exempt this user from Enterprise device limits.",
|
3027
|
+
"type": "boolean"
|
3028
|
+
},
|
3029
|
+
"is_exempt_from_login_verification": {
|
3030
|
+
"description": "Whether or not this user must use two-factor authentication.",
|
3031
|
+
"type": "boolean"
|
3032
|
+
},
|
3033
|
+
"enterprise": {
|
3034
|
+
"properties": {
|
3035
|
+
"type": {
|
3036
|
+
"type": "string"
|
3037
|
+
},
|
3038
|
+
"id": {
|
3039
|
+
"type": "string"
|
3040
|
+
},
|
3041
|
+
"name": {
|
3042
|
+
"type": "string"
|
3043
|
+
}
|
3044
|
+
},
|
3045
|
+
"description": "Mini representation of this user'''s enterprise, including the ID of its enterprise",
|
3046
|
+
"type": "object"
|
3047
|
+
}
|
3048
|
+
}
|
3049
3049
|
}
|
3050
3050
|
/{userId}:
|
3051
3051
|
type: base
|
@@ -3070,71 +3070,71 @@ resourceTypes:
|
|
3070
3070
|
body:
|
3071
3071
|
schema: |
|
3072
3072
|
{
|
3073
|
-
|
3074
|
-
|
3075
|
-
|
3076
|
-
|
3077
|
-
|
3078
|
-
|
3079
|
-
|
3080
|
-
|
3081
|
-
|
3082
|
-
|
3083
|
-
|
3084
|
-
|
3085
|
-
|
3086
|
-
|
3087
|
-
|
3088
|
-
|
3089
|
-
|
3090
|
-
|
3091
|
-
|
3092
|
-
|
3093
|
-
|
3094
|
-
|
3095
|
-
|
3096
|
-
|
3097
|
-
|
3098
|
-
|
3099
|
-
|
3100
|
-
|
3101
|
-
|
3102
|
-
|
3103
|
-
|
3104
|
-
|
3105
|
-
|
3106
|
-
|
3107
|
-
|
3108
|
-
|
3109
|
-
|
3110
|
-
|
3111
|
-
|
3112
|
-
|
3113
|
-
|
3114
|
-
|
3115
|
-
|
3116
|
-
|
3117
|
-
|
3118
|
-
|
3119
|
-
|
3120
|
-
|
3121
|
-
|
3122
|
-
|
3123
|
-
|
3124
|
-
|
3125
|
-
|
3126
|
-
|
3127
|
-
|
3128
|
-
|
3129
|
-
|
3130
|
-
|
3131
|
-
|
3132
|
-
|
3133
|
-
|
3134
|
-
|
3135
|
-
|
3136
|
-
|
3137
|
-
|
3073
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3074
|
+
"type": "object" ,
|
3075
|
+
"properties": {
|
3076
|
+
"enterprise": {
|
3077
|
+
"description": "Setting this to 'null' will roll the user out of the enterprise and make them a free user.",
|
3078
|
+
"type": "string"
|
3079
|
+
},
|
3080
|
+
"name": {
|
3081
|
+
"description": "The name of this user.",
|
3082
|
+
"type": "string"
|
3083
|
+
},
|
3084
|
+
"role": {
|
3085
|
+
"description": "This user'''s enterprise role. Can be 'coadmin' or 'user'.",
|
3086
|
+
"type": [ "coadmin", "user" ]
|
3087
|
+
},
|
3088
|
+
"language": {
|
3089
|
+
"description": "The language of this user. ISO 639-1 Language Code.",
|
3090
|
+
"type": "string",
|
3091
|
+
"maxLength": 2
|
3092
|
+
},
|
3093
|
+
"is_sync_enabled": {
|
3094
|
+
"description": "Whether or not this user can use Box Sync.",
|
3095
|
+
"type": "boolean"
|
3096
|
+
},
|
3097
|
+
"job_title": {
|
3098
|
+
"description": "The user'''s job title.",
|
3099
|
+
"type": "string"
|
3100
|
+
},
|
3101
|
+
"phone": {
|
3102
|
+
"description": "The user'''s phone number.",
|
3103
|
+
"type": "string"
|
3104
|
+
},
|
3105
|
+
"address": {
|
3106
|
+
"description": "The user'''s address.",
|
3107
|
+
"type": "string"
|
3108
|
+
},
|
3109
|
+
"space_amount": {
|
3110
|
+
"description": "The user'''s total available space amount in byte. A value of '-1' grants unlimited storage.",
|
3111
|
+
"type": "number"
|
3112
|
+
},
|
3113
|
+
"tracking_codes": {
|
3114
|
+
"description": "An array of key/value pairs set by the user'''s admin.",
|
3115
|
+
"type": "array"
|
3116
|
+
},
|
3117
|
+
"can_see_managed_users": {
|
3118
|
+
"description": "Whether this user can see other enterprise users in its contact list.",
|
3119
|
+
"type": "boolean"
|
3120
|
+
},
|
3121
|
+
"status": {
|
3122
|
+
"description": "Can be 'active' or 'inactive'.",
|
3123
|
+
"type": [ "active", "inactive" ]
|
3124
|
+
},
|
3125
|
+
"is_exempt_from_device_limits": {
|
3126
|
+
"description": "Whether to exempt this user from Enterprise device limits.",
|
3127
|
+
"type": "boolean"
|
3128
|
+
},
|
3129
|
+
"is_exempt_from_login_verification": {
|
3130
|
+
"description": "Whether or not this user must use two-factor authentication.",
|
3131
|
+
"type": "boolean"
|
3132
|
+
},
|
3133
|
+
"is_password_reset_required": {
|
3134
|
+
"description": "Whether or not the user is required to reset password.",
|
3135
|
+
"type": "boolean"
|
3136
|
+
}
|
3137
|
+
}
|
3138
3138
|
}
|
3139
3139
|
responses:
|
3140
3140
|
200:
|
@@ -3165,109 +3165,109 @@ resourceTypes:
|
|
3165
3165
|
}
|
3166
3166
|
schema: |
|
3167
3167
|
{
|
3168
|
-
|
3169
|
-
|
3170
|
-
|
3171
|
-
|
3172
|
-
|
3173
|
-
|
3174
|
-
|
3175
|
-
|
3176
|
-
|
3177
|
-
|
3178
|
-
|
3179
|
-
|
3180
|
-
|
3181
|
-
|
3182
|
-
|
3183
|
-
|
3184
|
-
|
3185
|
-
|
3186
|
-
|
3187
|
-
|
3188
|
-
|
3189
|
-
|
3190
|
-
|
3191
|
-
|
3192
|
-
|
3193
|
-
|
3194
|
-
|
3195
|
-
|
3196
|
-
|
3197
|
-
|
3198
|
-
|
3199
|
-
|
3200
|
-
|
3201
|
-
|
3202
|
-
|
3203
|
-
|
3204
|
-
|
3205
|
-
|
3206
|
-
|
3207
|
-
|
3208
|
-
|
3209
|
-
|
3210
|
-
|
3211
|
-
|
3212
|
-
|
3213
|
-
|
3214
|
-
|
3215
|
-
|
3216
|
-
|
3217
|
-
|
3218
|
-
|
3219
|
-
|
3220
|
-
|
3221
|
-
|
3222
|
-
|
3223
|
-
|
3224
|
-
|
3225
|
-
|
3226
|
-
|
3227
|
-
|
3228
|
-
|
3229
|
-
|
3230
|
-
|
3231
|
-
|
3232
|
-
|
3233
|
-
|
3234
|
-
|
3235
|
-
|
3236
|
-
|
3237
|
-
|
3238
|
-
|
3239
|
-
|
3240
|
-
|
3241
|
-
|
3242
|
-
|
3243
|
-
|
3244
|
-
|
3245
|
-
|
3246
|
-
|
3247
|
-
|
3248
|
-
|
3249
|
-
|
3250
|
-
|
3251
|
-
|
3252
|
-
|
3253
|
-
|
3254
|
-
|
3255
|
-
|
3256
|
-
|
3257
|
-
|
3258
|
-
|
3259
|
-
|
3260
|
-
|
3261
|
-
|
3262
|
-
|
3263
|
-
|
3264
|
-
|
3265
|
-
|
3266
|
-
|
3267
|
-
|
3268
|
-
|
3269
|
-
|
3270
|
-
|
3168
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3169
|
+
"type": "object" ,
|
3170
|
+
"properties": {
|
3171
|
+
"type": {
|
3172
|
+
"description": "For users is 'user'.",
|
3173
|
+
"type": "string"
|
3174
|
+
},
|
3175
|
+
"id": {
|
3176
|
+
"description": "A unique string identifying this user.",
|
3177
|
+
"type": "string"
|
3178
|
+
},
|
3179
|
+
"name": {
|
3180
|
+
"description": "The name of this user.",
|
3181
|
+
"type": "string"
|
3182
|
+
},
|
3183
|
+
"login": {
|
3184
|
+
"description": "The email address this user uses to login.",
|
3185
|
+
"type": "string"
|
3186
|
+
},
|
3187
|
+
"created_at": {
|
3188
|
+
"description": "The time this user was created.",
|
3189
|
+
"type": "timestamp"
|
3190
|
+
},
|
3191
|
+
"modified_at": {
|
3192
|
+
"description": "The time this user was last modified.",
|
3193
|
+
"type": "timestamp"
|
3194
|
+
},
|
3195
|
+
"role": {
|
3196
|
+
"description": "This user'''s enterprise role.",
|
3197
|
+
"enum": [ "admin", "coadmin", "user" ]
|
3198
|
+
},
|
3199
|
+
"language": {
|
3200
|
+
"description": "The language of this user. ISO 639-1 Language Code.",
|
3201
|
+
"type": "string"
|
3202
|
+
},
|
3203
|
+
"space_amount": {
|
3204
|
+
"description": "The user'''s total available space amount in bytes.",
|
3205
|
+
"type": "integer"
|
3206
|
+
},
|
3207
|
+
"space_used": {
|
3208
|
+
"description": "The amount of space in use by the user.",
|
3209
|
+
"type": "integer"
|
3210
|
+
},
|
3211
|
+
"max_upload_size": {
|
3212
|
+
"description": "The maximum individual file size in bytes this user can have.",
|
3213
|
+
"type": "integer"
|
3214
|
+
},
|
3215
|
+
"tracking_codes": {
|
3216
|
+
"description": "An array of key/value pairs set by the user'''s admin.",
|
3217
|
+
"type": "array"
|
3218
|
+
},
|
3219
|
+
"can_see_managed_users": {
|
3220
|
+
"description": "Whether this user can see other enterprise users in its contact list.",
|
3221
|
+
"type": "boolean"
|
3222
|
+
},
|
3223
|
+
"is_sync_enabled": {
|
3224
|
+
"description": "Whether or not this user can use Box Sync",
|
3225
|
+
"type": "boolean"
|
3226
|
+
},
|
3227
|
+
"status": {
|
3228
|
+
"description": "Can be active or inactive.",
|
3229
|
+
"enum": [ "actibe", "inactive" ]
|
3230
|
+
},
|
3231
|
+
"job_title": {
|
3232
|
+
"description": "The user'''s job title.",
|
3233
|
+
"type": "string"
|
3234
|
+
},
|
3235
|
+
"phone": {
|
3236
|
+
"description": "The user'''s phone number.",
|
3237
|
+
"type": "string"
|
3238
|
+
},
|
3239
|
+
"address": {
|
3240
|
+
"description": "The user'''s address.",
|
3241
|
+
"type": "string"
|
3242
|
+
},
|
3243
|
+
"avatar_url": {
|
3244
|
+
"description": "URL of this user'''s avatar image.",
|
3245
|
+
"type": "string"
|
3246
|
+
},
|
3247
|
+
"is_exempt_from_device_limits": {
|
3248
|
+
"description": "Whether to exempt this user from Enterprise device limits.",
|
3249
|
+
"type": "boolean"
|
3250
|
+
},
|
3251
|
+
"is_exempt_from_login_verification": {
|
3252
|
+
"description": "Whether or not this user must use two-factor authentication.",
|
3253
|
+
"type": "boolean"
|
3254
|
+
},
|
3255
|
+
"enterprise": {
|
3256
|
+
"properties": {
|
3257
|
+
"type": {
|
3258
|
+
"type": "string"
|
3259
|
+
},
|
3260
|
+
"id": {
|
3261
|
+
"type": "string"
|
3262
|
+
},
|
3263
|
+
"name": {
|
3264
|
+
"type": "string"
|
3265
|
+
}
|
3266
|
+
},
|
3267
|
+
"description": "Mini representation of this user'''s enterprise, including the ID of its enterprise",
|
3268
|
+
"type": "object"
|
3269
|
+
}
|
3270
|
+
}
|
3271
3271
|
}
|
3272
3272
|
delete:
|
3273
3273
|
description: |
|
@@ -3311,20 +3311,20 @@ resourceTypes:
|
|
3311
3311
|
body:
|
3312
3312
|
schema: |
|
3313
3313
|
{
|
3314
|
-
|
3315
|
-
|
3316
|
-
|
3317
|
-
|
3318
|
-
|
3319
|
-
|
3314
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3315
|
+
"type": "object" ,
|
3316
|
+
"properties": {
|
3317
|
+
"owned_by": {
|
3318
|
+
"description": "The user who the folder will be transferred to.",
|
3319
|
+
"type": "string",
|
3320
3320
|
"required": true
|
3321
|
-
|
3322
|
-
|
3323
|
-
|
3324
|
-
|
3321
|
+
},
|
3322
|
+
"id": {
|
3323
|
+
"description": "The ID of the user who the folder will be transferred to.",
|
3324
|
+
"type": "string",
|
3325
3325
|
"required": true
|
3326
|
-
|
3327
|
-
|
3326
|
+
}
|
3327
|
+
}
|
3328
3328
|
}
|
3329
3329
|
responses:
|
3330
3330
|
200:
|
@@ -3451,15 +3451,15 @@ resourceTypes:
|
|
3451
3451
|
body:
|
3452
3452
|
schema: |
|
3453
3453
|
{
|
3454
|
-
|
3455
|
-
|
3456
|
-
|
3457
|
-
|
3458
|
-
|
3459
|
-
|
3454
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3455
|
+
"type": "object" ,
|
3456
|
+
"properties": {
|
3457
|
+
"email": {
|
3458
|
+
"description": "The email address to add to the account as an alias.",
|
3459
|
+
"type": "string",
|
3460
3460
|
"required": true
|
3461
|
-
|
3462
|
-
|
3461
|
+
}
|
3462
|
+
}
|
3463
3463
|
}
|
3464
3464
|
responses:
|
3465
3465
|
201:
|
@@ -3473,22 +3473,22 @@ resourceTypes:
|
|
3473
3473
|
}
|
3474
3474
|
schema: |
|
3475
3475
|
{
|
3476
|
-
|
3477
|
-
|
3478
|
-
|
3479
|
-
|
3480
|
-
|
3481
|
-
|
3482
|
-
|
3483
|
-
|
3484
|
-
|
3485
|
-
|
3486
|
-
|
3487
|
-
|
3488
|
-
|
3489
|
-
|
3490
|
-
|
3491
|
-
|
3476
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3477
|
+
"type": "object" ,
|
3478
|
+
"properties": {
|
3479
|
+
"type": {
|
3480
|
+
"type": "string"
|
3481
|
+
},
|
3482
|
+
"id": {
|
3483
|
+
"type": "string"
|
3484
|
+
},
|
3485
|
+
"is_confirmed": {
|
3486
|
+
"type": "boolean"
|
3487
|
+
},
|
3488
|
+
"email": {
|
3489
|
+
"type": "string"
|
3490
|
+
}
|
3491
|
+
}
|
3492
3492
|
}
|
3493
3493
|
/{emailAliasId}:
|
3494
3494
|
type: base
|
@@ -3509,38 +3509,38 @@ resourceTypes:
|
|
3509
3509
|
body:
|
3510
3510
|
schema: |
|
3511
3511
|
{
|
3512
|
-
|
3513
|
-
|
3514
|
-
|
3515
|
-
|
3516
|
-
|
3517
|
-
|
3512
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3513
|
+
"type": "object" ,
|
3514
|
+
"properties": {
|
3515
|
+
"item": {
|
3516
|
+
"description": "The item this task is for.",
|
3517
|
+
"type": "object",
|
3518
3518
|
"required": true
|
3519
|
-
|
3520
|
-
|
3521
|
-
|
3522
|
-
|
3519
|
+
},
|
3520
|
+
"type": {
|
3521
|
+
"description": "The type of the item this task is for (currently only 'file' is supported).",
|
3522
|
+
"type": "string",
|
3523
3523
|
"required": true
|
3524
|
-
|
3525
|
-
|
3526
|
-
|
3527
|
-
|
3524
|
+
},
|
3525
|
+
"id": {
|
3526
|
+
"description": "The ID of the item this task is for.",
|
3527
|
+
"type": "string",
|
3528
3528
|
"required": true
|
3529
|
-
|
3530
|
-
|
3531
|
-
|
3532
|
-
|
3529
|
+
},
|
3530
|
+
"action": {
|
3531
|
+
"description": "The action the task assignee will be prompted to do. Must be 'review'.",
|
3532
|
+
"type": [ "review" ],
|
3533
3533
|
"required": true
|
3534
|
-
|
3535
|
-
|
3536
|
-
|
3537
|
-
|
3538
|
-
|
3539
|
-
|
3540
|
-
|
3541
|
-
|
3542
|
-
|
3543
|
-
|
3534
|
+
},
|
3535
|
+
"message": {
|
3536
|
+
"description": "An optional message to include with the task.",
|
3537
|
+
"type": "string"
|
3538
|
+
},
|
3539
|
+
"due_at": {
|
3540
|
+
"description": "The day at which this task is due.",
|
3541
|
+
"type": "timestamp"
|
3542
|
+
}
|
3543
|
+
}
|
3544
3544
|
}
|
3545
3545
|
responses:
|
3546
3546
|
200:
|
@@ -3700,22 +3700,22 @@ resourceTypes:
|
|
3700
3700
|
body:
|
3701
3701
|
schema: |
|
3702
3702
|
{
|
3703
|
-
|
3704
|
-
|
3705
|
-
|
3706
|
-
|
3707
|
-
|
3708
|
-
|
3709
|
-
|
3710
|
-
|
3711
|
-
|
3712
|
-
|
3713
|
-
|
3714
|
-
|
3715
|
-
|
3716
|
-
|
3717
|
-
|
3718
|
-
|
3703
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3704
|
+
"type": "object" ,
|
3705
|
+
"properties": {
|
3706
|
+
"action": {
|
3707
|
+
"description": "The action the task assignee will be prompted to do. Can be 'review'.",
|
3708
|
+
"type": "string"
|
3709
|
+
},
|
3710
|
+
"message": {
|
3711
|
+
"description": "An optional message to include with the task.",
|
3712
|
+
"type": "string"
|
3713
|
+
},
|
3714
|
+
"due_at": {
|
3715
|
+
"description": "The day at which this task is due.",
|
3716
|
+
"type": "timestamp"
|
3717
|
+
}
|
3718
|
+
}
|
3719
3719
|
}
|
3720
3720
|
responses:
|
3721
3721
|
200:
|
@@ -3798,37 +3798,37 @@ resourceTypes:
|
|
3798
3798
|
body:
|
3799
3799
|
schema: |
|
3800
3800
|
{
|
3801
|
-
|
3802
|
-
|
3803
|
-
|
3804
|
-
|
3805
|
-
|
3806
|
-
|
3801
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3802
|
+
"type": "object" ,
|
3803
|
+
"properties": {
|
3804
|
+
"task": {
|
3805
|
+
"description": "The task this assignment is for.",
|
3806
|
+
"type": "object",
|
3807
3807
|
"required": true
|
3808
|
-
|
3809
|
-
|
3810
|
-
|
3811
|
-
|
3812
|
-
|
3813
|
-
|
3814
|
-
|
3815
|
-
|
3808
|
+
},
|
3809
|
+
"type": {
|
3810
|
+
"description": "Must be 'task'",
|
3811
|
+
"type": [ "task" ]
|
3812
|
+
},
|
3813
|
+
"id": {
|
3814
|
+
"description": "The ID of the task this assignment is for.",
|
3815
|
+
"type": "string",
|
3816
3816
|
"required": true
|
3817
|
-
|
3818
|
-
|
3819
|
-
|
3820
|
-
|
3817
|
+
},
|
3818
|
+
"assign_to": {
|
3819
|
+
"description": "The user this assignment is for. At least one of 'id' or 'login' is required in this object.",
|
3820
|
+
"type": "object",
|
3821
3821
|
"required": true
|
3822
|
-
|
3823
|
-
|
3824
|
-
|
3825
|
-
|
3826
|
-
|
3827
|
-
|
3828
|
-
|
3829
|
-
|
3830
|
-
|
3831
|
-
|
3822
|
+
},
|
3823
|
+
"id": {
|
3824
|
+
"description": "The ID of the user this assignment is for.",
|
3825
|
+
"type": "string"
|
3826
|
+
},
|
3827
|
+
"login": {
|
3828
|
+
"description": "The login email address for the user this assignment is for.",
|
3829
|
+
"type": "string"
|
3830
|
+
}
|
3831
|
+
}
|
3832
3832
|
}
|
3833
3833
|
responses:
|
3834
3834
|
200:
|
@@ -3865,88 +3865,88 @@ resourceTypes:
|
|
3865
3865
|
}
|
3866
3866
|
schema: |
|
3867
3867
|
{
|
3868
|
-
|
3869
|
-
|
3870
|
-
|
3871
|
-
|
3872
|
-
|
3873
|
-
|
3874
|
-
|
3875
|
-
|
3876
|
-
|
3877
|
-
|
3878
|
-
|
3879
|
-
|
3880
|
-
|
3881
|
-
|
3882
|
-
|
3883
|
-
|
3884
|
-
|
3885
|
-
|
3886
|
-
|
3887
|
-
|
3888
|
-
|
3889
|
-
|
3890
|
-
|
3891
|
-
|
3892
|
-
|
3893
|
-
|
3894
|
-
|
3895
|
-
|
3896
|
-
|
3897
|
-
|
3898
|
-
|
3899
|
-
|
3900
|
-
|
3901
|
-
|
3902
|
-
|
3903
|
-
|
3904
|
-
|
3905
|
-
|
3906
|
-
|
3907
|
-
|
3908
|
-
|
3909
|
-
|
3910
|
-
|
3911
|
-
|
3912
|
-
|
3913
|
-
|
3914
|
-
|
3915
|
-
|
3916
|
-
|
3917
|
-
|
3918
|
-
|
3919
|
-
|
3920
|
-
|
3921
|
-
|
3922
|
-
|
3923
|
-
|
3924
|
-
|
3925
|
-
|
3926
|
-
|
3927
|
-
|
3928
|
-
|
3929
|
-
|
3930
|
-
|
3931
|
-
|
3932
|
-
|
3933
|
-
|
3934
|
-
|
3935
|
-
|
3936
|
-
|
3937
|
-
|
3938
|
-
|
3939
|
-
|
3940
|
-
|
3941
|
-
|
3942
|
-
|
3943
|
-
|
3944
|
-
|
3945
|
-
|
3946
|
-
|
3947
|
-
|
3948
|
-
|
3949
|
-
|
3868
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3869
|
+
"type": "object" ,
|
3870
|
+
"properties": {
|
3871
|
+
"type": {
|
3872
|
+
"type": "string"
|
3873
|
+
},
|
3874
|
+
"id": {
|
3875
|
+
"type": "string"
|
3876
|
+
},
|
3877
|
+
"item": {
|
3878
|
+
"properties": {
|
3879
|
+
"type": {
|
3880
|
+
"type": "string"
|
3881
|
+
},
|
3882
|
+
"id": {
|
3883
|
+
"type": "string"
|
3884
|
+
},
|
3885
|
+
"sequence_id": {
|
3886
|
+
"type": "string"
|
3887
|
+
},
|
3888
|
+
"etag": {
|
3889
|
+
"type": "string"
|
3890
|
+
},
|
3891
|
+
"sha1": {
|
3892
|
+
"type": "string"
|
3893
|
+
},
|
3894
|
+
"name": {
|
3895
|
+
"type": "string"
|
3896
|
+
}
|
3897
|
+
},
|
3898
|
+
"type": "object"
|
3899
|
+
},
|
3900
|
+
"assigned_to": {
|
3901
|
+
"properties": {
|
3902
|
+
"type": {
|
3903
|
+
"type": "string"
|
3904
|
+
},
|
3905
|
+
"id": {
|
3906
|
+
"type": "string"
|
3907
|
+
},
|
3908
|
+
"name": {
|
3909
|
+
"type": "string"
|
3910
|
+
},
|
3911
|
+
"login": {
|
3912
|
+
"type": "string"
|
3913
|
+
}
|
3914
|
+
},
|
3915
|
+
"type": "object"
|
3916
|
+
},
|
3917
|
+
"message": {
|
3918
|
+
"type": "string"
|
3919
|
+
},
|
3920
|
+
"completed_at": {
|
3921
|
+
"type": "timestamp"
|
3922
|
+
},
|
3923
|
+
"assigned_at": {
|
3924
|
+
"type": "timestamp"
|
3925
|
+
},
|
3926
|
+
"reminded_at": {
|
3927
|
+
"type": "string"
|
3928
|
+
},
|
3929
|
+
"resolution_state": {
|
3930
|
+
"type": "string"
|
3931
|
+
},
|
3932
|
+
"assigned_by": {
|
3933
|
+
"properties": {
|
3934
|
+
"type": {
|
3935
|
+
"type": "string"
|
3936
|
+
},
|
3937
|
+
"id": {
|
3938
|
+
"type": "string"
|
3939
|
+
},
|
3940
|
+
"name": {
|
3941
|
+
"type": "string"
|
3942
|
+
},
|
3943
|
+
"login": {
|
3944
|
+
"type": "string"
|
3945
|
+
}
|
3946
|
+
},
|
3947
|
+
"type": "object"
|
3948
|
+
}
|
3949
|
+
}
|
3950
3950
|
}
|
3951
3951
|
/{id}:
|
3952
3952
|
type: base
|
@@ -3989,88 +3989,88 @@ resourceTypes:
|
|
3989
3989
|
}
|
3990
3990
|
schema: |
|
3991
3991
|
{
|
3992
|
-
|
3993
|
-
|
3994
|
-
|
3995
|
-
|
3996
|
-
|
3997
|
-
|
3998
|
-
|
3999
|
-
|
4000
|
-
|
4001
|
-
|
4002
|
-
|
4003
|
-
|
4004
|
-
|
4005
|
-
|
4006
|
-
|
4007
|
-
|
4008
|
-
|
4009
|
-
|
4010
|
-
|
4011
|
-
|
4012
|
-
|
4013
|
-
|
4014
|
-
|
4015
|
-
|
4016
|
-
|
4017
|
-
|
4018
|
-
|
4019
|
-
|
4020
|
-
|
4021
|
-
|
4022
|
-
|
4023
|
-
|
4024
|
-
|
4025
|
-
|
4026
|
-
|
4027
|
-
|
4028
|
-
|
4029
|
-
|
4030
|
-
|
4031
|
-
|
4032
|
-
|
4033
|
-
|
4034
|
-
|
4035
|
-
|
4036
|
-
|
4037
|
-
|
4038
|
-
|
4039
|
-
|
4040
|
-
|
4041
|
-
|
4042
|
-
|
4043
|
-
|
4044
|
-
|
4045
|
-
|
4046
|
-
|
4047
|
-
|
4048
|
-
|
4049
|
-
|
4050
|
-
|
4051
|
-
|
4052
|
-
|
4053
|
-
|
4054
|
-
|
4055
|
-
|
4056
|
-
|
4057
|
-
|
4058
|
-
|
4059
|
-
|
4060
|
-
|
4061
|
-
|
4062
|
-
|
4063
|
-
|
4064
|
-
|
4065
|
-
|
4066
|
-
|
4067
|
-
|
4068
|
-
|
4069
|
-
|
4070
|
-
|
4071
|
-
|
4072
|
-
|
4073
|
-
|
3992
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
3993
|
+
"type": "object" ,
|
3994
|
+
"properties": {
|
3995
|
+
"type": {
|
3996
|
+
"type": "string"
|
3997
|
+
},
|
3998
|
+
"id": {
|
3999
|
+
"type": "string"
|
4000
|
+
},
|
4001
|
+
"item": {
|
4002
|
+
"properties": {
|
4003
|
+
"type": {
|
4004
|
+
"type": "string"
|
4005
|
+
},
|
4006
|
+
"id": {
|
4007
|
+
"type": "string"
|
4008
|
+
},
|
4009
|
+
"sequence_id": {
|
4010
|
+
"type": "string"
|
4011
|
+
},
|
4012
|
+
"etag": {
|
4013
|
+
"type": "string"
|
4014
|
+
},
|
4015
|
+
"sha1": {
|
4016
|
+
"type": "string"
|
4017
|
+
},
|
4018
|
+
"name": {
|
4019
|
+
"type": "string"
|
4020
|
+
}
|
4021
|
+
},
|
4022
|
+
"type": "object"
|
4023
|
+
},
|
4024
|
+
"assigned_to": {
|
4025
|
+
"properties": {
|
4026
|
+
"type": {
|
4027
|
+
"type": "string"
|
4028
|
+
},
|
4029
|
+
"id": {
|
4030
|
+
"type": "string"
|
4031
|
+
},
|
4032
|
+
"name": {
|
4033
|
+
"type": "string"
|
4034
|
+
},
|
4035
|
+
"login": {
|
4036
|
+
"type": "string"
|
4037
|
+
}
|
4038
|
+
},
|
4039
|
+
"type": "object"
|
4040
|
+
},
|
4041
|
+
"message": {
|
4042
|
+
"type": "string"
|
4043
|
+
},
|
4044
|
+
"completed_at": {
|
4045
|
+
"type": "timestamp"
|
4046
|
+
},
|
4047
|
+
"assigned_at": {
|
4048
|
+
"type": "timestamp"
|
4049
|
+
},
|
4050
|
+
"reminded_at": {
|
4051
|
+
"type": "string"
|
4052
|
+
},
|
4053
|
+
"resolution_state": {
|
4054
|
+
"type": "string"
|
4055
|
+
},
|
4056
|
+
"assigned_by": {
|
4057
|
+
"properties": {
|
4058
|
+
"type": {
|
4059
|
+
"type": "string"
|
4060
|
+
},
|
4061
|
+
"id": {
|
4062
|
+
"type": "string"
|
4063
|
+
},
|
4064
|
+
"name": {
|
4065
|
+
"type": "string"
|
4066
|
+
},
|
4067
|
+
"login": {
|
4068
|
+
"type": "string"
|
4069
|
+
}
|
4070
|
+
},
|
4071
|
+
"type": "object"
|
4072
|
+
}
|
4073
|
+
}
|
4074
4074
|
}
|
4075
4075
|
delete:
|
4076
4076
|
description: |
|
@@ -4086,23 +4086,23 @@ resourceTypes:
|
|
4086
4086
|
body:
|
4087
4087
|
schema: |
|
4088
4088
|
{
|
4089
|
-
|
4090
|
-
|
4091
|
-
|
4092
|
-
|
4093
|
-
|
4094
|
-
|
4095
|
-
|
4096
|
-
|
4097
|
-
|
4098
|
-
|
4099
|
-
|
4100
|
-
|
4101
|
-
|
4102
|
-
|
4103
|
-
|
4104
|
-
|
4105
|
-
|
4089
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
4090
|
+
"type": "object" ,
|
4091
|
+
"properties": {
|
4092
|
+
"message": {
|
4093
|
+
"description": "A message from the assignee about this task.",
|
4094
|
+
"type": "string"
|
4095
|
+
},
|
4096
|
+
"resolution_state": {
|
4097
|
+
"description": "Can be 'completed', 'incomplete', 'approved', or 'rejected'.",
|
4098
|
+
"type": [
|
4099
|
+
"completed",
|
4100
|
+
"incomplete",
|
4101
|
+
"approved",
|
4102
|
+
"rejected"
|
4103
|
+
]
|
4104
|
+
}
|
4105
|
+
}
|
4106
4106
|
}
|
4107
4107
|
responses:
|
4108
4108
|
200:
|
@@ -4139,86 +4139,86 @@ resourceTypes:
|
|
4139
4139
|
}
|
4140
4140
|
schema: |
|
4141
4141
|
{
|
4142
|
-
|
4143
|
-
|
4144
|
-
|
4145
|
-
|
4146
|
-
|
4147
|
-
|
4148
|
-
|
4149
|
-
|
4150
|
-
|
4151
|
-
|
4152
|
-
|
4153
|
-
|
4154
|
-
|
4155
|
-
|
4156
|
-
|
4157
|
-
|
4158
|
-
|
4159
|
-
|
4160
|
-
|
4161
|
-
|
4162
|
-
|
4163
|
-
|
4164
|
-
|
4165
|
-
|
4166
|
-
|
4167
|
-
|
4168
|
-
|
4169
|
-
|
4170
|
-
|
4171
|
-
|
4172
|
-
|
4173
|
-
|
4174
|
-
|
4175
|
-
|
4176
|
-
|
4177
|
-
|
4178
|
-
|
4179
|
-
|
4180
|
-
|
4181
|
-
|
4182
|
-
|
4183
|
-
|
4184
|
-
|
4185
|
-
|
4186
|
-
|
4187
|
-
|
4188
|
-
|
4189
|
-
|
4190
|
-
|
4191
|
-
|
4192
|
-
|
4193
|
-
|
4194
|
-
|
4195
|
-
|
4196
|
-
|
4197
|
-
|
4198
|
-
|
4199
|
-
|
4200
|
-
|
4201
|
-
|
4202
|
-
|
4203
|
-
|
4204
|
-
|
4205
|
-
|
4206
|
-
|
4207
|
-
|
4208
|
-
|
4209
|
-
|
4210
|
-
|
4211
|
-
|
4212
|
-
|
4213
|
-
|
4214
|
-
|
4215
|
-
|
4216
|
-
|
4217
|
-
|
4218
|
-
|
4219
|
-
|
4220
|
-
|
4221
|
-
|
4222
|
-
|
4223
|
-
|
4142
|
+
"$schema": "http://json-schema.org/draft-03/schema",
|
4143
|
+
"type": "object" ,
|
4144
|
+
"properties": {
|
4145
|
+
"type": {
|
4146
|
+
"type": "string"
|
4147
|
+
},
|
4148
|
+
"id": {
|
4149
|
+
"type": "string"
|
4150
|
+
},
|
4151
|
+
"item": {
|
4152
|
+
"properties": {
|
4153
|
+
"type": {
|
4154
|
+
"type": "string"
|
4155
|
+
},
|
4156
|
+
"id": {
|
4157
|
+
"type": "string"
|
4158
|
+
},
|
4159
|
+
"sequence_id": {
|
4160
|
+
"type": "string"
|
4161
|
+
},
|
4162
|
+
"etag": {
|
4163
|
+
"type": "string"
|
4164
|
+
},
|
4165
|
+
"sha1": {
|
4166
|
+
"type": "string"
|
4167
|
+
},
|
4168
|
+
"name": {
|
4169
|
+
"type": "string"
|
4170
|
+
}
|
4171
|
+
},
|
4172
|
+
"type": "object"
|
4173
|
+
},
|
4174
|
+
"assigned_to": {
|
4175
|
+
"properties": {
|
4176
|
+
"type": {
|
4177
|
+
"type": "string"
|
4178
|
+
},
|
4179
|
+
"id": {
|
4180
|
+
"type": "string"
|
4181
|
+
},
|
4182
|
+
"name": {
|
4183
|
+
"type": "string"
|
4184
|
+
},
|
4185
|
+
"login": {
|
4186
|
+
"type": "string"
|
4187
|
+
}
|
4188
|
+
},
|
4189
|
+
"type": "object"
|
4190
|
+
},
|
4191
|
+
"message": {
|
4192
|
+
"type": "string"
|
4193
|
+
},
|
4194
|
+
"completed_at": {
|
4195
|
+
"type": "timestamp"
|
4196
|
+
},
|
4197
|
+
"assigned_at": {
|
4198
|
+
"type": "timestamp"
|
4199
|
+
},
|
4200
|
+
"reminded_at": {
|
4201
|
+
"type": "string"
|
4202
|
+
},
|
4203
|
+
"resolution_state": {
|
4204
|
+
"type": "string"
|
4205
|
+
},
|
4206
|
+
"assigned_by": {
|
4207
|
+
"properties": {
|
4208
|
+
"type": {
|
4209
|
+
"type": "string"
|
4210
|
+
},
|
4211
|
+
"id": {
|
4212
|
+
"type": "string"
|
4213
|
+
},
|
4214
|
+
"name": {
|
4215
|
+
"type": "string"
|
4216
|
+
},
|
4217
|
+
"login": {
|
4218
|
+
"type": "string"
|
4219
|
+
}
|
4220
|
+
},
|
4221
|
+
"type": "object"
|
4222
|
+
}
|
4223
|
+
}
|
4224
4224
|
}
|