osdn-client 0.0.20160304 → 0.0.20160711
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +201 -0
- data/README.md +182 -0
- data/docs/DefaultApi.md +115 -0
- data/docs/Group.md +23 -0
- data/docs/GroupToolFlags.md +17 -0
- data/docs/News.md +14 -0
- data/docs/Package.md +13 -0
- data/docs/Pong.md +11 -0
- data/docs/ProjectApi.md +1511 -0
- data/docs/ProjectFrsApi.md +888 -0
- data/docs/ProjectNewsApi.md +576 -0
- data/docs/RelFile.md +19 -0
- data/docs/Release.md +16 -0
- data/docs/SimpleChamber.md +11 -0
- data/docs/SimpleGroup.md +11 -0
- data/docs/SimpleUser.md +10 -0
- data/docs/Skill.md +11 -0
- data/docs/Token.md +12 -0
- data/docs/User.md +20 -0
- data/docs/UserApi.md +63 -0
- data/lib/osdn-client.rb +32 -9
- data/lib/osdn-client/api/default_api.rb +50 -39
- data/lib/osdn-client/api/project_api.rb +661 -773
- data/lib/osdn-client/api/project_frs_api.rb +350 -412
- data/lib/osdn-client/api/project_news_api.rb +217 -244
- data/lib/osdn-client/api/user_api.rb +35 -20
- data/lib/osdn-client/api_client.rb +74 -13
- data/lib/osdn-client/api_error.rb +23 -0
- data/lib/osdn-client/configuration.rb +45 -1
- data/lib/osdn-client/models/group.rb +103 -65
- data/lib/osdn-client/models/group_tool_flags.rb +91 -47
- data/lib/osdn-client/models/news.rb +85 -38
- data/lib/osdn-client/models/package.rb +83 -35
- data/lib/osdn-client/models/pong.rb +79 -29
- data/lib/osdn-client/models/rel_file.rb +95 -53
- data/lib/osdn-client/models/release.rb +89 -44
- data/lib/osdn-client/models/simple_chamber.rb +79 -29
- data/lib/osdn-client/models/simple_group.rb +79 -29
- data/lib/osdn-client/models/simple_user.rb +77 -26
- data/lib/osdn-client/models/skill.rb +79 -29
- data/lib/osdn-client/models/token.rb +81 -32
- data/lib/osdn-client/models/user.rb +97 -56
- data/lib/osdn-client/version.rb +24 -1
- data/osdn-client.gemspec +30 -7
- data/spec/api/default_api_spec.rb +73 -0
- data/spec/api/{ProjectApi_spec.rb → project_api_spec.rb} +187 -264
- data/spec/api/{ProjectFrsApi_spec.rb → project_frs_api_spec.rb} +103 -136
- data/spec/api/{ProjectNewsApi_spec.rb → project_news_api_spec.rb} +71 -88
- data/spec/api/user_api_spec.rb +58 -0
- data/spec/api_client_spec.rb +315 -0
- data/spec/configuration_spec.rb +48 -0
- data/spec/models/group_spec.rb +143 -0
- data/spec/models/group_tool_flags_spec.rb +107 -0
- data/spec/models/news_spec.rb +89 -0
- data/spec/models/package_spec.rb +83 -0
- data/spec/models/pong_spec.rb +71 -0
- data/spec/models/rel_file_spec.rb +119 -0
- data/spec/models/release_spec.rb +101 -0
- data/spec/models/simple_chamber_spec.rb +71 -0
- data/spec/models/simple_group_spec.rb +71 -0
- data/spec/models/simple_user_spec.rb +65 -0
- data/spec/models/skill_spec.rb +71 -0
- data/spec/models/token_spec.rb +77 -0
- data/spec/models/user_spec.rb +125 -0
- data/spec/spec_helper.rb +122 -0
- metadata +87 -59
- data/spec/api/DefaultApi_spec.rb +0 -58
- data/spec/api/UserApi_spec.rb +0 -39
- data/spec/models/GroupToolFlags_spec.rb +0 -124
- data/spec/models/Group_spec.rb +0 -184
- data/spec/models/News_spec.rb +0 -94
- data/spec/models/Package_spec.rb +0 -84
- data/spec/models/Pong_spec.rb +0 -64
- data/spec/models/RelFile_spec.rb +0 -144
- data/spec/models/Release_spec.rb +0 -114
- data/spec/models/SimpleChamber_spec.rb +0 -64
- data/spec/models/SimpleGroup_spec.rb +0 -64
- data/spec/models/SimpleUser_spec.rb +0 -54
- data/spec/models/Skill_spec.rb +0 -64
- data/spec/models/Token_spec.rb +0 -74
- data/spec/models/User_spec.rb +0 -154
@@ -0,0 +1,888 @@
|
|
1
|
+
# OSDNClient::ProjectFrsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://osdn.jp/api/v0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create_package**](ProjectFrsApi.md#create_package) | **POST** /project/{id_or_name}/frs |
|
8
|
+
[**create_release**](ProjectFrsApi.md#create_release) | **POST** /project/{id_or_name}/frs/{package_id} |
|
9
|
+
[**create_release_file**](ProjectFrsApi.md#create_release_file) | **POST** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
10
|
+
[**delete_package**](ProjectFrsApi.md#delete_package) | **DELETE** /project/{id_or_name}/frs/{package_id} |
|
11
|
+
[**delete_release**](ProjectFrsApi.md#delete_release) | **DELETE** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
12
|
+
[**delete_release_file**](ProjectFrsApi.md#delete_release_file) | **DELETE** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
13
|
+
[**draft_release**](ProjectFrsApi.md#draft_release) | **GET** /project/{id_or_name}/frs/{package_id}/draft |
|
14
|
+
[**get_package**](ProjectFrsApi.md#get_package) | **GET** /project/{id_or_name}/frs/{package_id} |
|
15
|
+
[**get_release**](ProjectFrsApi.md#get_release) | **GET** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
16
|
+
[**get_release_file**](ProjectFrsApi.md#get_release_file) | **GET** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
17
|
+
[**list_packages**](ProjectFrsApi.md#list_packages) | **GET** /project/{id_or_name}/frs |
|
18
|
+
[**update_package**](ProjectFrsApi.md#update_package) | **PATCH** /project/{id_or_name}/frs/{package_id} |
|
19
|
+
[**update_release**](ProjectFrsApi.md#update_release) | **PATCH** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
20
|
+
[**update_release_file**](ProjectFrsApi.md#update_release_file) | **PATCH** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
21
|
+
|
22
|
+
|
23
|
+
# **create_package**
|
24
|
+
> Package create_package(id_or_name, name, opts)
|
25
|
+
|
26
|
+
|
27
|
+
|
28
|
+
Create a package.
|
29
|
+
|
30
|
+
### Example
|
31
|
+
```ruby
|
32
|
+
# load the gem
|
33
|
+
require 'osdn-client'
|
34
|
+
# setup authorization
|
35
|
+
OSDNClient.configure do |config|
|
36
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
37
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
38
|
+
|
39
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
40
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
41
|
+
end
|
42
|
+
|
43
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
44
|
+
|
45
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
46
|
+
|
47
|
+
name = "name_example" # String | package name
|
48
|
+
|
49
|
+
opts = {
|
50
|
+
visibility: "visibility_example" # String | visibility status (public, hidden or private)
|
51
|
+
}
|
52
|
+
|
53
|
+
begin
|
54
|
+
result = api_instance.create_package(id_or_name, name, opts)
|
55
|
+
p result
|
56
|
+
rescue OSDNClient::ApiError => e
|
57
|
+
puts "Exception when calling ProjectFrsApi->create_package: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
Name | Type | Description | Notes
|
64
|
+
------------- | ------------- | ------------- | -------------
|
65
|
+
**id_or_name** | **String**| numeric project id or project name |
|
66
|
+
**name** | **String**| package name |
|
67
|
+
**visibility** | **String**| visibility status (public, hidden or private) | [optional]
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**Package**](Package.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
80
|
+
- **Accept**: Not defined
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
# **create_release**
|
85
|
+
> Release create_release(id_or_name, package_id, name, opts)
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
Create new release in specified package.
|
90
|
+
|
91
|
+
### Example
|
92
|
+
```ruby
|
93
|
+
# load the gem
|
94
|
+
require 'osdn-client'
|
95
|
+
# setup authorization
|
96
|
+
OSDNClient.configure do |config|
|
97
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
98
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
99
|
+
|
100
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
101
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
102
|
+
end
|
103
|
+
|
104
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
105
|
+
|
106
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
107
|
+
|
108
|
+
package_id = 56 # Integer |
|
109
|
+
|
110
|
+
name = "name_example" # String | Release name
|
111
|
+
|
112
|
+
opts = {
|
113
|
+
visibility: "visibility_example", # String | visibility status (public, hidden or private)
|
114
|
+
time: "time_example", # String | Release datetime. If you set future time, the release hide until specified time.
|
115
|
+
release_note: "release_note_example", # String | Release note body text.
|
116
|
+
change_log: "change_log_example" # String | Changelog body text.
|
117
|
+
}
|
118
|
+
|
119
|
+
begin
|
120
|
+
result = api_instance.create_release(id_or_name, package_id, name, opts)
|
121
|
+
p result
|
122
|
+
rescue OSDNClient::ApiError => e
|
123
|
+
puts "Exception when calling ProjectFrsApi->create_release: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
Name | Type | Description | Notes
|
130
|
+
------------- | ------------- | ------------- | -------------
|
131
|
+
**id_or_name** | **String**| numeric project id or project name |
|
132
|
+
**package_id** | **Integer**| |
|
133
|
+
**name** | **String**| Release name |
|
134
|
+
**visibility** | **String**| visibility status (public, hidden or private) | [optional]
|
135
|
+
**time** | **String**| Release datetime. If you set future time, the release hide until specified time. | [optional]
|
136
|
+
**release_note** | **String**| Release note body text. | [optional]
|
137
|
+
**change_log** | **String**| Changelog body text. | [optional]
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
[**Release**](Release.md)
|
142
|
+
|
143
|
+
### Authorization
|
144
|
+
|
145
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
146
|
+
|
147
|
+
### HTTP request headers
|
148
|
+
|
149
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
150
|
+
- **Accept**: Not defined
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
# **create_release_file**
|
155
|
+
> RelFile create_release_file(id_or_name, package_id, release_id, file, opts)
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
Create new file in target release.
|
160
|
+
|
161
|
+
### Example
|
162
|
+
```ruby
|
163
|
+
# load the gem
|
164
|
+
require 'osdn-client'
|
165
|
+
# setup authorization
|
166
|
+
OSDNClient.configure do |config|
|
167
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
168
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
169
|
+
|
170
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
171
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
172
|
+
end
|
173
|
+
|
174
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
175
|
+
|
176
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
177
|
+
|
178
|
+
package_id = 56 # Integer |
|
179
|
+
|
180
|
+
release_id = 56 # Integer |
|
181
|
+
|
182
|
+
file = File.new("/path/to/file.txt") # File | Upload file in \"multipart/form-data\".
|
183
|
+
|
184
|
+
opts = {
|
185
|
+
visibility: "visibility_example" # String | visibility status (public, hidden or private)
|
186
|
+
}
|
187
|
+
|
188
|
+
begin
|
189
|
+
result = api_instance.create_release_file(id_or_name, package_id, release_id, file, opts)
|
190
|
+
p result
|
191
|
+
rescue OSDNClient::ApiError => e
|
192
|
+
puts "Exception when calling ProjectFrsApi->create_release_file: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
Name | Type | Description | Notes
|
199
|
+
------------- | ------------- | ------------- | -------------
|
200
|
+
**id_or_name** | **String**| numeric project id or project name |
|
201
|
+
**package_id** | **Integer**| |
|
202
|
+
**release_id** | **Integer**| |
|
203
|
+
**file** | **File**| Upload file in \"multipart/form-data\". |
|
204
|
+
**visibility** | **String**| visibility status (public, hidden or private) | [optional]
|
205
|
+
|
206
|
+
### Return type
|
207
|
+
|
208
|
+
[**RelFile**](RelFile.md)
|
209
|
+
|
210
|
+
### Authorization
|
211
|
+
|
212
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
213
|
+
|
214
|
+
### HTTP request headers
|
215
|
+
|
216
|
+
- **Content-Type**: multipart/form-data
|
217
|
+
- **Accept**: Not defined
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
# **delete_package**
|
222
|
+
> delete_package(id_or_name, package_id)
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
Delete taret package.
|
227
|
+
|
228
|
+
### Example
|
229
|
+
```ruby
|
230
|
+
# load the gem
|
231
|
+
require 'osdn-client'
|
232
|
+
# setup authorization
|
233
|
+
OSDNClient.configure do |config|
|
234
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
235
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
236
|
+
|
237
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
238
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
239
|
+
end
|
240
|
+
|
241
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
242
|
+
|
243
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
244
|
+
|
245
|
+
package_id = 56 # Integer |
|
246
|
+
|
247
|
+
|
248
|
+
begin
|
249
|
+
api_instance.delete_package(id_or_name, package_id)
|
250
|
+
rescue OSDNClient::ApiError => e
|
251
|
+
puts "Exception when calling ProjectFrsApi->delete_package: #{e}"
|
252
|
+
end
|
253
|
+
```
|
254
|
+
|
255
|
+
### Parameters
|
256
|
+
|
257
|
+
Name | Type | Description | Notes
|
258
|
+
------------- | ------------- | ------------- | -------------
|
259
|
+
**id_or_name** | **String**| numeric project id or project name |
|
260
|
+
**package_id** | **Integer**| |
|
261
|
+
|
262
|
+
### Return type
|
263
|
+
|
264
|
+
nil (empty response body)
|
265
|
+
|
266
|
+
### Authorization
|
267
|
+
|
268
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
269
|
+
|
270
|
+
### HTTP request headers
|
271
|
+
|
272
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
273
|
+
- **Accept**: Not defined
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
# **delete_release**
|
278
|
+
> delete_release(id_or_name, package_id, release_id)
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
Delete target release.
|
283
|
+
|
284
|
+
### Example
|
285
|
+
```ruby
|
286
|
+
# load the gem
|
287
|
+
require 'osdn-client'
|
288
|
+
# setup authorization
|
289
|
+
OSDNClient.configure do |config|
|
290
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
291
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
292
|
+
|
293
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
294
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
295
|
+
end
|
296
|
+
|
297
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
298
|
+
|
299
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
300
|
+
|
301
|
+
package_id = 56 # Integer |
|
302
|
+
|
303
|
+
release_id = 56 # Integer |
|
304
|
+
|
305
|
+
|
306
|
+
begin
|
307
|
+
api_instance.delete_release(id_or_name, package_id, release_id)
|
308
|
+
rescue OSDNClient::ApiError => e
|
309
|
+
puts "Exception when calling ProjectFrsApi->delete_release: #{e}"
|
310
|
+
end
|
311
|
+
```
|
312
|
+
|
313
|
+
### Parameters
|
314
|
+
|
315
|
+
Name | Type | Description | Notes
|
316
|
+
------------- | ------------- | ------------- | -------------
|
317
|
+
**id_or_name** | **String**| numeric project id or project name |
|
318
|
+
**package_id** | **Integer**| |
|
319
|
+
**release_id** | **Integer**| |
|
320
|
+
|
321
|
+
### Return type
|
322
|
+
|
323
|
+
nil (empty response body)
|
324
|
+
|
325
|
+
### Authorization
|
326
|
+
|
327
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
328
|
+
|
329
|
+
### HTTP request headers
|
330
|
+
|
331
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
332
|
+
- **Accept**: Not defined
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
# **delete_release_file**
|
337
|
+
> delete_release_file(id_or_name, package_id, release_id, file_id)
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
Delete target file.
|
342
|
+
|
343
|
+
### Example
|
344
|
+
```ruby
|
345
|
+
# load the gem
|
346
|
+
require 'osdn-client'
|
347
|
+
# setup authorization
|
348
|
+
OSDNClient.configure do |config|
|
349
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
350
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
351
|
+
|
352
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
353
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
354
|
+
end
|
355
|
+
|
356
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
357
|
+
|
358
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
359
|
+
|
360
|
+
package_id = 56 # Integer |
|
361
|
+
|
362
|
+
release_id = 56 # Integer |
|
363
|
+
|
364
|
+
file_id = 56 # Integer |
|
365
|
+
|
366
|
+
|
367
|
+
begin
|
368
|
+
api_instance.delete_release_file(id_or_name, package_id, release_id, file_id)
|
369
|
+
rescue OSDNClient::ApiError => e
|
370
|
+
puts "Exception when calling ProjectFrsApi->delete_release_file: #{e}"
|
371
|
+
end
|
372
|
+
```
|
373
|
+
|
374
|
+
### Parameters
|
375
|
+
|
376
|
+
Name | Type | Description | Notes
|
377
|
+
------------- | ------------- | ------------- | -------------
|
378
|
+
**id_or_name** | **String**| numeric project id or project name |
|
379
|
+
**package_id** | **Integer**| |
|
380
|
+
**release_id** | **Integer**| |
|
381
|
+
**file_id** | **Integer**| |
|
382
|
+
|
383
|
+
### Return type
|
384
|
+
|
385
|
+
nil (empty response body)
|
386
|
+
|
387
|
+
### Authorization
|
388
|
+
|
389
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
390
|
+
|
391
|
+
### HTTP request headers
|
392
|
+
|
393
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
394
|
+
- **Accept**: Not defined
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
# **draft_release**
|
399
|
+
> Release draft_release(id_or_name, package_id)
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
Get release draft in specified package. If draft is not exist, it will be created automatically.
|
404
|
+
|
405
|
+
### Example
|
406
|
+
```ruby
|
407
|
+
# load the gem
|
408
|
+
require 'osdn-client'
|
409
|
+
# setup authorization
|
410
|
+
OSDNClient.configure do |config|
|
411
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
412
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
413
|
+
|
414
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
415
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
416
|
+
end
|
417
|
+
|
418
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
419
|
+
|
420
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
421
|
+
|
422
|
+
package_id = 56 # Integer |
|
423
|
+
|
424
|
+
|
425
|
+
begin
|
426
|
+
result = api_instance.draft_release(id_or_name, package_id)
|
427
|
+
p result
|
428
|
+
rescue OSDNClient::ApiError => e
|
429
|
+
puts "Exception when calling ProjectFrsApi->draft_release: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
Name | Type | Description | Notes
|
436
|
+
------------- | ------------- | ------------- | -------------
|
437
|
+
**id_or_name** | **String**| numeric project id or project name |
|
438
|
+
**package_id** | **Integer**| |
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**Release**](Release.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
451
|
+
- **Accept**: Not defined
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
# **get_package**
|
456
|
+
> Package get_package(id_or_name, package_id)
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
Get specified package info and release list of the package.
|
461
|
+
|
462
|
+
### Example
|
463
|
+
```ruby
|
464
|
+
# load the gem
|
465
|
+
require 'osdn-client'
|
466
|
+
# setup authorization
|
467
|
+
OSDNClient.configure do |config|
|
468
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
469
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
470
|
+
|
471
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
472
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
473
|
+
end
|
474
|
+
|
475
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
476
|
+
|
477
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
478
|
+
|
479
|
+
package_id = 56 # Integer |
|
480
|
+
|
481
|
+
|
482
|
+
begin
|
483
|
+
result = api_instance.get_package(id_or_name, package_id)
|
484
|
+
p result
|
485
|
+
rescue OSDNClient::ApiError => e
|
486
|
+
puts "Exception when calling ProjectFrsApi->get_package: #{e}"
|
487
|
+
end
|
488
|
+
```
|
489
|
+
|
490
|
+
### Parameters
|
491
|
+
|
492
|
+
Name | Type | Description | Notes
|
493
|
+
------------- | ------------- | ------------- | -------------
|
494
|
+
**id_or_name** | **String**| numeric project id or project name |
|
495
|
+
**package_id** | **Integer**| |
|
496
|
+
|
497
|
+
### Return type
|
498
|
+
|
499
|
+
[**Package**](Package.md)
|
500
|
+
|
501
|
+
### Authorization
|
502
|
+
|
503
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
504
|
+
|
505
|
+
### HTTP request headers
|
506
|
+
|
507
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
508
|
+
- **Accept**: Not defined
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
# **get_release**
|
513
|
+
> Release get_release(id_or_name, package_id, release_id)
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
Get specified release info and file list of the release.
|
518
|
+
|
519
|
+
### Example
|
520
|
+
```ruby
|
521
|
+
# load the gem
|
522
|
+
require 'osdn-client'
|
523
|
+
# setup authorization
|
524
|
+
OSDNClient.configure do |config|
|
525
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
526
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
527
|
+
|
528
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
529
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
530
|
+
end
|
531
|
+
|
532
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
533
|
+
|
534
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
535
|
+
|
536
|
+
package_id = 56 # Integer |
|
537
|
+
|
538
|
+
release_id = 56 # Integer |
|
539
|
+
|
540
|
+
|
541
|
+
begin
|
542
|
+
result = api_instance.get_release(id_or_name, package_id, release_id)
|
543
|
+
p result
|
544
|
+
rescue OSDNClient::ApiError => e
|
545
|
+
puts "Exception when calling ProjectFrsApi->get_release: #{e}"
|
546
|
+
end
|
547
|
+
```
|
548
|
+
|
549
|
+
### Parameters
|
550
|
+
|
551
|
+
Name | Type | Description | Notes
|
552
|
+
------------- | ------------- | ------------- | -------------
|
553
|
+
**id_or_name** | **String**| numeric project id or project name |
|
554
|
+
**package_id** | **Integer**| |
|
555
|
+
**release_id** | **Integer**| |
|
556
|
+
|
557
|
+
### Return type
|
558
|
+
|
559
|
+
[**Release**](Release.md)
|
560
|
+
|
561
|
+
### Authorization
|
562
|
+
|
563
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
564
|
+
|
565
|
+
### HTTP request headers
|
566
|
+
|
567
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
568
|
+
- **Accept**: Not defined
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
# **get_release_file**
|
573
|
+
> RelFile get_release_file(id_or_name, package_id, release_id, file_id)
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
Get single file object.
|
578
|
+
|
579
|
+
### Example
|
580
|
+
```ruby
|
581
|
+
# load the gem
|
582
|
+
require 'osdn-client'
|
583
|
+
# setup authorization
|
584
|
+
OSDNClient.configure do |config|
|
585
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
586
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
587
|
+
|
588
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
589
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
590
|
+
end
|
591
|
+
|
592
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
593
|
+
|
594
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
595
|
+
|
596
|
+
package_id = 56 # Integer |
|
597
|
+
|
598
|
+
release_id = 56 # Integer |
|
599
|
+
|
600
|
+
file_id = 56 # Integer |
|
601
|
+
|
602
|
+
|
603
|
+
begin
|
604
|
+
result = api_instance.get_release_file(id_or_name, package_id, release_id, file_id)
|
605
|
+
p result
|
606
|
+
rescue OSDNClient::ApiError => e
|
607
|
+
puts "Exception when calling ProjectFrsApi->get_release_file: #{e}"
|
608
|
+
end
|
609
|
+
```
|
610
|
+
|
611
|
+
### Parameters
|
612
|
+
|
613
|
+
Name | Type | Description | Notes
|
614
|
+
------------- | ------------- | ------------- | -------------
|
615
|
+
**id_or_name** | **String**| numeric project id or project name |
|
616
|
+
**package_id** | **Integer**| |
|
617
|
+
**release_id** | **Integer**| |
|
618
|
+
**file_id** | **Integer**| |
|
619
|
+
|
620
|
+
### Return type
|
621
|
+
|
622
|
+
[**RelFile**](RelFile.md)
|
623
|
+
|
624
|
+
### Authorization
|
625
|
+
|
626
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
627
|
+
|
628
|
+
### HTTP request headers
|
629
|
+
|
630
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
631
|
+
- **Accept**: Not defined
|
632
|
+
|
633
|
+
|
634
|
+
|
635
|
+
# **list_packages**
|
636
|
+
> Array<Package> list_packages(id_or_name)
|
637
|
+
|
638
|
+
|
639
|
+
|
640
|
+
Get package list of specified project.
|
641
|
+
|
642
|
+
### Example
|
643
|
+
```ruby
|
644
|
+
# load the gem
|
645
|
+
require 'osdn-client'
|
646
|
+
# setup authorization
|
647
|
+
OSDNClient.configure do |config|
|
648
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
649
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
650
|
+
|
651
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
652
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
653
|
+
end
|
654
|
+
|
655
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
656
|
+
|
657
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
658
|
+
|
659
|
+
|
660
|
+
begin
|
661
|
+
result = api_instance.list_packages(id_or_name)
|
662
|
+
p result
|
663
|
+
rescue OSDNClient::ApiError => e
|
664
|
+
puts "Exception when calling ProjectFrsApi->list_packages: #{e}"
|
665
|
+
end
|
666
|
+
```
|
667
|
+
|
668
|
+
### Parameters
|
669
|
+
|
670
|
+
Name | Type | Description | Notes
|
671
|
+
------------- | ------------- | ------------- | -------------
|
672
|
+
**id_or_name** | **String**| numeric project id or project name |
|
673
|
+
|
674
|
+
### Return type
|
675
|
+
|
676
|
+
[**Array<Package>**](Package.md)
|
677
|
+
|
678
|
+
### Authorization
|
679
|
+
|
680
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
681
|
+
|
682
|
+
### HTTP request headers
|
683
|
+
|
684
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
685
|
+
- **Accept**: Not defined
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
# **update_package**
|
690
|
+
> Package update_package(id_or_name, package_id, opts)
|
691
|
+
|
692
|
+
|
693
|
+
|
694
|
+
Update tagret package.
|
695
|
+
|
696
|
+
### Example
|
697
|
+
```ruby
|
698
|
+
# load the gem
|
699
|
+
require 'osdn-client'
|
700
|
+
# setup authorization
|
701
|
+
OSDNClient.configure do |config|
|
702
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
703
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
704
|
+
|
705
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
706
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
707
|
+
end
|
708
|
+
|
709
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
710
|
+
|
711
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
712
|
+
|
713
|
+
package_id = 56 # Integer |
|
714
|
+
|
715
|
+
opts = {
|
716
|
+
name: "name_example", # String | package name
|
717
|
+
visibility: "visibility_example" # String | visibility status (public, hidden or private)
|
718
|
+
}
|
719
|
+
|
720
|
+
begin
|
721
|
+
result = api_instance.update_package(id_or_name, package_id, opts)
|
722
|
+
p result
|
723
|
+
rescue OSDNClient::ApiError => e
|
724
|
+
puts "Exception when calling ProjectFrsApi->update_package: #{e}"
|
725
|
+
end
|
726
|
+
```
|
727
|
+
|
728
|
+
### Parameters
|
729
|
+
|
730
|
+
Name | Type | Description | Notes
|
731
|
+
------------- | ------------- | ------------- | -------------
|
732
|
+
**id_or_name** | **String**| numeric project id or project name |
|
733
|
+
**package_id** | **Integer**| |
|
734
|
+
**name** | **String**| package name | [optional]
|
735
|
+
**visibility** | **String**| visibility status (public, hidden or private) | [optional]
|
736
|
+
|
737
|
+
### Return type
|
738
|
+
|
739
|
+
[**Package**](Package.md)
|
740
|
+
|
741
|
+
### Authorization
|
742
|
+
|
743
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
744
|
+
|
745
|
+
### HTTP request headers
|
746
|
+
|
747
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
748
|
+
- **Accept**: Not defined
|
749
|
+
|
750
|
+
|
751
|
+
|
752
|
+
# **update_release**
|
753
|
+
> Release update_release(id_or_name, package_id, release_id, opts)
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
Update target release. (Note: If you update draft release, the release will be public automatically.)
|
758
|
+
|
759
|
+
### Example
|
760
|
+
```ruby
|
761
|
+
# load the gem
|
762
|
+
require 'osdn-client'
|
763
|
+
# setup authorization
|
764
|
+
OSDNClient.configure do |config|
|
765
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
766
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
767
|
+
|
768
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
769
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
770
|
+
end
|
771
|
+
|
772
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
773
|
+
|
774
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
775
|
+
|
776
|
+
package_id = 56 # Integer |
|
777
|
+
|
778
|
+
release_id = 56 # Integer |
|
779
|
+
|
780
|
+
opts = {
|
781
|
+
visibility: "visibility_example", # String | visibility status (public, hidden or private)
|
782
|
+
name: "name_example", # String | Release name
|
783
|
+
time: "time_example", # String | Release datetime. If you set future time, the release hide until specified time.
|
784
|
+
move_to_package_id: 56 # Integer | If this parameter is specified, the release move to another package.
|
785
|
+
}
|
786
|
+
|
787
|
+
begin
|
788
|
+
result = api_instance.update_release(id_or_name, package_id, release_id, opts)
|
789
|
+
p result
|
790
|
+
rescue OSDNClient::ApiError => e
|
791
|
+
puts "Exception when calling ProjectFrsApi->update_release: #{e}"
|
792
|
+
end
|
793
|
+
```
|
794
|
+
|
795
|
+
### Parameters
|
796
|
+
|
797
|
+
Name | Type | Description | Notes
|
798
|
+
------------- | ------------- | ------------- | -------------
|
799
|
+
**id_or_name** | **String**| numeric project id or project name |
|
800
|
+
**package_id** | **Integer**| |
|
801
|
+
**release_id** | **Integer**| |
|
802
|
+
**visibility** | **String**| visibility status (public, hidden or private) | [optional]
|
803
|
+
**name** | **String**| Release name | [optional]
|
804
|
+
**time** | **String**| Release datetime. If you set future time, the release hide until specified time. | [optional]
|
805
|
+
**move_to_package_id** | **Integer**| If this parameter is specified, the release move to another package. | [optional]
|
806
|
+
|
807
|
+
### Return type
|
808
|
+
|
809
|
+
[**Release**](Release.md)
|
810
|
+
|
811
|
+
### Authorization
|
812
|
+
|
813
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
814
|
+
|
815
|
+
### HTTP request headers
|
816
|
+
|
817
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
818
|
+
- **Accept**: Not defined
|
819
|
+
|
820
|
+
|
821
|
+
|
822
|
+
# **update_release_file**
|
823
|
+
> RelFile update_release_file(id_or_name, package_id, release_id, file_id, opts)
|
824
|
+
|
825
|
+
|
826
|
+
|
827
|
+
Change visibility of target file.
|
828
|
+
|
829
|
+
### Example
|
830
|
+
```ruby
|
831
|
+
# load the gem
|
832
|
+
require 'osdn-client'
|
833
|
+
# setup authorization
|
834
|
+
OSDNClient.configure do |config|
|
835
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
836
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
837
|
+
|
838
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
839
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
840
|
+
end
|
841
|
+
|
842
|
+
api_instance = OSDNClient::ProjectFrsApi.new
|
843
|
+
|
844
|
+
id_or_name = "id_or_name_example" # String | numeric project id or project name
|
845
|
+
|
846
|
+
package_id = 56 # Integer |
|
847
|
+
|
848
|
+
release_id = 56 # Integer |
|
849
|
+
|
850
|
+
file_id = 56 # Integer |
|
851
|
+
|
852
|
+
opts = {
|
853
|
+
visibility: "visibility_example" # String | visibility status (public, hidden or private)
|
854
|
+
}
|
855
|
+
|
856
|
+
begin
|
857
|
+
result = api_instance.update_release_file(id_or_name, package_id, release_id, file_id, opts)
|
858
|
+
p result
|
859
|
+
rescue OSDNClient::ApiError => e
|
860
|
+
puts "Exception when calling ProjectFrsApi->update_release_file: #{e}"
|
861
|
+
end
|
862
|
+
```
|
863
|
+
|
864
|
+
### Parameters
|
865
|
+
|
866
|
+
Name | Type | Description | Notes
|
867
|
+
------------- | ------------- | ------------- | -------------
|
868
|
+
**id_or_name** | **String**| numeric project id or project name |
|
869
|
+
**package_id** | **Integer**| |
|
870
|
+
**release_id** | **Integer**| |
|
871
|
+
**file_id** | **Integer**| |
|
872
|
+
**visibility** | **String**| visibility status (public, hidden or private) | [optional]
|
873
|
+
|
874
|
+
### Return type
|
875
|
+
|
876
|
+
[**RelFile**](RelFile.md)
|
877
|
+
|
878
|
+
### Authorization
|
879
|
+
|
880
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
881
|
+
|
882
|
+
### HTTP request headers
|
883
|
+
|
884
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
885
|
+
- **Accept**: Not defined
|
886
|
+
|
887
|
+
|
888
|
+
|