blueprint_ruby_client 0.5.2 → 0.5.3

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 5fe7bdb24acb8e8a338f7f0a477fd0b987b100ba
4
- data.tar.gz: dfd2b5ee16931be16d7884ddb5ed1c25b91df76e
3
+ metadata.gz: cae5fd8293fbf977218f123f1eba948f86aabe1d
4
+ data.tar.gz: 6c34d8cd923e376caadf74b3f3c22263000ced95
5
5
  SHA512:
6
- metadata.gz: 483c43af5f79233afa97f7aa4a599a0e265d275ba8f5a7d164190b924556d21d973a47d0b378f7b39972ac32c12089798921cdc665d40d81b1f366e263359372
7
- data.tar.gz: 0f6570c1316b001e36613dc42799dda49b1bb2a272921650b128deec785d3afe2192d3701a267a95db1bdd6a7b4988f27085b3da954590197fe62b51273745ff
6
+ metadata.gz: 0dc170f6077cae862957023528800b43cefd2daec63f414c561dd1406e25336cf4669604e68fd63e9e3f2a03777344daf24733766c1eca07978fc910b53d74ee
7
+ data.tar.gz: 01e33c3ac6d8a2ce4a4a5875f0c36806d8e2241acc4c24c12535e762f948ef7bad811b5e02293c24fdec02c9497ef50fe8a642d6d0d56e68fb1be8d6f7f27320
data/README.md CHANGED
@@ -8,7 +8,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
8
8
 
9
9
  - API version: 1.0.0
10
10
  - Package version: 0.5.2
11
- - Build date: 2017-01-06T16:19:57.389-05:00
11
+ - Build date: 2017-03-29T15:28:48.629+01:00
12
12
  - Build package: class io.swagger.codegen.languages.RubyClientCodegen
13
13
 
14
14
  ## Installation
@@ -73,7 +73,7 @@ end
73
73
 
74
74
  api_instance = BlueprintClient::AssetTypeConfigsApi.new
75
75
 
76
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
76
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
77
77
 
78
78
  asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
79
79
 
data/config.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "gemName": "blueprint_ruby_client",
3
3
  "moduleName": "BlueprintClient",
4
- "gemVersion": "0.5.2",
4
+ "gemVersion": "0.5.3",
5
5
  "gemLicense": "Copyright Talis Education Ltd",
6
6
  "gemHomepage": "https://github.com/talis/blueprint_rb",
7
7
  "gemSummary": "A ruby API wrapper for Blueprint",
@@ -26,7 +26,7 @@ end
26
26
 
27
27
  api_instance = BlueprintClient::AssetTypeConfigsApi.new
28
28
 
29
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
29
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
30
30
 
31
31
  asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
32
32
 
@@ -43,7 +43,7 @@ end
43
43
 
44
44
  Name | Type | Description | Notes
45
45
  ------------- | ------------- | ------------- | -------------
46
- **namespace** | **String**| identifier namespacing the blueprint. |
46
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
47
47
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
48
48
 
49
49
  ### Return type
@@ -28,7 +28,7 @@ end
28
28
 
29
29
  api_instance = BlueprintClient::AssetTypeTemplatesApi.new
30
30
 
31
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
31
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
32
32
 
33
33
  asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
34
34
 
@@ -47,7 +47,7 @@ end
47
47
 
48
48
  Name | Type | Description | Notes
49
49
  ------------- | ------------- | ------------- | -------------
50
- **namespace** | **String**| identifier namespacing the blueprint. |
50
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
51
51
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
52
52
  **template_body** | [**TemplateBody**](TemplateBody.md)| template body |
53
53
 
@@ -85,7 +85,7 @@ end
85
85
 
86
86
  api_instance = BlueprintClient::AssetTypeTemplatesApi.new
87
87
 
88
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
88
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
89
89
 
90
90
  asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
91
91
 
@@ -102,7 +102,7 @@ end
102
102
 
103
103
  Name | Type | Description | Notes
104
104
  ------------- | ------------- | ------------- | -------------
105
- **namespace** | **String**| identifier namespacing the blueprint. |
105
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
106
106
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
107
107
 
108
108
  ### Return type
@@ -139,7 +139,7 @@ end
139
139
 
