crx_packmgr_api_client 0.1.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +33 -16
- data/crx_packmgr_api_client-0.2.0.gem +0 -0
- data/crx_packmgr_api_client.gemspec +9 -4
- data/docs/DefaultApi.md +457 -7
- data/docs/{PackageFilter.md → Filter.md} +2 -2
- data/docs/FilterRule.md +9 -0
- data/docs/Group.md +11 -0
- data/docs/{InlineResponse200.md → GroupList.md} +2 -2
- data/docs/InitData.md +13 -0
- data/docs/InstallStatus.md +8 -0
- data/docs/InstallStatusStatus.md +9 -0
- data/docs/Package.md +1 -1
- data/docs/PackageList.md +1 -0
- data/docs/ServiceResponse.md +12 -0
- data/docs/ServiceResponseRequest.md +8 -0
- data/docs/ServiceResponseRequestParam.md +9 -0
- data/docs/ServiceResponseResponse.md +9 -0
- data/docs/UpdateStatus.md +10 -0
- data/git_push.sh +1 -1
- data/lib/crx_packmgr_api_client.rb +13 -2
- data/lib/crx_packmgr_api_client/api/default_api.rb +491 -8
- data/lib/crx_packmgr_api_client/api_client.rb +1 -1
- data/lib/crx_packmgr_api_client/api_error.rb +1 -1
- data/lib/crx_packmgr_api_client/configuration.rb +1 -1
- data/lib/crx_packmgr_api_client/models/{package_filter.rb → filter.rb} +3 -3
- data/lib/crx_packmgr_api_client/models/filter_rule.rb +241 -0
- data/lib/crx_packmgr_api_client/models/group.rb +226 -0
- data/lib/crx_packmgr_api_client/models/{inline_response_200.rb → group_list.rb} +10 -10
- data/lib/crx_packmgr_api_client/models/init_data.rb +246 -0
- data/lib/crx_packmgr_api_client/models/install_status.rb +199 -0
- data/lib/crx_packmgr_api_client/models/install_status_status.rb +208 -0
- data/lib/crx_packmgr_api_client/models/package.rb +2 -2
- data/lib/crx_packmgr_api_client/models/package_list.rb +14 -5
- data/lib/crx_packmgr_api_client/models/service_response.rb +235 -0
- data/lib/crx_packmgr_api_client/models/service_response_request.rb +201 -0
- data/lib/crx_packmgr_api_client/models/service_response_request_param.rb +208 -0
- data/lib/crx_packmgr_api_client/models/service_response_response.rb +208 -0
- data/lib/crx_packmgr_api_client/models/update_status.rb +217 -0
- data/lib/crx_packmgr_api_client/version.rb +2 -2
- data/spec/acceptance/default_api_spec.rb +150 -0
- data/spec/api/default_api_spec.rb +2 -14
- data/spec/api/download_api_spec.rb +95 -0
- data/spec/api/groups_api_spec.rb +193 -0
- data/spec/api/init_api_spec.rb +104 -0
- data/spec/api/installstatus_api_spec.rb +91 -0
- data/spec/api/list_api_spec.rb +130 -0
- data/spec/api/screenshot_api_spec.rb +93 -0
- data/spec/api/service_api_spec.rb +374 -0
- data/spec/api/thumbnail_api_spec.rb +93 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/files/list.json +533 -0
- data/spec/files/service_response.txt +11 -0
- data/spec/files/service_response1.txt +12 -0
- data/spec/files/test-1.0.0.zip +0 -0
- data/spec/files/thumbnail.png +0 -0
- data/spec/models/filter_rule_spec.rb +63 -0
- data/spec/models/{package_filter_spec.rb → filter_spec.rb} +7 -7
- data/spec/models/{inline_response_200_spec.rb → group_list_spec.rb} +8 -8
- data/spec/models/group_spec.rb +71 -0
- data/spec/models/init_data_spec.rb +83 -0
- data/spec/models/install_status_spec.rb +53 -0
- data/spec/models/install_status_status_spec.rb +59 -0
- data/spec/models/package_list_spec.rb +1 -1
- data/spec/models/package_spec.rb +1 -1
- data/spec/models/service_response_request_param_spec.rb +59 -0
- data/spec/models/service_response_request_spec.rb +53 -0
- data/spec/models/service_response_response_spec.rb +59 -0
- data/spec/models/service_response_spec.rb +77 -0
- data/spec/models/update_status_spec.rb +65 -0
- data/spec/spec_helper.rb +10 -1
- data/spec/spec_helper_acceptance.rb +19 -0
- metadata +130 -17
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d46cd66a113fac3af4cf475b7a7d90826c4293ac
|
4
|
+
data.tar.gz: 59a74828446f50aa1ff94ab591de3e123b8a336e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c32b9ac0df3aec617a4a8f7b5e408b8bb0df7c68484e80a1cf04138c05b1d4718b7d4c17dfb0f87e567bbd954fa62ef11fd8d4c8c50b152c55e3e37e5852db0d
|
7
|
+
data.tar.gz: c321338987965101ba084816cf22380b804a1465fd386186549499b1357fe8bd6c056ba787432bc0c78e43409605b5f519d967f2a5b8e72c03dd594e5b698985
|
data/README.md
CHANGED
@@ -6,9 +6,9 @@ API for interacting with the CRX Package Manager in AEM.
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
|
-
- API version:
|
10
|
-
- Package version:
|
11
|
-
- Build date: 2016-
|
9
|
+
- API version: 6.2.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build date: 2016-12-17T22:39:24.217-06:00
|
12
12
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
13
13
|
|
14
14
|
## Installation
|
@@ -24,21 +24,21 @@ gem build crx_packmgr_api_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./crx_packmgr_api_client-
|
27
|
+
gem install ./crx_packmgr_api_client-1.0.0.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./crx_packmgr_api_client-
|
29
|
+
(for development, run `gem install --dev ./crx_packmgr_api_client-1.0.0.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'crx_packmgr_api_client', '~>
|
35
|
+
gem 'crx_packmgr_api_client', '~> 1.0.0'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
39
|
-
If the Ruby gem is hosted at a git repository: https://github.com/bstopp/
|
39
|
+
If the Ruby gem is hosted at a git repository: https://github.com/bstopp/crx-packmgr-api-client-gem, then add the following in the Gemfile:
|
40
40
|
|
41
|
-
gem 'crx_packmgr_api_client', :git => 'https://github.com/bstopp/
|
41
|
+
gem 'crx_packmgr_api_client', :git => 'https://github.com/bstopp/crx-packmgr-api-client-gem.git'
|
42
42
|
|
43
43
|
### Include the Ruby code directly
|
44
44
|
|
@@ -65,17 +65,15 @@ end
|
|
65
65
|
api_instance = CrxPackageManager::DefaultApi.new
|
66
66
|
|
67
67
|
opts = {
|
68
|
-
|
69
|
-
include_versions: true, # BOOLEAN | Include versions of package in results.
|
70
|
-
path: "path_example" # String | The path to a specific package definition.
|
68
|
+
path: "path_example" # String | The path to the package to download.
|
71
69
|
}
|
72
70
|
|
73
71
|
begin
|
74
|
-
#
|
75
|
-
result = api_instance.
|
72
|
+
#Download a package
|
73
|
+
result = api_instance.download(opts)
|
76
74
|
p result
|
77
75
|
rescue CrxPackageManager::ApiError => e
|
78
|
-
puts "Exception when calling DefaultApi->
|
76
|
+
puts "Exception when calling DefaultApi->download: #{e}"
|
79
77
|
end
|
80
78
|
|
81
79
|
```
|
@@ -86,14 +84,33 @@ All URIs are relative to *http://localhost:4502/crx/packmgr*
|
|
86
84
|
|
87
85
|
Class | Method | HTTP request | Description
|
88
86
|
------------ | ------------- | ------------- | -------------
|
89
|
-
*CrxPackageManager::DefaultApi* | [**
|
87
|
+
*CrxPackageManager::DefaultApi* | [**download**](docs/DefaultApi.md#download) | **GET** /download.jsp | Download a package
|
88
|
+
*CrxPackageManager::DefaultApi* | [**groups**](docs/DefaultApi.md#groups) | **GET** /groups.jsp | List package groups
|
89
|
+
*CrxPackageManager::DefaultApi* | [**init**](docs/DefaultApi.md#init) | **GET** /init.jsp | Metadata
|
90
|
+
*CrxPackageManager::DefaultApi* | [**installstatus**](docs/DefaultApi.md#installstatus) | **GET** /installstatus.jsp | Package Installation Status
|
91
|
+
*CrxPackageManager::DefaultApi* | [**list**](docs/DefaultApi.md#list) | **GET** /list.jsp | List packages
|
92
|
+
*CrxPackageManager::DefaultApi* | [**screenshot**](docs/DefaultApi.md#screenshot) | **GET** /screenshot.jsp | Get screenshot
|
93
|
+
*CrxPackageManager::DefaultApi* | [**service_get**](docs/DefaultApi.md#service_get) | **GET** /service.jsp | Generic operation service.
|
94
|
+
*CrxPackageManager::DefaultApi* | [**service_post**](docs/DefaultApi.md#service_post) | **POST** /service.jsp | Generic operation service.
|
95
|
+
*CrxPackageManager::DefaultApi* | [**thumbnail**](docs/DefaultApi.md#thumbnail) | **GET** /thumbnail.jsp | Get package thumbnail
|
90
96
|
|
91
97
|
|
92
98
|
## Documentation for Models
|
93
99
|
|
100
|
+
- [CrxPackageManager::Filter](docs/Filter.md)
|
101
|
+
- [CrxPackageManager::FilterRule](docs/FilterRule.md)
|
102
|
+
- [CrxPackageManager::Group](docs/Group.md)
|
103
|
+
- [CrxPackageManager::GroupList](docs/GroupList.md)
|
104
|
+
- [CrxPackageManager::InitData](docs/InitData.md)
|
105
|
+
- [CrxPackageManager::InstallStatus](docs/InstallStatus.md)
|
106
|
+
- [CrxPackageManager::InstallStatusStatus](docs/InstallStatusStatus.md)
|
94
107
|
- [CrxPackageManager::Package](docs/Package.md)
|
95
|
-
- [CrxPackageManager::PackageFilter](docs/PackageFilter.md)
|
96
108
|
- [CrxPackageManager::PackageList](docs/PackageList.md)
|
109
|
+
- [CrxPackageManager::ServiceResponse](docs/ServiceResponse.md)
|
110
|
+
- [CrxPackageManager::ServiceResponseRequest](docs/ServiceResponseRequest.md)
|
111
|
+
- [CrxPackageManager::ServiceResponseRequestParam](docs/ServiceResponseRequestParam.md)
|
112
|
+
- [CrxPackageManager::ServiceResponseResponse](docs/ServiceResponseResponse.md)
|
113
|
+
- [CrxPackageManager::UpdateStatus](docs/UpdateStatus.md)
|
97
114
|
|
98
115
|
|
99
116
|
## Documentation for Authorization
|
Binary file
|
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
#API for interacting with the CRX Package Manager in AEM.
|
7
7
|
|
8
|
-
OpenAPI spec version:
|
8
|
+
OpenAPI spec version: 6.2.0
|
9
9
|
Contact: bryan.stopp@gmail.com
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
11
|
|
@@ -32,22 +32,27 @@ Gem::Specification.new do |s|
|
|
32
32
|
s.platform = Gem::Platform::RUBY
|
33
33
|
s.authors = ["Swagger-Codegen"]
|
34
34
|
s.email = ["bryan.stopp@gmail.com"]
|
35
|
-
s.homepage = "https://github.com/
|
35
|
+
s.homepage = "https://github.com/bstopp/crx-packmgr-api-client-gem"
|
36
36
|
s.summary = "CRX Package Manager API Ruby Gem"
|
37
37
|
s.description = "API for interacting with the CRX Package Manager in AEM."
|
38
|
-
s.license = "Apache
|
38
|
+
s.license = "Apache-2.0"
|
39
|
+
s.required_ruby_version = ">= 1.9"
|
39
40
|
|
40
41
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
41
42
|
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
42
43
|
|
43
44
|
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
44
45
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
45
|
-
|
46
|
+
s.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
|
46
47
|
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
47
48
|
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
48
49
|
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
49
50
|
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
50
51
|
|
52
|
+
s.add_development_dependency 'rubocop'
|
53
|
+
s.add_development_dependency 'simplecov'
|
54
|
+
s.add_development_dependency 'codeclimate-test-reporter'
|
55
|
+
|
51
56
|
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
52
57
|
s.test_files = `find spec/*`.split("\n")
|
53
58
|
s.executables = []
|
data/docs/DefaultApi.md
CHANGED
@@ -4,13 +4,231 @@ All URIs are relative to *http://localhost:4502/crx/packmgr*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
7
|
+
[**download**](DefaultApi.md#download) | **GET** /download.jsp | Download a package
|
8
|
+
[**groups**](DefaultApi.md#groups) | **GET** /groups.jsp | List package groups
|
9
|
+
[**init**](DefaultApi.md#init) | **GET** /init.jsp | Metadata
|
10
|
+
[**installstatus**](DefaultApi.md#installstatus) | **GET** /installstatus.jsp | Package Installation Status
|
11
|
+
[**list**](DefaultApi.md#list) | **GET** /list.jsp | List packages
|
12
|
+
[**screenshot**](DefaultApi.md#screenshot) | **GET** /screenshot.jsp | Get screenshot
|
13
|
+
[**service_get**](DefaultApi.md#service_get) | **GET** /service.jsp | Generic operation service.
|
14
|
+
[**service_post**](DefaultApi.md#service_post) | **POST** /service.jsp | Generic operation service.
|
15
|
+
[**thumbnail**](DefaultApi.md#thumbnail) | **GET** /thumbnail.jsp | Get package thumbnail
|
16
|
+
|
17
|
+
|
18
|
+
# **download**
|
19
|
+
> File download(opts)
|
20
|
+
|
21
|
+
Download a package
|
22
|
+
|
23
|
+
Downloads the package at the specified path. Returns a Tempfile object.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'crx_packmgr_api_client'
|
29
|
+
# setup authorization
|
30
|
+
CrxPackageManager.configure do |config|
|
31
|
+
# Configure HTTP basic authorization: basic
|
32
|
+
config.username = 'YOUR USERNAME'
|
33
|
+
config.password = 'YOUR PASSWORD'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
37
|
+
|
38
|
+
opts = {
|
39
|
+
path: "path_example" # String | The path to the package to download.
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
#Download a package
|
44
|
+
result = api_instance.download(opts)
|
45
|
+
p result
|
46
|
+
rescue CrxPackageManager::ApiError => e
|
47
|
+
puts "Exception when calling DefaultApi->download: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Parameters
|
52
|
+
|
53
|
+
Name | Type | Description | Notes
|
54
|
+
------------- | ------------- | ------------- | -------------
|
55
|
+
**path** | **String**| The path to the package to download. | [optional]
|
56
|
+
|
57
|
+
### Return type
|
58
|
+
|
59
|
+
**File**
|
60
|
+
|
61
|
+
### Authorization
|
62
|
+
|
63
|
+
[basic](../README.md#basic)
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: Not defined
|
68
|
+
- **Accept**: application/octet-stream, application/zip
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **groups**
|
73
|
+
> GroupList groups(opts)
|
74
|
+
|
75
|
+
List package groups
|
76
|
+
|
77
|
+
Returns a list of all package groups available.
|
78
|
+
|
79
|
+
### Example
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'crx_packmgr_api_client'
|
83
|
+
# setup authorization
|
84
|
+
CrxPackageManager.configure do |config|
|
85
|
+
# Configure HTTP basic authorization: basic
|
86
|
+
config.username = 'YOUR USERNAME'
|
87
|
+
config.password = 'YOUR PASSWORD'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
91
|
+
|
92
|
+
opts = {
|
93
|
+
compress_version: "compress_version_example", # String | Compress versions; count all versions of the same packages as a single entry.
|
94
|
+
include_all: true, # BOOLEAN | Return a total count of all packages. Defaults to false.
|
95
|
+
include_root: true, # BOOLEAN | Include the root package. Defaults to false.
|
96
|
+
include_my_packages: true, # BOOLEAN | Include the 'my_packages' group. Only applicable if the group has no packages. Defaults to false.
|
97
|
+
only_top_level: true # BOOLEAN | Only list top-level groups, ie. do not list all nested groups.
|
98
|
+
}
|
99
|
+
|
100
|
+
begin
|
101
|
+
#List package groups
|
102
|
+
result = api_instance.groups(opts)
|
103
|
+
p result
|
104
|
+
rescue CrxPackageManager::ApiError => e
|
105
|
+
puts "Exception when calling DefaultApi->groups: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
Name | Type | Description | Notes
|
112
|
+
------------- | ------------- | ------------- | -------------
|
113
|
+
**compress_version** | **String**| Compress versions; count all versions of the same packages as a single entry. | [optional]
|
114
|
+
**include_all** | **BOOLEAN**| Return a total count of all packages. Defaults to false. | [optional]
|
115
|
+
**include_root** | **BOOLEAN**| Include the root package. Defaults to false. | [optional]
|
116
|
+
**include_my_packages** | **BOOLEAN**| Include the 'my_packages' group. Only applicable if the group has no packages. Defaults to false. | [optional]
|
117
|
+
**only_top_level** | **BOOLEAN**| Only list top-level groups, ie. do not list all nested groups. | [optional]
|
118
|
+
|
119
|
+
### Return type
|
120
|
+
|
121
|
+
[**GroupList**](GroupList.md)
|
122
|
+
|
123
|
+
### Authorization
|
124
|
+
|
125
|
+
[basic](../README.md#basic)
|
126
|
+
|
127
|
+
### HTTP request headers
|
128
|
+
|
129
|
+
- **Content-Type**: Not defined
|
130
|
+
- **Accept**: application/json
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
# **init**
|
135
|
+
> InitData init
|
136
|
+
|
137
|
+
Metadata
|
138
|
+
|
139
|
+
Display metadata about this package manager.
|
140
|
+
|
141
|
+
### Example
|
142
|
+
```ruby
|
143
|
+
# load the gem
|
144
|
+
require 'crx_packmgr_api_client'
|
145
|
+
# setup authorization
|
146
|
+
CrxPackageManager.configure do |config|
|
147
|
+
# Configure HTTP basic authorization: basic
|
148
|
+
config.username = 'YOUR USERNAME'
|
149
|
+
config.password = 'YOUR PASSWORD'
|
150
|
+
end
|
151
|
+
|
152
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
153
|
+
|
154
|
+
begin
|
155
|
+
#Metadata
|
156
|
+
result = api_instance.init
|
157
|
+
p result
|
158
|
+
rescue CrxPackageManager::ApiError => e
|
159
|
+
puts "Exception when calling DefaultApi->init: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
This endpoint does not need any parameter.
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**InitData**](InitData.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
[basic](../README.md#basic)
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: Not defined
|
177
|
+
- **Accept**: application/json
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
# **installstatus**
|
182
|
+
> InstallStatus installstatus
|
183
|
+
|
184
|
+
Package Installation Status
|
185
|
+
|
186
|
+
Returns a status of the installation of OSGi packages.
|
187
|
+
|
188
|
+
### Example
|
189
|
+
```ruby
|
190
|
+
# load the gem
|
191
|
+
require 'crx_packmgr_api_client'
|
192
|
+
# setup authorization
|
193
|
+
CrxPackageManager.configure do |config|
|
194
|
+
# Configure HTTP basic authorization: basic
|
195
|
+
config.username = 'YOUR USERNAME'
|
196
|
+
config.password = 'YOUR PASSWORD'
|
197
|
+
end
|
198
|
+
|
199
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
200
|
+
|
201
|
+
begin
|
202
|
+
#Package Installation Status
|
203
|
+
result = api_instance.installstatus
|
204
|
+
p result
|
205
|
+
rescue CrxPackageManager::ApiError => e
|
206
|
+
puts "Exception when calling DefaultApi->installstatus: #{e}"
|
207
|
+
end
|
208
|
+
```
|
209
|
+
|
210
|
+
### Parameters
|
211
|
+
This endpoint does not need any parameter.
|
212
|
+
|
213
|
+
### Return type
|
214
|
+
|
215
|
+
[**InstallStatus**](InstallStatus.md)
|
216
|
+
|
217
|
+
### Authorization
|
218
|
+
|
219
|
+
[basic](../README.md#basic)
|
220
|
+
|
221
|
+
### HTTP request headers
|
222
|
+
|
223
|
+
- **Content-Type**: Not defined
|
224
|
+
- **Accept**: application/json
|
225
|
+
|
8
226
|
|
9
227
|
|
10
228
|
# **list**
|
11
229
|
> PackageList list(opts)
|
12
230
|
|
13
|
-
List
|
231
|
+
List packages
|
14
232
|
|
15
233
|
Returns a list of all available packages defined.
|
16
234
|
|
@@ -30,11 +248,11 @@ api_instance = CrxPackageManager::DefaultApi.new
|
|
30
248
|
opts = {
|
31
249
|
q: "q_example", # String | Term to search within package names.
|
32
250
|
include_versions: true, # BOOLEAN | Include versions of package in results.
|
33
|
-
|
251
|
+
null: "null_example" # String | The path to a specific package definition.
|
34
252
|
}
|
35
253
|
|
36
254
|
begin
|
37
|
-
#List
|
255
|
+
#List packages
|
38
256
|
result = api_instance.list(opts)
|
39
257
|
p result
|
40
258
|
rescue CrxPackageManager::ApiError => e
|
@@ -48,7 +266,7 @@ Name | Type | Description | Notes
|
|
48
266
|
------------- | ------------- | ------------- | -------------
|
49
267
|
**q** | **String**| Term to search within package names. | [optional]
|
50
268
|
**include_versions** | **BOOLEAN**| Include versions of package in results. | [optional]
|
51
|
-
**
|
269
|
+
**null** | **String**| The path to a specific package definition. | [optional]
|
52
270
|
|
53
271
|
### Return type
|
54
272
|
|
@@ -60,8 +278,240 @@ Name | Type | Description | Notes
|
|
60
278
|
|
61
279
|
### HTTP request headers
|
62
280
|
|
63
|
-
- **Content-Type**:
|
64
|
-
- **Accept**:
|
281
|
+
- **Content-Type**: Not defined
|
282
|
+
- **Accept**: application/json
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
# **screenshot**
|
287
|
+
> File screenshot(opts)
|
288
|
+
|
289
|
+
Get screenshot
|
290
|
+
|
291
|
+
Returns the screenshot at the specified path.
|
292
|
+
|
293
|
+
### Example
|
294
|
+
```ruby
|
295
|
+
# load the gem
|
296
|
+
require 'crx_packmgr_api_client'
|
297
|
+
# setup authorization
|
298
|
+
CrxPackageManager.configure do |config|
|
299
|
+
# Configure HTTP basic authorization: basic
|
300
|
+
config.username = 'YOUR USERNAME'
|
301
|
+
config.password = 'YOUR PASSWORD'
|
302
|
+
end
|
303
|
+
|
304
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
305
|
+
|
306
|
+
opts = {
|
307
|
+
path: "path_example" # String | The path to the screenshot.
|
308
|
+
}
|
309
|
+
|
310
|
+
begin
|
311
|
+
#Get screenshot
|
312
|
+
result = api_instance.screenshot(opts)
|
313
|
+
p result
|
314
|
+
rescue CrxPackageManager::ApiError => e
|
315
|
+
puts "Exception when calling DefaultApi->screenshot: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
### Parameters
|
320
|
+
|
321
|
+
Name | Type | Description | Notes
|
322
|
+
------------- | ------------- | ------------- | -------------
|
323
|
+
**path** | **String**| The path to the screenshot. | [optional]
|
324
|
+
|
325
|
+
### Return type
|
326
|
+
|
327
|
+
**File**
|
328
|
+
|
329
|
+
### Authorization
|
330
|
+
|
331
|
+
[basic](../README.md#basic)
|
332
|
+
|
333
|
+
### HTTP request headers
|
334
|
+
|
335
|
+
- **Content-Type**: Not defined
|
336
|
+
- **Accept**: image/jpg, image/jpeg, image/png
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
# **service_get**
|
341
|
+
> String service_get(cmd, opts)
|
342
|
+
|
343
|
+
Generic operation service.
|
344
|
+
|
345
|
+
Provides endpoint for executing package manipulation commands. Responses are in the format of the ServiceResponse in the defintions section.
|
346
|
+
|
347
|
+
### Example
|
348
|
+
```ruby
|
349
|
+
# load the gem
|
350
|
+
require 'crx_packmgr_api_client'
|
351
|
+
# setup authorization
|
352
|
+
CrxPackageManager.configure do |config|
|
353
|
+
# Configure HTTP basic authorization: basic
|
354
|
+
config.username = 'YOUR USERNAME'
|
355
|
+
config.password = 'YOUR PASSWORD'
|
356
|
+
end
|
357
|
+
|
358
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
359
|
+
|
360
|
+
cmd = "cmd_example" # String | The command to execute.
|
361
|
+
|
362
|
+
opts = {
|
363
|
+
name: "name_example", # String | The name of the package on which to execute the command.
|
364
|
+
group: "group_example", # String | The group of the package on which to execute the command.
|
365
|
+
strict: true # BOOLEAN | Fail on an error.
|
366
|
+
}
|
367
|
+
|
368
|
+
begin
|
369
|
+
#Generic operation service.
|
370
|
+
result = api_instance.service_get(cmd, opts)
|
371
|
+
p result
|
372
|
+
rescue CrxPackageManager::ApiError => e
|
373
|
+
puts "Exception when calling DefaultApi->service_get: #{e}"
|
374
|
+
end
|
375
|
+
```
|
376
|
+
|
377
|
+
### Parameters
|
378
|
+
|
379
|
+
Name | Type | Description | Notes
|
380
|
+
------------- | ------------- | ------------- | -------------
|
381
|
+
**cmd** | **String**| The command to execute. |
|
382
|
+
**name** | **String**| The name of the package on which to execute the command. | [optional]
|
383
|
+
**group** | **String**| The group of the package on which to execute the command. | [optional]
|
384
|
+
**strict** | **BOOLEAN**| Fail on an error. | [optional]
|
385
|
+
|
386
|
+
### Return type
|
387
|
+
|
388
|
+
**String**
|
389
|
+
|
390
|
+
### Authorization
|
391
|
+
|
392
|
+
[basic](../README.md#basic)
|
393
|
+
|
394
|
+
### HTTP request headers
|
395
|
+
|
396
|
+
- **Content-Type**: Not defined
|
397
|
+
- **Accept**: application/octet-stream, application/zip, text/plain
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
# **service_post**
|
402
|
+
> String service_post(file, opts)
|
403
|
+
|
404
|
+
Generic operation service.
|
405
|
+
|
406
|
+
Provides endpoint for executing package manipulation commands. Responses are in the format of the ServiceResponse in the defintions section.
|
407
|
+
|
408
|
+
### Example
|
409
|
+
```ruby
|
410
|
+
# load the gem
|
411
|
+
require 'crx_packmgr_api_client'
|
412
|
+
# setup authorization
|
413
|
+
CrxPackageManager.configure do |config|
|
414
|
+
# Configure HTTP basic authorization: basic
|
415
|
+
config.username = 'YOUR USERNAME'
|
416
|
+
config.password = 'YOUR PASSWORD'
|
417
|
+
end
|
418
|
+
|
419
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
420
|
+
|
421
|
+
file = File.new("/path/to/file.txt") # File | Package file to upload
|
422
|
+
|
423
|
+
opts = {
|
424
|
+
name: "name_example", # String | The hint for the package's name if the definiton doesn't have one.
|
425
|
+
strict: true, # BOOLEAN | Fail on an error.
|
426
|
+
force: true, # BOOLEAN | Force the package upload.
|
427
|
+
install: true # BOOLEAN | Install the package upon upload
|
428
|
+
}
|
429
|
+
|
430
|
+
begin
|
431
|
+
#Generic operation service.
|
432
|
+
result = api_instance.service_post(file, opts)
|
433
|
+
p result
|
434
|
+
rescue CrxPackageManager::ApiError => e
|
435
|
+
puts "Exception when calling DefaultApi->service_post: #{e}"
|
436
|
+
end
|
437
|
+
```
|
438
|
+
|
439
|
+
### Parameters
|
440
|
+
|
441
|
+
Name | Type | Description | Notes
|
442
|
+
------------- | ------------- | ------------- | -------------
|
443
|
+
**file** | **File**| Package file to upload |
|
444
|
+
**name** | **String**| The hint for the package's name if the definiton doesn't have one. | [optional]
|
445
|
+
**strict** | **BOOLEAN**| Fail on an error. | [optional]
|
446
|
+
**force** | **BOOLEAN**| Force the package upload. | [optional]
|
447
|
+
**install** | **BOOLEAN**| Install the package upon upload | [optional]
|
448
|
+
|
449
|
+
### Return type
|
450
|
+
|
451
|
+
**String**
|
452
|
+
|
453
|
+
### Authorization
|
454
|
+
|
455
|
+
[basic](../README.md#basic)
|
456
|
+
|
457
|
+
### HTTP request headers
|
458
|
+
|
459
|
+
- **Content-Type**: multipart/form-data
|
460
|
+
- **Accept**: Not defined
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
# **thumbnail**
|
465
|
+
> File thumbnail(opts)
|
466
|
+
|
467
|
+
Get package thumbnail
|
468
|
+
|
469
|
+
Returns the package's thumbnail image.
|
470
|
+
|
471
|
+
### Example
|
472
|
+
```ruby
|
473
|
+
# load the gem
|
474
|
+
require 'crx_packmgr_api_client'
|
475
|
+
# setup authorization
|
476
|
+
CrxPackageManager.configure do |config|
|
477
|
+
# Configure HTTP basic authorization: basic
|
478
|
+
config.username = 'YOUR USERNAME'
|
479
|
+
config.password = 'YOUR PASSWORD'
|
480
|
+
end
|
481
|
+
|
482
|
+
api_instance = CrxPackageManager::DefaultApi.new
|
483
|
+
|
484
|
+
opts = {
|
485
|
+
path: "path_example" # String | The path to the package.
|
486
|
+
}
|
487
|
+
|
488
|
+
begin
|
489
|
+
#Get package thumbnail
|
490
|
+
result = api_instance.thumbnail(opts)
|
491
|
+
p result
|
492
|
+
rescue CrxPackageManager::ApiError => e
|
493
|
+
puts "Exception when calling DefaultApi->thumbnail: #{e}"
|
494
|
+
end
|
495
|
+
```
|
496
|
+
|
497
|
+
### Parameters
|
498
|
+
|
499
|
+
Name | Type | Description | Notes
|
500
|
+
------------- | ------------- | ------------- | -------------
|
501
|
+
**path** | **String**| The path to the package. | [optional]
|
502
|
+
|
503
|
+
### Return type
|
504
|
+
|
505
|
+
**File**
|
506
|
+
|
507
|
+
### Authorization
|
508
|
+
|
509
|
+
[basic](../README.md#basic)
|
510
|
+
|
511
|
+
### HTTP request headers
|
512
|
+
|
513
|
+
- **Content-Type**: Not defined
|
514
|
+
- **Accept**: image/jpg, image/jpeg, image/png
|
65
515
|
|
66
516
|
|
67
517
|
|