pulp_ansible_client 0.2.0b1
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 +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +79 -0
- data/README.md +150 -0
- data/Rakefile +10 -0
- data/docs/AnsibleCollectionsApi.md +66 -0
- data/docs/AnsibleDistribution.md +31 -0
- data/docs/AnsibleRemote.md +45 -0
- data/docs/AsyncOperationResponse.md +17 -0
- data/docs/Collection.md +41 -0
- data/docs/CollectionRemote.md +47 -0
- data/docs/ContentCollectionsApi.md +134 -0
- data/docs/ContentRolesApi.md +186 -0
- data/docs/DistributionsAnsibleApi.md +352 -0
- data/docs/GalaxyCollection.md +25 -0
- data/docs/GalaxyRole.md +21 -0
- data/docs/GalaxyRoleVersion.md +19 -0
- data/docs/InlineResponse200.md +23 -0
- data/docs/InlineResponse2001.md +23 -0
- data/docs/InlineResponse2002.md +23 -0
- data/docs/InlineResponse2003.md +23 -0
- data/docs/InlineResponse2004.md +23 -0
- data/docs/InlineResponse2005.md +23 -0
- data/docs/InlineResponse2006.md +23 -0
- data/docs/InlineResponse2007.md +23 -0
- data/docs/PulpAnsibleApiApi.md +60 -0
- data/docs/PulpAnsibleGalaxyApiCollectionsApi.md +113 -0
- data/docs/PulpAnsibleGalaxyApiRolesApi.md +67 -0
- data/docs/PulpAnsibleGalaxyApiV1VersionsApi.md +69 -0
- data/docs/PulpAnsibleGalaxyApiV2VersionsApi.md +67 -0
- data/docs/RemotesAnsibleApi.md +411 -0
- data/docs/RemotesCollectionApi.md +411 -0
- data/docs/RepositorySyncURL.md +19 -0
- data/docs/Role.md +29 -0
- data/git_push.sh +55 -0
- data/lib/pulp_ansible_client/api/ansible_collections_api.rb +94 -0
- data/lib/pulp_ansible_client/api/content_collections_api.rb +169 -0
- data/lib/pulp_ansible_client/api/content_roles_api.rb +228 -0
- data/lib/pulp_ansible_client/api/distributions_ansible_api.rb +430 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_api_api.rb +80 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb +140 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_roles_api.rb +88 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v1_versions_api.rb +94 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v2_versions_api.rb +88 -0
- data/lib/pulp_ansible_client/api/remotes_ansible_api.rb +504 -0
- data/lib/pulp_ansible_client/api/remotes_collection_api.rb +504 -0
- data/lib/pulp_ansible_client/api_client.rb +387 -0
- data/lib/pulp_ansible_client/api_error.rb +57 -0
- data/lib/pulp_ansible_client/configuration.rb +251 -0
- data/lib/pulp_ansible_client/models/ansible_distribution.rb +347 -0
- data/lib/pulp_ansible_client/models/ansible_remote.rb +539 -0
- data/lib/pulp_ansible_client/models/async_operation_response.rb +202 -0
- data/lib/pulp_ansible_client/models/collection.rb +494 -0
- data/lib/pulp_ansible_client/models/collection_remote.rb +572 -0
- data/lib/pulp_ansible_client/models/galaxy_collection.rb +304 -0
- data/lib/pulp_ansible_client/models/galaxy_role.rb +262 -0
- data/lib/pulp_ansible_client/models/galaxy_role_version.rb +229 -0
- data/lib/pulp_ansible_client/models/inline_response200.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2001.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2002.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2003.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2004.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2005.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2006.rb +235 -0
- data/lib/pulp_ansible_client/models/inline_response2007.rb +235 -0
- data/lib/pulp_ansible_client/models/repository_sync_url.rb +214 -0
- data/lib/pulp_ansible_client/models/role.rb +344 -0
- data/lib/pulp_ansible_client/version.rb +15 -0
- data/lib/pulp_ansible_client.rb +68 -0
- data/pulp_ansible_client.gemspec +45 -0
- data/spec/api/ansible_collections_api_spec.rb +48 -0
- data/spec/api/content_collections_api_spec.rb +67 -0
- data/spec/api/content_roles_api_spec.rb +78 -0
- data/spec/api/distributions_ansible_api_spec.rb +116 -0
- data/spec/api/pulp_ansible_api_api_spec.rb +46 -0
- data/spec/api/pulp_ansible_galaxy_api_collections_api_spec.rb +57 -0
- data/spec/api/pulp_ansible_galaxy_api_roles_api_spec.rb +48 -0
- data/spec/api/pulp_ansible_galaxy_api_v1_versions_api_spec.rb +49 -0
- data/spec/api/pulp_ansible_galaxy_api_v2_versions_api_spec.rb +48 -0
- data/spec/api/remotes_ansible_api_spec.rb +130 -0
- data/spec/api/remotes_collection_api_spec.rb +130 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/ansible_distribution_spec.rb +83 -0
- data/spec/models/ansible_remote_spec.rb +129 -0
- data/spec/models/async_operation_response_spec.rb +41 -0
- data/spec/models/collection_remote_spec.rb +135 -0
- data/spec/models/collection_spec.rb +113 -0
- data/spec/models/galaxy_collection_spec.rb +65 -0
- data/spec/models/galaxy_role_spec.rb +53 -0
- data/spec/models/galaxy_role_version_spec.rb +47 -0
- data/spec/models/inline_response2001_spec.rb +59 -0
- data/spec/models/inline_response2002_spec.rb +59 -0
- data/spec/models/inline_response2003_spec.rb +59 -0
- data/spec/models/inline_response2004_spec.rb +59 -0
- data/spec/models/inline_response2005_spec.rb +59 -0
- data/spec/models/inline_response2006_spec.rb +59 -0
- data/spec/models/inline_response2007_spec.rb +59 -0
- data/spec/models/inline_response200_spec.rb +59 -0
- data/spec/models/repository_sync_url_spec.rb +47 -0
- data/spec/models/role_spec.rb +77 -0
- data/spec/spec_helper.rb +111 -0
- metadata +357 -0
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# PulpAnsibleClient::ContentRolesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create**](ContentRolesApi.md#create) | **POST** /pulp/api/v3/content/ansible/roles/ | Create a role
|
|
8
|
+
[**list**](ContentRolesApi.md#list) | **GET** /pulp/api/v3/content/ansible/roles/ | List roles
|
|
9
|
+
[**read**](ContentRolesApi.md#read) | **GET** {role_href} | Inspect a role
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## create
|
|
14
|
+
|
|
15
|
+
> Role create(data)
|
|
16
|
+
|
|
17
|
+
Create a role
|
|
18
|
+
|
|
19
|
+
ViewSet for Role.
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
# load the gem
|
|
25
|
+
require 'pulp_ansible_client'
|
|
26
|
+
# setup authorization
|
|
27
|
+
PulpAnsibleClient.configure do |config|
|
|
28
|
+
# Configure HTTP basic authorization: Basic
|
|
29
|
+
config.username = 'YOUR USERNAME'
|
|
30
|
+
config.password = 'YOUR PASSWORD'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = PulpAnsibleClient::ContentRolesApi.new
|
|
34
|
+
data = PulpAnsibleClient::Role.new # Role |
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
#Create a role
|
|
38
|
+
result = api_instance.create(data)
|
|
39
|
+
p result
|
|
40
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
41
|
+
puts "Exception when calling ContentRolesApi->create: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**data** | [**Role**](Role.md)| |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**Role**](Role.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[Basic](../README.md#Basic)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: application/json
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## list
|
|
67
|
+
|
|
68
|
+
> InlineResponse2001 list(opts)
|
|
69
|
+
|
|
70
|
+
List roles
|
|
71
|
+
|
|
72
|
+
ViewSet for Role.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```ruby
|
|
77
|
+
# load the gem
|
|
78
|
+
require 'pulp_ansible_client'
|
|
79
|
+
# setup authorization
|
|
80
|
+
PulpAnsibleClient.configure do |config|
|
|
81
|
+
# Configure HTTP basic authorization: Basic
|
|
82
|
+
config.username = 'YOUR USERNAME'
|
|
83
|
+
config.password = 'YOUR PASSWORD'
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
api_instance = PulpAnsibleClient::ContentRolesApi.new
|
|
87
|
+
opts = {
|
|
88
|
+
name: 'name_example', # String | Filter results where name matches value
|
|
89
|
+
namespace: 'namespace_example', # String | Filter results where namespace matches value
|
|
90
|
+
version: 'version_example', # String | Filter results where version matches value
|
|
91
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
|
92
|
+
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
|
93
|
+
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
|
|
94
|
+
page: 56, # Integer | A page number within the paginated result set.
|
|
95
|
+
page_size: 56 # Integer | Number of results to return per page.
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
begin
|
|
99
|
+
#List roles
|
|
100
|
+
result = api_instance.list(opts)
|
|
101
|
+
p result
|
|
102
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
103
|
+
puts "Exception when calling ContentRolesApi->list: #{e}"
|
|
104
|
+
end
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Parameters
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
Name | Type | Description | Notes
|
|
111
|
+
------------- | ------------- | ------------- | -------------
|
|
112
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
|
113
|
+
**namespace** | **String**| Filter results where namespace matches value | [optional]
|
|
114
|
+
**version** | **String**| Filter results where version matches value | [optional]
|
|
115
|
+
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
|
116
|
+
**repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
|
|
117
|
+
**repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
|
|
118
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
|
119
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
|
120
|
+
|
|
121
|
+
### Return type
|
|
122
|
+
|
|
123
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
|
124
|
+
|
|
125
|
+
### Authorization
|
|
126
|
+
|
|
127
|
+
[Basic](../README.md#Basic)
|
|
128
|
+
|
|
129
|
+
### HTTP request headers
|
|
130
|
+
|
|
131
|
+
- **Content-Type**: Not defined
|
|
132
|
+
- **Accept**: application/json
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
## read
|
|
136
|
+
|
|
137
|
+
> Role read(role_href)
|
|
138
|
+
|
|
139
|
+
Inspect a role
|
|
140
|
+
|
|
141
|
+
ViewSet for Role.
|
|
142
|
+
|
|
143
|
+
### Example
|
|
144
|
+
|
|
145
|
+
```ruby
|
|
146
|
+
# load the gem
|
|
147
|
+
require 'pulp_ansible_client'
|
|
148
|
+
# setup authorization
|
|
149
|
+
PulpAnsibleClient.configure do |config|
|
|
150
|
+
# Configure HTTP basic authorization: Basic
|
|
151
|
+
config.username = 'YOUR USERNAME'
|
|
152
|
+
config.password = 'YOUR PASSWORD'
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
api_instance = PulpAnsibleClient::ContentRolesApi.new
|
|
156
|
+
role_href = 'role_href_example' # String | URI of Role. e.g.: /pulp/api/v3/content/ansible/roles/1/
|
|
157
|
+
|
|
158
|
+
begin
|
|
159
|
+
#Inspect a role
|
|
160
|
+
result = api_instance.read(role_href)
|
|
161
|
+
p result
|
|
162
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
163
|
+
puts "Exception when calling ContentRolesApi->read: #{e}"
|
|
164
|
+
end
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
Name | Type | Description | Notes
|
|
171
|
+
------------- | ------------- | ------------- | -------------
|
|
172
|
+
**role_href** | **String**| URI of Role. e.g.: /pulp/api/v3/content/ansible/roles/1/ |
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
[**Role**](Role.md)
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
[Basic](../README.md#Basic)
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: Not defined
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
@@ -0,0 +1,352 @@
|
|
|
1
|
+
# PulpAnsibleClient::DistributionsAnsibleApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create**](DistributionsAnsibleApi.md#create) | **POST** /pulp/api/v3/distributions/ansible/ansible/ | Create an ansible distribution
|
|
8
|
+
[**delete**](DistributionsAnsibleApi.md#delete) | **DELETE** {ansible_distribution_href} | Delete an ansible distribution
|
|
9
|
+
[**list**](DistributionsAnsibleApi.md#list) | **GET** /pulp/api/v3/distributions/ansible/ansible/ | List ansible distributions
|
|
10
|
+
[**partial_update**](DistributionsAnsibleApi.md#partial_update) | **PATCH** {ansible_distribution_href} | Partially update an ansible distribution
|
|
11
|
+
[**read**](DistributionsAnsibleApi.md#read) | **GET** {ansible_distribution_href} | Inspect an ansible distribution
|
|
12
|
+
[**update**](DistributionsAnsibleApi.md#update) | **PUT** {ansible_distribution_href} | Update an ansible distribution
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## create
|
|
17
|
+
|
|
18
|
+
> AsyncOperationResponse create(data)
|
|
19
|
+
|
|
20
|
+
Create an ansible distribution
|
|
21
|
+
|
|
22
|
+
Trigger an asynchronous create task
|
|
23
|
+
|
|
24
|
+
### Example
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
# load the gem
|
|
28
|
+
require 'pulp_ansible_client'
|
|
29
|
+
# setup authorization
|
|
30
|
+
PulpAnsibleClient.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 = PulpAnsibleClient::DistributionsAnsibleApi.new
|
|
37
|
+
data = PulpAnsibleClient::AnsibleDistribution.new # AnsibleDistribution |
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
#Create an ansible distribution
|
|
41
|
+
result = api_instance.create(data)
|
|
42
|
+
p result
|
|
43
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
44
|
+
puts "Exception when calling DistributionsAnsibleApi->create: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
Name | Type | Description | Notes
|
|
52
|
+
------------- | ------------- | ------------- | -------------
|
|
53
|
+
**data** | [**AnsibleDistribution**](AnsibleDistribution.md)| |
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[Basic](../README.md#Basic)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: application/json
|
|
66
|
+
- **Accept**: application/json
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
## delete
|
|
70
|
+
|
|
71
|
+
> AsyncOperationResponse delete(ansible_distribution_href)
|
|
72
|
+
|
|
73
|
+
Delete an ansible distribution
|
|
74
|
+
|
|
75
|
+
Trigger an asynchronous delete task
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
|
|
79
|
+
```ruby
|
|
80
|
+
# load the gem
|
|
81
|
+
require 'pulp_ansible_client'
|
|
82
|
+
# setup authorization
|
|
83
|
+
PulpAnsibleClient.configure do |config|
|
|
84
|
+
# Configure HTTP basic authorization: Basic
|
|
85
|
+
config.username = 'YOUR USERNAME'
|
|
86
|
+
config.password = 'YOUR PASSWORD'
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
|
|
90
|
+
ansible_distribution_href = 'ansible_distribution_href_example' # String | URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/
|
|
91
|
+
|
|
92
|
+
begin
|
|
93
|
+
#Delete an ansible distribution
|
|
94
|
+
result = api_instance.delete(ansible_distribution_href)
|
|
95
|
+
p result
|
|
96
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
97
|
+
puts "Exception when calling DistributionsAnsibleApi->delete: #{e}"
|
|
98
|
+
end
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Parameters
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
Name | Type | Description | Notes
|
|
105
|
+
------------- | ------------- | ------------- | -------------
|
|
106
|
+
**ansible_distribution_href** | **String**| URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/ |
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[Basic](../README.md#Basic)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
## list
|
|
123
|
+
|
|
124
|
+
> InlineResponse2002 list(opts)
|
|
125
|
+
|
|
126
|
+
List ansible distributions
|
|
127
|
+
|
|
128
|
+
ViewSet for Ansible Distributions.
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```ruby
|
|
133
|
+
# load the gem
|
|
134
|
+
require 'pulp_ansible_client'
|
|
135
|
+
# setup authorization
|
|
136
|
+
PulpAnsibleClient.configure do |config|
|
|
137
|
+
# Configure HTTP basic authorization: Basic
|
|
138
|
+
config.username = 'YOUR USERNAME'
|
|
139
|
+
config.password = 'YOUR PASSWORD'
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
|
|
143
|
+
opts = {
|
|
144
|
+
name: 'name_example', # String |
|
|
145
|
+
name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
|
|
146
|
+
base_path: 'base_path_example', # String |
|
|
147
|
+
base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
|
|
148
|
+
base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
|
|
149
|
+
base_path__in: 'base_path__in_example', # String | Filter results where base_path is in a comma-separated list of values
|
|
150
|
+
page: 56, # Integer | A page number within the paginated result set.
|
|
151
|
+
page_size: 56 # Integer | Number of results to return per page.
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
begin
|
|
155
|
+
#List ansible distributions
|
|
156
|
+
result = api_instance.list(opts)
|
|
157
|
+
p result
|
|
158
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
159
|
+
puts "Exception when calling DistributionsAnsibleApi->list: #{e}"
|
|
160
|
+
end
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Parameters
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
Name | Type | Description | Notes
|
|
167
|
+
------------- | ------------- | ------------- | -------------
|
|
168
|
+
**name** | **String**| | [optional]
|
|
169
|
+
**name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
|
|
170
|
+
**base_path** | **String**| | [optional]
|
|
171
|
+
**base_path__contains** | **String**| Filter results where base_path contains value | [optional]
|
|
172
|
+
**base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
|
|
173
|
+
**base_path__in** | **String**| Filter results where base_path is in a comma-separated list of values | [optional]
|
|
174
|
+
**page** | **Integer**| A page number within the paginated result set. | [optional]
|
|
175
|
+
**page_size** | **Integer**| Number of results to return per page. | [optional]
|
|
176
|
+
|
|
177
|
+
### Return type
|
|
178
|
+
|
|
179
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
180
|
+
|
|
181
|
+
### Authorization
|
|
182
|
+
|
|
183
|
+
[Basic](../README.md#Basic)
|
|
184
|
+
|
|
185
|
+
### HTTP request headers
|
|
186
|
+
|
|
187
|
+
- **Content-Type**: Not defined
|
|
188
|
+
- **Accept**: application/json
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
## partial_update
|
|
192
|
+
|
|
193
|
+
> AsyncOperationResponse partial_update(ansible_distribution_href, data)
|
|
194
|
+
|
|
195
|
+
Partially update an ansible distribution
|
|
196
|
+
|
|
197
|
+
Trigger an asynchronous partial update task
|
|
198
|
+
|
|
199
|
+
### Example
|
|
200
|
+
|
|
201
|
+
```ruby
|
|
202
|
+
# load the gem
|
|
203
|
+
require 'pulp_ansible_client'
|
|
204
|
+
# setup authorization
|
|
205
|
+
PulpAnsibleClient.configure do |config|
|
|
206
|
+
# Configure HTTP basic authorization: Basic
|
|
207
|
+
config.username = 'YOUR USERNAME'
|
|
208
|
+
config.password = 'YOUR PASSWORD'
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
|
|
212
|
+
ansible_distribution_href = 'ansible_distribution_href_example' # String | URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/
|
|
213
|
+
data = PulpAnsibleClient::AnsibleDistribution.new # AnsibleDistribution |
|
|
214
|
+
|
|
215
|
+
begin
|
|
216
|
+
#Partially update an ansible distribution
|
|
217
|
+
result = api_instance.partial_update(ansible_distribution_href, data)
|
|
218
|
+
p result
|
|
219
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
220
|
+
puts "Exception when calling DistributionsAnsibleApi->partial_update: #{e}"
|
|
221
|
+
end
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Parameters
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
Name | Type | Description | Notes
|
|
228
|
+
------------- | ------------- | ------------- | -------------
|
|
229
|
+
**ansible_distribution_href** | **String**| URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/ |
|
|
230
|
+
**data** | [**AnsibleDistribution**](AnsibleDistribution.md)| |
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
235
|
+
|
|
236
|
+
### Authorization
|
|
237
|
+
|
|
238
|
+
[Basic](../README.md#Basic)
|
|
239
|
+
|
|
240
|
+
### HTTP request headers
|
|
241
|
+
|
|
242
|
+
- **Content-Type**: application/json
|
|
243
|
+
- **Accept**: application/json
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
## read
|
|
247
|
+
|
|
248
|
+
> AnsibleDistribution read(ansible_distribution_href)
|
|
249
|
+
|
|
250
|
+
Inspect an ansible distribution
|
|
251
|
+
|
|
252
|
+
ViewSet for Ansible Distributions.
|
|
253
|
+
|
|
254
|
+
### Example
|
|
255
|
+
|
|
256
|
+
```ruby
|
|
257
|
+
# load the gem
|
|
258
|
+
require 'pulp_ansible_client'
|
|
259
|
+
# setup authorization
|
|
260
|
+
PulpAnsibleClient.configure do |config|
|
|
261
|
+
# Configure HTTP basic authorization: Basic
|
|
262
|
+
config.username = 'YOUR USERNAME'
|
|
263
|
+
config.password = 'YOUR PASSWORD'
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
|
|
267
|
+
ansible_distribution_href = 'ansible_distribution_href_example' # String | URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/
|
|
268
|
+
|
|
269
|
+
begin
|
|
270
|
+
#Inspect an ansible distribution
|
|
271
|
+
result = api_instance.read(ansible_distribution_href)
|
|
272
|
+
p result
|
|
273
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
274
|
+
puts "Exception when calling DistributionsAnsibleApi->read: #{e}"
|
|
275
|
+
end
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
### Parameters
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
Name | Type | Description | Notes
|
|
282
|
+
------------- | ------------- | ------------- | -------------
|
|
283
|
+
**ansible_distribution_href** | **String**| URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/ |
|
|
284
|
+
|
|
285
|
+
### Return type
|
|
286
|
+
|
|
287
|
+
[**AnsibleDistribution**](AnsibleDistribution.md)
|
|
288
|
+
|
|
289
|
+
### Authorization
|
|
290
|
+
|
|
291
|
+
[Basic](../README.md#Basic)
|
|
292
|
+
|
|
293
|
+
### HTTP request headers
|
|
294
|
+
|
|
295
|
+
- **Content-Type**: Not defined
|
|
296
|
+
- **Accept**: application/json
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
## update
|
|
300
|
+
|
|
301
|
+
> AsyncOperationResponse update(ansible_distribution_href, data)
|
|
302
|
+
|
|
303
|
+
Update an ansible distribution
|
|
304
|
+
|
|
305
|
+
Trigger an asynchronous update task
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
|
|
309
|
+
```ruby
|
|
310
|
+
# load the gem
|
|
311
|
+
require 'pulp_ansible_client'
|
|
312
|
+
# setup authorization
|
|
313
|
+
PulpAnsibleClient.configure do |config|
|
|
314
|
+
# Configure HTTP basic authorization: Basic
|
|
315
|
+
config.username = 'YOUR USERNAME'
|
|
316
|
+
config.password = 'YOUR PASSWORD'
|
|
317
|
+
end
|
|
318
|
+
|
|
319
|
+
api_instance = PulpAnsibleClient::DistributionsAnsibleApi.new
|
|
320
|
+
ansible_distribution_href = 'ansible_distribution_href_example' # String | URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/
|
|
321
|
+
data = PulpAnsibleClient::AnsibleDistribution.new # AnsibleDistribution |
|
|
322
|
+
|
|
323
|
+
begin
|
|
324
|
+
#Update an ansible distribution
|
|
325
|
+
result = api_instance.update(ansible_distribution_href, data)
|
|
326
|
+
p result
|
|
327
|
+
rescue PulpAnsibleClient::ApiError => e
|
|
328
|
+
puts "Exception when calling DistributionsAnsibleApi->update: #{e}"
|
|
329
|
+
end
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
Name | Type | Description | Notes
|
|
336
|
+
------------- | ------------- | ------------- | -------------
|
|
337
|
+
**ansible_distribution_href** | **String**| URI of Ansible Distribution. e.g.: /pulp/api/v3/distributions/ansible/ansible/1/ |
|
|
338
|
+
**data** | [**AnsibleDistribution**](AnsibleDistribution.md)| |
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
[Basic](../README.md#Basic)
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: application/json
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# PulpAnsibleClient::GalaxyCollection
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | |
|
|
8
|
+
**namespace** | **String** | |
|
|
9
|
+
**version** | **String** | |
|
|
10
|
+
**href** | **String** | | [optional]
|
|
11
|
+
**versions_url** | **String** | | [optional]
|
|
12
|
+
|
|
13
|
+
## Code Sample
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'PulpAnsibleClient'
|
|
17
|
+
|
|
18
|
+
instance = PulpAnsibleClient::GalaxyCollection.new(name: null,
|
|
19
|
+
namespace: null,
|
|
20
|
+
version: null,
|
|
21
|
+
href: null,
|
|
22
|
+
versions_url: null)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
|
data/docs/GalaxyRole.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# PulpAnsibleClient::GalaxyRole
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **String** | | [optional]
|
|
8
|
+
**name** | **String** | |
|
|
9
|
+
**namespace** | **String** | |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'PulpAnsibleClient'
|
|
15
|
+
|
|
16
|
+
instance = PulpAnsibleClient::GalaxyRole.new(id: null,
|
|
17
|
+
name: null,
|
|
18
|
+
namespace: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# PulpAnsibleClient::GalaxyRoleVersion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | |
|
|
8
|
+
**source** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'PulpAnsibleClient'
|
|
14
|
+
|
|
15
|
+
instance = PulpAnsibleClient::GalaxyRoleVersion.new(name: null,
|
|
16
|
+
source: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PulpAnsibleClient::InlineResponse200
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**_next** | **String** | | [optional]
|
|
8
|
+
**previous** | **String** | | [optional]
|
|
9
|
+
**count** | **Integer** | |
|
|
10
|
+
**results** | [**Array<Collection>**](Collection.md) | |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'PulpAnsibleClient'
|
|
16
|
+
|
|
17
|
+
instance = PulpAnsibleClient::InlineResponse200.new(_next: null,
|
|
18
|
+
previous: null,
|
|
19
|
+
count: null,
|
|
20
|
+
results: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PulpAnsibleClient::InlineResponse2001
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**_next** | **String** | | [optional]
|
|
8
|
+
**previous** | **String** | | [optional]
|
|
9
|
+
**count** | **Integer** | |
|
|
10
|
+
**results** | [**Array<Role>**](Role.md) | |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'PulpAnsibleClient'
|
|
16
|
+
|
|
17
|
+
instance = PulpAnsibleClient::InlineResponse2001.new(_next: null,
|
|
18
|
+
previous: null,
|
|
19
|
+
count: null,
|
|
20
|
+
results: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PulpAnsibleClient::InlineResponse2002
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**_next** | **String** | | [optional]
|
|
8
|
+
**previous** | **String** | | [optional]
|
|
9
|
+
**count** | **Integer** | |
|
|
10
|
+
**results** | [**Array<AnsibleDistribution>**](AnsibleDistribution.md) | |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'PulpAnsibleClient'
|
|
16
|
+
|
|
17
|
+
instance = PulpAnsibleClient::InlineResponse2002.new(_next: null,
|
|
18
|
+
previous: null,
|
|
19
|
+
count: null,
|
|
20
|
+
results: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# PulpAnsibleClient::InlineResponse2003
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**_next** | **String** | | [optional]
|
|
8
|
+
**previous** | **String** | | [optional]
|
|
9
|
+
**count** | **Integer** | |
|
|
10
|
+
**results** | [**Array<AnsibleRemote>**](AnsibleRemote.md) | |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'PulpAnsibleClient'
|
|
16
|
+
|
|
17
|
+
instance = PulpAnsibleClient::InlineResponse2003.new(_next: null,
|
|
18
|
+
previous: null,
|
|
19
|
+
count: null,
|
|
20
|
+
results: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|