140
140
  api_instance = BlueprintClient::AssetTypeTemplatesApi.new
141
141
 
142
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
142
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
143
143
 
144
144
  asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
145
145
 
@@ -158,7 +158,7 @@ end
158
158
 
159
159
  Name | Type | Description | Notes
160
160
  ------------- | ------------- | ------------- | -------------
161
- **namespace** | **String**| identifier namespacing the blueprint. |
161
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
162
162
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
163
163
  **template_body** | [**TemplateBody**](TemplateBody.md)| template body |
164
164
 
data/docs/AssetsApi.md CHANGED
@@ -32,7 +32,7 @@ end
32
32
 
33
33
  api_instance = BlueprintClient::AssetsApi.new
34
34
 
35
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
35
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
36
36
 
37
37
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
38
38
 
@@ -55,7 +55,7 @@ end
55
55
 
56
56
  Name | Type | Description | Notes
57
57
  ------------- | ------------- | ------------- | -------------
58
- **namespace** | **String**| identifier namespacing the blueprint. |
58
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
59
59
  **type** | **String**| subtype of Node, e.g. 'modules', 'departments', etc. |
60
60
  **id** | **String**| id identifying a domain model |
61
61
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
@@ -95,7 +95,7 @@ end
95
95
 
96
96
  api_instance = BlueprintClient::AssetsApi.new
97
97
 
98
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
98
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
99
99
 
100
100
  asset_id = "asset_id_example" # String | id of an asset
101
101
 
@@ -113,7 +113,7 @@ end
113
113
 
114
114
  Name | Type | Description | Notes
115
115
  ------------- | ------------- | ------------- | -------------
116
- **namespace** | **String**| identifier namespacing the blueprint. |
116
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
117
117
  **asset_id** | **String**| id of an asset |
118
118
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
119
119
 
@@ -151,7 +151,7 @@ end
151
151
 
152
152
  api_instance = BlueprintClient::AssetsApi.new
153
153
 
154
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
154
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
155
155
 
156
156
  asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
157
157
 
@@ -171,7 +171,7 @@ end
171
171
 
172
172
  Name | Type | Description | Notes
173
173
  ------------- | ------------- | ------------- | -------------
174
- **namespace** | **String**| identifier namespacing the blueprint. |
174
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
175
175
  **asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
176
176
  **asset_id** | **String**| id of an asset |
177
177
 
@@ -209,14 +209,14 @@ end
209
209
 
210
210
  api_instance = BlueprintClient::AssetsApi.new
211
211
 
212
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
212
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
213
213
 
214
214
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
215
215
 
216
216
  id = "id_example" # String | id identifying a domain model
217
217
 
218
218
  opts = {
219
- filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return
219
+ filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
220
220
  offset: 3.4, # Float | index to start result set from
221
221
  limit: 3.4 # Float | number of records to return
222
222
  }
@@ -233,10 +233,10 @@ end
233
233
 
234
234
  Name | Type | Description | Notes
235
235
  ------------- | ------------- | ------------- | -------------
236
- **namespace** | **String**| identifier namespacing the blueprint. |
236
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
237
237
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
238
238
  **id** | **String**| id identifying a domain model |
239
- **filter_asset_type** | [**Array&lt;String&gt;**](String.md)| type of asset to return | [optional]
239
+ **filter_asset_type** | [**Array&lt;String&gt;**](String.md)| type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2 | [optional]
240
240
  **offset** | [**Float**](.md)| index to start result set from | [optional]
241
241
  **limit** | [**Float**](.md)| number of records to return | [optional]
242
242
 
@@ -274,7 +274,7 @@ end
274
274
 
275
275
  api_instance = BlueprintClient::AssetsApi.new
276
276
 
277
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
277
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
278
278
 
279
279
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
280
280
 
@@ -296,7 +296,7 @@ end
296
296
 
297
297
  Name | Type | Description | Notes
298
298
  ------------- | ------------- | ------------- | -------------
299
- **namespace** | **String**| identifier namespacing the blueprint. |
299
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
300
300
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
301
301
  **id** | **String**| id identifying a domain model |
302
302
  **asset_type** | **String**| subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc. |
@@ -336,7 +336,7 @@ end
336
336
 
337
337
  api_instance = BlueprintClient::AssetsApi.new
