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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ee87ed25730de43c2c4b358ae35fccd6fde3c62a
|
4
|
+
data.tar.gz: 91e39e29ec37bb2385f1df22b2f845147d7fd389
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 092e4969eda560fbe632c4808ee3fc93e71c897135fd8d8e1152adb722af59ab8d4295820ee3368f17fdeca91d76f0137025cae6a8bd9846f6a6847394a256bc
|
7
|
+
data.tar.gz: ff5e9a881608ba4774ac3b38089b8bb7213110707f11d2392d25e9195563a6dbcdf82c818d39a3c68652d6e4841b67df9be3c7acfd35c6ac6cdc420c2d935a72
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,182 @@
|
|
1
|
+
# osdn-client
|
2
|
+
|
3
|
+
OSDNClient - the Ruby gem for the OSDN REST API v0 beta
|
4
|
+
|
5
|
+
OSDN REST API. Currently this API is experimental release. Pelase refer documentation on https://osdn.jp/projects/osdn-codes/wiki/APIGuide and you can get client libraries from https://osdn.jp/projects/osdn-codes/releases/p14859 .
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 0.0.20160304
|
10
|
+
- Package version: 0.0.20160711
|
11
|
+
- Build date: 2016-07-11T13:06:13.810+09:00
|
12
|
+
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
13
|
+
For more information, please visit [https://osdn.jp/projects/osdn-codes/wiki/APIGuide](https://osdn.jp/projects/osdn-codes/wiki/APIGuide)
|
14
|
+
|
15
|
+
## Installation
|
16
|
+
|
17
|
+
### Build a gem
|
18
|
+
|
19
|
+
To build the Ruby code into a gem:
|
20
|
+
|
21
|
+
```shell
|
22
|
+
gem build osdn-client.gemspec
|
23
|
+
```
|
24
|
+
|
25
|
+
Then either install the gem locally:
|
26
|
+
|
27
|
+
```shell
|
28
|
+
gem install ./osdn-client-0.0.20160711.gem
|
29
|
+
```
|
30
|
+
(for development, run `gem install --dev ./osdn-client-0.0.20160711.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'osdn-client', '~> 0.0.20160711'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/OSDN/Client, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'osdn-client', :git => 'https://github.com/OSDN/Client.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
```ruby
|
56
|
+
# Load the gem
|
57
|
+
require 'osdn-client'
|
58
|
+
|
59
|
+
# Setup authorization
|
60
|
+
OSDNClient.configure do |config|
|
61
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
62
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
63
|
+
|
64
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
65
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
66
|
+
end
|
67
|
+
|
68
|
+
api_instance = OSDNClient::DefaultApi.new
|
69
|
+
|
70
|
+
begin
|
71
|
+
result = api_instance.ping
|
72
|
+
p result
|
73
|
+
rescue OSDNClient::ApiError => e
|
74
|
+
puts "Exception when calling DefaultApi->ping: #{e}"
|
75
|
+
end
|
76
|
+
|
77
|
+
```
|
78
|
+
|
79
|
+
## Documentation for API Endpoints
|
80
|
+
|
81
|
+
All URIs are relative to *https://osdn.jp/api/v0*
|
82
|
+
|
83
|
+
Class | Method | HTTP request | Description
|
84
|
+
------------ | ------------- | ------------- | -------------
|
85
|
+
*OSDNClient::DefaultApi* | [**ping**](docs/DefaultApi.md#ping) | **GET** /ping |
|
86
|
+
*OSDNClient::DefaultApi* | [**token**](docs/DefaultApi.md#token) | **POST** /token |
|
87
|
+
*OSDNClient::ProjectApi* | [**create_news**](docs/ProjectApi.md#create_news) | **POST** /news |
|
88
|
+
*OSDNClient::ProjectApi* | [**create_news_0**](docs/ProjectApi.md#create_news_0) | **POST** /project/{id_or_name}/news |
|
89
|
+
*OSDNClient::ProjectApi* | [**create_package**](docs/ProjectApi.md#create_package) | **POST** /project/{id_or_name}/frs |
|
90
|
+
*OSDNClient::ProjectApi* | [**create_release**](docs/ProjectApi.md#create_release) | **POST** /project/{id_or_name}/frs/{package_id} |
|
91
|
+
*OSDNClient::ProjectApi* | [**create_release_file**](docs/ProjectApi.md#create_release_file) | **POST** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
92
|
+
*OSDNClient::ProjectApi* | [**delete_news**](docs/ProjectApi.md#delete_news) | **DELETE** /news/{news_id} |
|
93
|
+
*OSDNClient::ProjectApi* | [**delete_news_0**](docs/ProjectApi.md#delete_news_0) | **DELETE** /project/{id_or_name}/news/{news_id} |
|
94
|
+
*OSDNClient::ProjectApi* | [**delete_package**](docs/ProjectApi.md#delete_package) | **DELETE** /project/{id_or_name}/frs/{package_id} |
|
95
|
+
*OSDNClient::ProjectApi* | [**delete_release**](docs/ProjectApi.md#delete_release) | **DELETE** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
96
|
+
*OSDNClient::ProjectApi* | [**delete_release_file**](docs/ProjectApi.md#delete_release_file) | **DELETE** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
97
|
+
*OSDNClient::ProjectApi* | [**draft_release**](docs/ProjectApi.md#draft_release) | **GET** /project/{id_or_name}/frs/{package_id}/draft |
|
98
|
+
*OSDNClient::ProjectApi* | [**get_news**](docs/ProjectApi.md#get_news) | **GET** /news/{news_id} |
|
99
|
+
*OSDNClient::ProjectApi* | [**get_news_0**](docs/ProjectApi.md#get_news_0) | **GET** /project/{id_or_name}/news/{news_id} |
|
100
|
+
*OSDNClient::ProjectApi* | [**get_package**](docs/ProjectApi.md#get_package) | **GET** /project/{id_or_name}/frs/{package_id} |
|
101
|
+
*OSDNClient::ProjectApi* | [**get_project**](docs/ProjectApi.md#get_project) | **GET** /project/{id_or_name} |
|
102
|
+
*OSDNClient::ProjectApi* | [**get_release**](docs/ProjectApi.md#get_release) | **GET** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
103
|
+
*OSDNClient::ProjectApi* | [**get_release_file**](docs/ProjectApi.md#get_release_file) | **GET** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
104
|
+
*OSDNClient::ProjectApi* | [**list_news**](docs/ProjectApi.md#list_news) | **GET** /news |
|
105
|
+
*OSDNClient::ProjectApi* | [**list_news_0**](docs/ProjectApi.md#list_news_0) | **GET** /project/{id_or_name}/news |
|
106
|
+
*OSDNClient::ProjectApi* | [**list_packages**](docs/ProjectApi.md#list_packages) | **GET** /project/{id_or_name}/frs |
|
107
|
+
*OSDNClient::ProjectApi* | [**update_news**](docs/ProjectApi.md#update_news) | **PATCH** /news/{news_id} |
|
108
|
+
*OSDNClient::ProjectApi* | [**update_news_0**](docs/ProjectApi.md#update_news_0) | **PATCH** /project/{id_or_name}/news/{news_id} |
|
109
|
+
*OSDNClient::ProjectApi* | [**update_package**](docs/ProjectApi.md#update_package) | **PATCH** /project/{id_or_name}/frs/{package_id} |
|
110
|
+
*OSDNClient::ProjectApi* | [**update_release**](docs/ProjectApi.md#update_release) | **PATCH** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
111
|
+
*OSDNClient::ProjectApi* | [**update_release_file**](docs/ProjectApi.md#update_release_file) | **PATCH** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
112
|
+
*OSDNClient::ProjectFrsApi* | [**create_package**](docs/ProjectFrsApi.md#create_package) | **POST** /project/{id_or_name}/frs |
|
113
|
+
*OSDNClient::ProjectFrsApi* | [**create_release**](docs/ProjectFrsApi.md#create_release) | **POST** /project/{id_or_name}/frs/{package_id} |
|
114
|
+
*OSDNClient::ProjectFrsApi* | [**create_release_file**](docs/ProjectFrsApi.md#create_release_file) | **POST** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
115
|
+
*OSDNClient::ProjectFrsApi* | [**delete_package**](docs/ProjectFrsApi.md#delete_package) | **DELETE** /project/{id_or_name}/frs/{package_id} |
|
116
|
+
*OSDNClient::ProjectFrsApi* | [**delete_release**](docs/ProjectFrsApi.md#delete_release) | **DELETE** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
117
|
+
*OSDNClient::ProjectFrsApi* | [**delete_release_file**](docs/ProjectFrsApi.md#delete_release_file) | **DELETE** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
118
|
+
*OSDNClient::ProjectFrsApi* | [**draft_release**](docs/ProjectFrsApi.md#draft_release) | **GET** /project/{id_or_name}/frs/{package_id}/draft |
|
119
|
+
*OSDNClient::ProjectFrsApi* | [**get_package**](docs/ProjectFrsApi.md#get_package) | **GET** /project/{id_or_name}/frs/{package_id} |
|
120
|
+
*OSDNClient::ProjectFrsApi* | [**get_release**](docs/ProjectFrsApi.md#get_release) | **GET** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
121
|
+
*OSDNClient::ProjectFrsApi* | [**get_release_file**](docs/ProjectFrsApi.md#get_release_file) | **GET** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
122
|
+
*OSDNClient::ProjectFrsApi* | [**list_packages**](docs/ProjectFrsApi.md#list_packages) | **GET** /project/{id_or_name}/frs |
|
123
|
+
*OSDNClient::ProjectFrsApi* | [**update_package**](docs/ProjectFrsApi.md#update_package) | **PATCH** /project/{id_or_name}/frs/{package_id} |
|
124
|
+
*OSDNClient::ProjectFrsApi* | [**update_release**](docs/ProjectFrsApi.md#update_release) | **PATCH** /project/{id_or_name}/frs/{package_id}/{release_id} |
|
125
|
+
*OSDNClient::ProjectFrsApi* | [**update_release_file**](docs/ProjectFrsApi.md#update_release_file) | **PATCH** /project/{id_or_name}/frs/{package_id}/{release_id}/{file_id} |
|
126
|
+
*OSDNClient::ProjectNewsApi* | [**create_news**](docs/ProjectNewsApi.md#create_news) | **POST** /news |
|
127
|
+
*OSDNClient::ProjectNewsApi* | [**create_news_0**](docs/ProjectNewsApi.md#create_news_0) | **POST** /project/{id_or_name}/news |
|
128
|
+
*OSDNClient::ProjectNewsApi* | [**delete_news**](docs/ProjectNewsApi.md#delete_news) | **DELETE** /news/{news_id} |
|
129
|
+
*OSDNClient::ProjectNewsApi* | [**delete_news_0**](docs/ProjectNewsApi.md#delete_news_0) | **DELETE** /project/{id_or_name}/news/{news_id} |
|
130
|
+
*OSDNClient::ProjectNewsApi* | [**get_news**](docs/ProjectNewsApi.md#get_news) | **GET** /news/{news_id} |
|
131
|
+
*OSDNClient::ProjectNewsApi* | [**get_news_0**](docs/ProjectNewsApi.md#get_news_0) | **GET** /project/{id_or_name}/news/{news_id} |
|
132
|
+
*OSDNClient::ProjectNewsApi* | [**list_news**](docs/ProjectNewsApi.md#list_news) | **GET** /news |
|
133
|
+
*OSDNClient::ProjectNewsApi* | [**list_news_0**](docs/ProjectNewsApi.md#list_news_0) | **GET** /project/{id_or_name}/news |
|
134
|
+
*OSDNClient::ProjectNewsApi* | [**update_news**](docs/ProjectNewsApi.md#update_news) | **PATCH** /news/{news_id} |
|
135
|
+
*OSDNClient::ProjectNewsApi* | [**update_news_0**](docs/ProjectNewsApi.md#update_news_0) | **PATCH** /project/{id_or_name}/news/{news_id} |
|
136
|
+
*OSDNClient::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /user/{id_or_name} |
|
137
|
+
|
138
|
+
|
139
|
+
## Documentation for Models
|
140
|
+
|
141
|
+
- [OSDNClient::Group](docs/Group.md)
|
142
|
+
- [OSDNClient::GroupToolFlags](docs/GroupToolFlags.md)
|
143
|
+
- [OSDNClient::News](docs/News.md)
|
144
|
+
- [OSDNClient::Package](docs/Package.md)
|
145
|
+
- [OSDNClient::Pong](docs/Pong.md)
|
146
|
+
- [OSDNClient::RelFile](docs/RelFile.md)
|
147
|
+
- [OSDNClient::Release](docs/Release.md)
|
148
|
+
- [OSDNClient::SimpleChamber](docs/SimpleChamber.md)
|
149
|
+
- [OSDNClient::SimpleGroup](docs/SimpleGroup.md)
|
150
|
+
- [OSDNClient::SimpleUser](docs/SimpleUser.md)
|
151
|
+
- [OSDNClient::Skill](docs/Skill.md)
|
152
|
+
- [OSDNClient::Token](docs/Token.md)
|
153
|
+
- [OSDNClient::User](docs/User.md)
|
154
|
+
|
155
|
+
|
156
|
+
## Documentation for Authorization
|
157
|
+
|
158
|
+
|
159
|
+
### oauth2-code
|
160
|
+
|
161
|
+
- **Type**: OAuth
|
162
|
+
- **Flow**: accessCode
|
163
|
+
- **Authorization URL**: https://osdn.jp/account/oauth2ui/authorize
|
164
|
+
- **Scopes**:
|
165
|
+
- profile: Read basic user profile
|
166
|
+
- group: read access to group data
|
167
|
+
- group_write: write access to group data
|
168
|
+
- chamber: read access to chamber data
|
169
|
+
- chamber_write: write access to chamber data
|
170
|
+
|
171
|
+
### oauth2-implicit
|
172
|
+
|
173
|
+
- **Type**: OAuth
|
174
|
+
- **Flow**: implicit
|
175
|
+
- **Authorization URL**: https://osdn.jp/account/oauth2ui/authorize
|
176
|
+
- **Scopes**:
|
177
|
+
- profile: Read basic user profile
|
178
|
+
- group: read access to group data
|
179
|
+
- group_write: write access to group data
|
180
|
+
- chamber: read access to chamber data
|
181
|
+
- chamber_write: write access to chamber data
|
182
|
+
|
data/docs/DefaultApi.md
ADDED
@@ -0,0 +1,115 @@
|
|
1
|
+
# OSDNClient::DefaultApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://osdn.jp/api/v0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**ping**](DefaultApi.md#ping) | **GET** /ping |
|
8
|
+
[**token**](DefaultApi.md#token) | **POST** /token |
|
9
|
+
|
10
|
+
|
11
|
+
# **ping**
|
12
|
+
> Pong ping
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
return pong for test
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'osdn-client'
|
22
|
+
# setup authorization
|
23
|
+
OSDNClient.configure do |config|
|
24
|
+
# Configure OAuth2 access token for authorization: oauth2-code
|
25
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
26
|
+
|
27
|
+
# Configure OAuth2 access token for authorization: oauth2-implicit
|
28
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = OSDNClient::DefaultApi.new
|
32
|
+
|
33
|
+
begin
|
34
|
+
result = api_instance.ping
|
35
|
+
p result
|
36
|
+
rescue OSDNClient::ApiError => e
|
37
|
+
puts "Exception when calling DefaultApi->ping: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
This endpoint does not need any parameter.
|
43
|
+
|
44
|
+
### Return type
|
45
|
+
|
46
|
+
[**Pong**](Pong.md)
|
47
|
+
|
48
|
+
### Authorization
|
49
|
+
|
50
|
+
[oauth2-code](../README.md#oauth2-code), [oauth2-implicit](../README.md#oauth2-implicit)
|
51
|
+
|
52
|
+
### HTTP request headers
|
53
|
+
|
54
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
55
|
+
- **Accept**: Not defined
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
# **token**
|
60
|
+
> Token token(client_id, client_secret, opts)
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
Get access token by access code.
|
65
|
+
|
66
|
+
### Example
|
67
|
+
```ruby
|
68
|
+
# load the gem
|
69
|
+
require 'osdn-client'
|
70
|
+
|
71
|
+
api_instance = OSDNClient::DefaultApi.new
|
72
|
+
|
73
|
+
client_id = "client_id_example" # String | Your application ID
|
74
|
+
|
75
|
+
client_secret = "client_secret_example" # String | Your application secret (key)
|
76
|
+
|
77
|
+
opts = {
|
78
|
+
grant_type: "authorization_code", # String | \"authorization_code\" or \"refresh_token\"
|
79
|
+
code: "code_example", # String | Set auth code issued by https://osdn.jp/account/oauth2ui/authorize for grant_type=authorization_code
|
80
|
+
refresh_token: "refresh_token_example" # String | Set refresh token to update access token.
|
81
|
+
}
|
82
|
+
|
83
|
+
begin
|
84
|
+
result = api_instance.token(client_id, client_secret, opts)
|
85
|
+
p result
|
86
|
+
rescue OSDNClient::ApiError => e
|
87
|
+
puts "Exception when calling DefaultApi->token: #{e}"
|
88
|
+
end
|
89
|
+
```
|
90
|
+
|
91
|
+
### Parameters
|
92
|
+
|
93
|
+
Name | Type | Description | Notes
|
94
|
+
------------- | ------------- | ------------- | -------------
|
95
|
+
**client_id** | **String**| Your application ID |
|
96
|
+
**client_secret** | **String**| Your application secret (key) |
|
97
|
+
**grant_type** | **String**| \"authorization_code\" or \"refresh_token\" | [optional] [default to authorization_code]
|
98
|
+
**code** | **String**| Set auth code issued by https://osdn.jp/account/oauth2ui/authorize for grant_type=authorization_code | [optional]
|
99
|
+
**refresh_token** | **String**| Set refresh token to update access token. | [optional]
|
100
|
+
|
101
|
+
### Return type
|
102
|
+
|
103
|
+
[**Token**](Token.md)
|
104
|
+
|
105
|
+
### Authorization
|
106
|
+
|
107
|
+
No authorization required
|
108
|
+
|
109
|
+
### HTTP request headers
|
110
|
+
|
111
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
112
|
+
- **Accept**: Not defined
|
113
|
+
|
114
|
+
|
115
|
+
|