338
338
 
339
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
339
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
340
340
 
341
341
  asset_id = "asset_id_example" # String | id of an asset
342
342
 
@@ -359,7 +359,7 @@ end
359
359
 
360
360
  Name | Type | Description | Notes
361
361
  ------------- | ------------- | ------------- | -------------
362
- **namespace** | **String**| identifier namespacing the blueprint. |
362
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
363
363
  **asset_id** | **String**| id of an asset |
364
364
  **asset_type** | **String**| subtype of Asset, e.g. &#39;textbooks&#39;, &#39;digitisations&#39;, etc. |
365
365
  **body** | [**AssetBody**](AssetBody.md)| asset | [optional]
@@ -398,14 +398,14 @@ end
398
398
 
399
399
  api_instance = BlueprintClient::AssetsApi.new
400
400
 
401
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
401
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
402
402
 
403
403
  opts = {
404
404
  offset: 3.4, # Float | index to start result set from
405
405
  limit: 3.4 # Float | number of records to return
406
406
  include: ["include_example"] # Array<String> | comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets
407
407
  filter_node: ["filter_node_example"], # Array<String> | limit to assets that are related to a node matching type/code
408
- filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return
408
+ filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
409
409
  }
410
410
 
411
411
  begin
@@ -421,12 +421,12 @@ end
421
421
 
422
422
  Name | Type | Description | Notes
423
423
  ------------- | ------------- | ------------- | -------------
424
- **namespace** | **String**| identifier namespacing the blueprint. |
424
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
425
425
  **offset** | [**Float**](.md)| index to start result set from | [optional]
426
426
  **limit** | [**Float**](.md)| number of records to return | [optional]
427
427
  **include** | [**Array&lt;String&gt;**](String.md)| comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets | [optional]
428
428
  **filter_node** | [**Array&lt;String&gt;**](String.md)| limit to assets that are related to a node matching type/code | [optional]
429
- **filter_asset_type** | [**Array&lt;String&gt;**](String.md)| type of asset to return | [optional]
429
+ **filter_asset_type** | [**Array&lt;String&gt;**](String.md)| type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2 | [optional]
430
430
 
431
431
  ### Return type
432
432
 
data/docs/HierarchyApi.md CHANGED
@@ -91,7 +91,7 @@ end
91
91
 
92
92
  api_instance = BlueprintClient::HierarchyApi.new
93
93
 
94
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
94
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
95
95
 
96
96
 
97
97
  begin
@@ -105,7 +105,7 @@ end
105
105
 
106
106
  Name | Type | Description | Notes
107
107
  ------------- | ------------- | ------------- | -------------
108
- **namespace** | **String**| identifier namespacing the blueprint. |
108
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
109
109
 
110
110
  ### Return type
111
111
 
@@ -141,7 +141,7 @@ end
141
141
 
142
142
  api_instance = BlueprintClient::HierarchyApi.new
143
143
 
144
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
144
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
145
145
 
146
146
  id = "id_example" # String | id identifying a domain model
147
147
 
@@ -159,7 +159,7 @@ end
159
159
 
160
160
  Name | Type | Description | Notes
161
161
  ------------- | ------------- | ------------- | -------------
162
- **namespace** | **String**| identifier namespacing the blueprint. |
162
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
163
163
  **id** | **String**| id identifying a domain model |
164
164
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
165
165
 
@@ -197,7 +197,7 @@ end
197
197
 
198
198
  api_instance = BlueprintClient::HierarchyApi.new
199
199
 
200
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
200
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
201
201
 
202
202
 
203
203
  begin
@@ -211,7 +211,7 @@ end
211
211
 
212
212
  Name | Type | Description | Notes
213
213
  ------------- | ------------- | ------------- | -------------
214
- **namespace** | **String**| identifier namespacing the blueprint. |
214
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
215
215
 
216
216
  ### Return type
217
217
 
@@ -249,7 +249,7 @@ api_instance = BlueprintClient::HierarchyApi.new
249
249
 
250
250
  id = "id_example" # String | id identifying a domain model
251
251
 
252
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
252
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
253
253
 
254
254
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
255
255
 
@@ -272,7 +272,7 @@ end
272
272
  Name | Type | Description | Notes
273
273
  ------------- | ------------- | ------------- | -------------
274
274
  **id** | **String**| id identifying a domain model |
275
- **namespace** | **String**| identifier namespacing the blueprint. |
275
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
276
276
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
277
277
  **offset** | [**Float**](.md)| index to start result set from | [optional]
278
278
  **limit** | [**Float**](.md)| number of records to return | [optional]
@@ -313,7 +313,7 @@ api_instance = BlueprintClient::HierarchyApi.new
313
313
 
314
314
  id = "id_example" # String | id identifying a domain model
315
315
 
316
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
316
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
317
317
 
318
318
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
319
319
 
@@ -336,7 +336,7 @@ end
336
336
  Name | Type | Description | Notes
337
337
  ------------- | ------------- | ------------- | -------------
338
338
  **id** | **String**| id identifying a domain model |
339
- **namespace** | **String**| identifier namespacing the blueprint. |
339
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
340
340
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
341
341
  **offset** | [**Float**](.md)| index to start result set from | [optional]
342
342
  **limit** | [**Float**](.md)| number of records to return | [optional]
@@ -377,7 +377,7 @@ api_instance = BlueprintClient::HierarchyApi.new
377
377
 
378
378
  id = "id_example" # String | id identifying a domain model
379
379
 
380
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
380
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
381
381
 
382
382
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
383
383
 
@@ -400,7 +400,7 @@ end
400
400
  Name | Type | Description | Notes
401
401
  ------------- | ------------- | ------------- | -------------
402
402
  **id** | **String**| id identifying a domain model |
403
- **namespace** | **String**| identifier namespacing the blueprint. |
403
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
404
404
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
405
405
  **offset** | [**Float**](.md)| index to start result set from | [optional]
406
406
  **limit** | [**Float**](.md)| number of records to return | [optional]
@@ -439,7 +439,7 @@ end
439
439
 
440
440
  api_instance = BlueprintClient::HierarchyApi.new
441
441
 
442
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
442
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
443
443
 
444
444
  id = "id_example" # String | id identifying a domain model
445
445
 
@@ -462,7 +462,7 @@ end
462
462
 
463
463
  Name | Type | Description | Notes
464
464
  ------------- | ------------- | ------------- | -------------
465
- **namespace** | **String**| identifier namespacing the blueprint. |
465
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
466
466
  **id** | **String**| id identifying a domain model |
467
467
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
468
468
  **include** | [**Array&lt;String&gt;**](String.md)| comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets | [optional]
@@ -503,7 +503,7 @@ api_instance = BlueprintClient::HierarchyApi.new
503
503
 
504
504
  id = "id_example" # String | id identifying a domain model
505
505
 
506
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
506
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
507
507
 
508
508
  type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.
509
509
 
@@ -526,7 +526,7 @@ end
526
526
  Name | Type | Description | Notes
527
527
  ------------- | ------------- | ------------- | -------------
528
528
  **id** | **String**| id identifying a domain model |
529
- **namespace** | **String**| identifier namespacing the blueprint. |
529
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
530
530
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
531
531
  **offset** | [**Float**](.md)| index to start result set from | [optional]
532
532
  **limit** | [**Float**](.md)| number of records to return | [optional]
@@ -565,7 +565,7 @@ end
565
565
 
566
566
  api_instance = BlueprintClient::HierarchyApi.new
567
567
 
568
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
568
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
569
569
 
570
570
  id = "id_example" # String | id identifying a domain model
571
571
 
@@ -587,7 +587,7 @@ end
587
587
 
588
588
  Name | Type | Description | Notes
589
589
  ------------- | ------------- | ------------- | -------------
590
- **namespace** | **String**| identifier namespacing the blueprint. |
590
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
591
591
  **id** | **String**| id identifying a domain model |
592
592
  **body** | [**NodeBody**](NodeBody.md)| node |
593
593
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |
@@ -612,7 +612,7 @@ Name | Type | Description | Notes
612
612
 
613
613
  Search nodes
614
614
 
615
- This endpoint is a really flexible way to ask questions about the hierarchy.\nThe includes parameter can be set to either parents, children, assets.\n\nExamples:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Modules`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101`\n\n###### Find all nodes that are descendants of DEP101 or DEP102:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101,departments%2Fdep102`\n\n###### Find all nodes that are descendants of DEP101 and DEP102:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101&filter[descendant]=departments%2Fdep102``\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments` # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists`\n\n###### Find all nodes of type modules during 2015 that have no assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[from]=20150101&filter[to]=20151231`\n\n###### Find all nodes of type modules with assets which are also related to DEP101.\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=true&filter[assetNode]=departments%2Fdep101`\n
615
+ This endpoint is a really flexible way to ask questions about the hierarchy.\nThe includes parameter can be set to either parents, children, assets.\n\nExamples:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Modules`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101`\n\n###### Find all nodes that are descendants of DEP101 or DEP102:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101,departments%2Fdep102`\n\n###### Find all nodes that are descendants of DEP101 and DEP102:\n`/1/abc/nodes?filter[descendant]=departments%2Fdep101&filter[descendant]=departments%2Fdep102``\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments` # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists`\n\n###### Find all nodes of type modules during 2015 that have no assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[from]=20150101&filter[to]=20151231`\n\n###### Find all nodes of type modules with assets which are also related to DEP101.\n`/1/global/nodes?filter[nodeType]=Modules&filter[asset.node]=departments%2Fdep101`\n
616
616
 
617
617
  ### Example
618
618
  ```ruby
@@ -639,7 +639,8 @@ opts = {
639
639
  filter_ancestor: ["filter_ancestor_example"], # Array<String> | limit to nodes with ancestor matching type/code
640
640
  filter_descendant: ["filter_descendant_example"], # Array<String> | limit to nodes with descendant matching type/code
641
641
  filter_has_assets: true, # BOOLEAN | limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets
642
- filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return
642
+ filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
643
+ filter_asset_type2: ["filter_asset_type_example"], # Array<String> | type of asset to return. Version 2. This filters the results by asset type, but returns all the assets associated with the result.
643
644
  filter_from: Date.parse("2013-10-20"), # Date | limit to results valid after this date, format is ISO8601 date
644
645
  filter_to: Date.parse("2013-10-20"), # Date | limit to results valid before this date, format is ISO8601
645
646
  q_node: "q_node_example", # String | query term(s) to search for nodes. Allows wildcard searching with '*'
@@ -674,7 +675,8 @@ Name | Type | Description | Notes
674
675
  **filter_ancestor** | [**Array&lt;String&gt;**](String.md)| limit to nodes with ancestor matching type/code | [optional]
675
676
  **filter_descendant** | [**Array&lt;String&gt;**](String.md)| limit to nodes with descendant matching type/code | [optional]
676
677
  **filter_has_assets** | **BOOLEAN**| limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets | [optional]
677
- **filter_asset_type** | [**Array&lt;String&gt;**](String.md)| type of asset to return | [optional]
678
+ **filter_asset_type** | [**Array&lt;String&gt;**](String.md)| type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2 | [optional]
679
+ **filter_asset_type2** | [**Array&lt;String&gt;**](String.md)| type of asset to return. Version 2. This filters the results by asset type, but returns all the assets associated with the result. | [optional]
678
680
  **filter_from** | **Date**| limit to results valid after this date, format is ISO8601 date | [optional]
679
681
  **filter_to** | **Date**| limit to results valid before this date, format is ISO8601 | [optional]
680
682
  **q_node** | **String**| query term(s) to search for nodes. Allows wildcard searching with &#39;*&#39; | [optional]
@@ -718,7 +720,7 @@ end
718
720
 
719
721
  api_instance = BlueprintClient::HierarchyApi.new
720
722
 
721
- namespace = "namespace_example" # String | identifier namespacing the blueprint.
723
+ namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
722
724
 
723
725
  id = "id_example" # String | id identifying a domain model
724
726
 
@@ -739,7 +741,7 @@ end
739
741
 
740
742
  Name | Type | Description | Notes
741
743
  ------------- | ------------- | ------------- | -------------
742
- **namespace** | **String**| identifier namespacing the blueprint. |
744
+ **namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
743
745
  **id** | **String**| id identifying a domain model |
744
746
  **body** | [**NodeBody**](NodeBody.md)| node |
745
747
  **type** | **String**| subtype of Node, e.g. &#39;modules&#39;, &#39;departments&#39;, etc. |