pulp_ansible_client 0.2.0b1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +79 -0
  4. data/README.md +150 -0
  5. data/Rakefile +10 -0
  6. data/docs/AnsibleCollectionsApi.md +66 -0
  7. data/docs/AnsibleDistribution.md +31 -0
  8. data/docs/AnsibleRemote.md +45 -0
  9. data/docs/AsyncOperationResponse.md +17 -0
  10. data/docs/Collection.md +41 -0
  11. data/docs/CollectionRemote.md +47 -0
  12. data/docs/ContentCollectionsApi.md +134 -0
  13. data/docs/ContentRolesApi.md +186 -0
  14. data/docs/DistributionsAnsibleApi.md +352 -0
  15. data/docs/GalaxyCollection.md +25 -0
  16. data/docs/GalaxyRole.md +21 -0
  17. data/docs/GalaxyRoleVersion.md +19 -0
  18. data/docs/InlineResponse200.md +23 -0
  19. data/docs/InlineResponse2001.md +23 -0
  20. data/docs/InlineResponse2002.md +23 -0
  21. data/docs/InlineResponse2003.md +23 -0
  22. data/docs/InlineResponse2004.md +23 -0
  23. data/docs/InlineResponse2005.md +23 -0
  24. data/docs/InlineResponse2006.md +23 -0
  25. data/docs/InlineResponse2007.md +23 -0
  26. data/docs/PulpAnsibleApiApi.md +60 -0
  27. data/docs/PulpAnsibleGalaxyApiCollectionsApi.md +113 -0
  28. data/docs/PulpAnsibleGalaxyApiRolesApi.md +67 -0
  29. data/docs/PulpAnsibleGalaxyApiV1VersionsApi.md +69 -0
  30. data/docs/PulpAnsibleGalaxyApiV2VersionsApi.md +67 -0
  31. data/docs/RemotesAnsibleApi.md +411 -0
  32. data/docs/RemotesCollectionApi.md +411 -0
  33. data/docs/RepositorySyncURL.md +19 -0
  34. data/docs/Role.md +29 -0
  35. data/git_push.sh +55 -0
  36. data/lib/pulp_ansible_client/api/ansible_collections_api.rb +94 -0
  37. data/lib/pulp_ansible_client/api/content_collections_api.rb +169 -0
  38. data/lib/pulp_ansible_client/api/content_roles_api.rb +228 -0
  39. data/lib/pulp_ansible_client/api/distributions_ansible_api.rb +430 -0
  40. data/lib/pulp_ansible_client/api/pulp_ansible_api_api.rb +80 -0
  41. data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb +140 -0
  42. data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_roles_api.rb +88 -0
  43. data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v1_versions_api.rb +94 -0
  44. data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v2_versions_api.rb +88 -0
  45. data/lib/pulp_ansible_client/api/remotes_ansible_api.rb +504 -0
  46. data/lib/pulp_ansible_client/api/remotes_collection_api.rb +504 -0
  47. data/lib/pulp_ansible_client/api_client.rb +387 -0
  48. data/lib/pulp_ansible_client/api_error.rb +57 -0
  49. data/lib/pulp_ansible_client/configuration.rb +251 -0
  50. data/lib/pulp_ansible_client/models/ansible_distribution.rb +347 -0
  51. data/lib/pulp_ansible_client/models/ansible_remote.rb +539 -0
  52. data/lib/pulp_ansible_client/models/async_operation_response.rb +202 -0
  53. data/lib/pulp_ansible_client/models/collection.rb +494 -0
  54. data/lib/pulp_ansible_client/models/collection_remote.rb +572 -0
  55. data/lib/pulp_ansible_client/models/galaxy_collection.rb +304 -0
  56. data/lib/pulp_ansible_client/models/galaxy_role.rb +262 -0
  57. data/lib/pulp_ansible_client/models/galaxy_role_version.rb +229 -0
  58. data/lib/pulp_ansible_client/models/inline_response200.rb +235 -0
  59. data/lib/pulp_ansible_client/models/inline_response2001.rb +235 -0
  60. data/lib/pulp_ansible_client/models/inline_response2002.rb +235 -0
  61. data/lib/pulp_ansible_client/models/inline_response2003.rb +235 -0
  62. data/lib/pulp_ansible_client/models/inline_response2004.rb +235 -0
  63. data/lib/pulp_ansible_client/models/inline_response2005.rb +235 -0
  64. data/lib/pulp_ansible_client/models/inline_response2006.rb +235 -0
  65. data/lib/pulp_ansible_client/models/inline_response2007.rb +235 -0
  66. data/lib/pulp_ansible_client/models/repository_sync_url.rb +214 -0
  67. data/lib/pulp_ansible_client/models/role.rb +344 -0
  68. data/lib/pulp_ansible_client/version.rb +15 -0
  69. data/lib/pulp_ansible_client.rb +68 -0
  70. data/pulp_ansible_client.gemspec +45 -0
  71. data/spec/api/ansible_collections_api_spec.rb +48 -0
  72. data/spec/api/content_collections_api_spec.rb +67 -0
  73. data/spec/api/content_roles_api_spec.rb +78 -0
  74. data/spec/api/distributions_ansible_api_spec.rb +116 -0
  75. data/spec/api/pulp_ansible_api_api_spec.rb +46 -0
  76. data/spec/api/pulp_ansible_galaxy_api_collections_api_spec.rb +57 -0
  77. data/spec/api/pulp_ansible_galaxy_api_roles_api_spec.rb +48 -0
  78. data/spec/api/pulp_ansible_galaxy_api_v1_versions_api_spec.rb +49 -0
  79. data/spec/api/pulp_ansible_galaxy_api_v2_versions_api_spec.rb +48 -0
  80. data/spec/api/remotes_ansible_api_spec.rb +130 -0
  81. data/spec/api/remotes_collection_api_spec.rb +130 -0
  82. data/spec/api_client_spec.rb +226 -0
  83. data/spec/configuration_spec.rb +42 -0
  84. data/spec/models/ansible_distribution_spec.rb +83 -0
  85. data/spec/models/ansible_remote_spec.rb +129 -0
  86. data/spec/models/async_operation_response_spec.rb +41 -0
  87. data/spec/models/collection_remote_spec.rb +135 -0
  88. data/spec/models/collection_spec.rb +113 -0
  89. data/spec/models/galaxy_collection_spec.rb +65 -0
  90. data/spec/models/galaxy_role_spec.rb +53 -0
  91. data/spec/models/galaxy_role_version_spec.rb +47 -0
  92. data/spec/models/inline_response2001_spec.rb +59 -0
  93. data/spec/models/inline_response2002_spec.rb +59 -0
  94. data/spec/models/inline_response2003_spec.rb +59 -0
  95. data/spec/models/inline_response2004_spec.rb +59 -0
  96. data/spec/models/inline_response2005_spec.rb +59 -0
  97. data/spec/models/inline_response2006_spec.rb +59 -0
  98. data/spec/models/inline_response2007_spec.rb +59 -0
  99. data/spec/models/inline_response200_spec.rb +59 -0
  100. data/spec/models/repository_sync_url_spec.rb +47 -0
  101. data/spec/models/role_spec.rb +77 -0
  102. data/spec/spec_helper.rb +111 -0
  103. metadata +357 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 1a018bf410325e068ce2a4c93eccecd6fcc78e032abe8139b02ece375e4db0b4
4
+ data.tar.gz: f1cb68dced871d44691ee37e92f28fe885e972bca9c050052c88d066932b537b
5
+ SHA512:
6
+ metadata.gz: cb283a853c079622827edc8e5681086d91929ca9ac5e753e07811053bcc96def358fc7fa1ef27e38ca37d3d6ad6e76b38efb5747065a1b7b59d794d550d41a87
7
+ data.tar.gz: 1c33af5d84d23058051cfb188767ea58b5d72c8bfdd219f4f686119fb8f699c24ade07b2da8eb2c45eceabb7aa2946fbafead47b08a098a2d7436f8fc8893f9c
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,79 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ pulp_ansible_client (0.2.0b1)
5
+ json (~> 2.1, >= 2.1.0)
6
+ typhoeus (~> 1.0, >= 1.0.1)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ ZenTest (4.11.2)
12
+ addressable (2.5.2)
13
+ public_suffix (>= 2.0.2, < 4.0)
14
+ autotest (4.4.6)
15
+ ZenTest (>= 4.4.1)
16
+ autotest-fsevent (0.2.14)
17
+ sys-uname
18
+ autotest-growl (0.2.16)
19
+ autotest-rails-pure (4.1.2)
20
+ byebug (10.0.2)
21
+ coderay (1.1.2)
22
+ crack (0.4.3)
23
+ safe_yaml (~> 1.0.0)
24
+ diff-lcs (1.3)
25
+ ethon (0.11.0)
26
+ ffi (>= 1.3.0)
27
+ ffi (1.9.25)
28
+ hashdiff (0.3.7)
29
+ json (2.1.0)
30
+ method_source (0.9.0)
31
+ pry (0.11.3)
32
+ coderay (~> 1.1.0)
33
+ method_source (~> 0.9.0)
34
+ pry-byebug (3.6.0)
35
+ byebug (~> 10.0)
36
+ pry (~> 0.10)
37
+ public_suffix (3.0.3)
38
+ rake (12.0.0)
39
+ rspec (3.8.0)
40
+ rspec-core (~> 3.8.0)
41
+ rspec-expectations (~> 3.8.0)
42
+ rspec-mocks (~> 3.8.0)
43
+ rspec-core (3.8.0)
44
+ rspec-support (~> 3.8.0)
45
+ rspec-expectations (3.8.1)
46
+ diff-lcs (>= 1.2.0, < 2.0)
47
+ rspec-support (~> 3.8.0)
48
+ rspec-mocks (3.8.0)
49
+ diff-lcs (>= 1.2.0, < 2.0)
50
+ rspec-support (~> 3.8.0)
51
+ rspec-support (3.8.0)
52
+ safe_yaml (1.0.4)
53
+ sys-uname (1.0.3)
54
+ ffi (>= 1.0.0)
55
+ typhoeus (1.3.0)
56
+ ethon (>= 0.9.0)
57
+ vcr (3.0.3)
58
+ webmock (1.24.6)
59
+ addressable (>= 2.3.6)
60
+ crack (>= 0.3.2)
61
+ hashdiff
62
+
63
+ PLATFORMS
64
+ ruby
65
+
66
+ DEPENDENCIES
67
+ autotest (~> 4.4, >= 4.4.6)
68
+ autotest-fsevent (~> 0.2, >= 0.2.12)
69
+ autotest-growl (~> 0.2, >= 0.2.16)
70
+ autotest-rails-pure (~> 4.1, >= 4.1.2)
71
+ pulp_ansible_client!
72
+ pry-byebug
73
+ rake (~> 12.0.0)
74
+ rspec (~> 3.6, >= 3.6.0)
75
+ vcr (~> 3.0, >= 3.0.1)
76
+ webmock (~> 1.24, >= 1.24.3)
77
+
78
+ BUNDLED WITH
79
+ 1.16.1
data/README.md ADDED
@@ -0,0 +1,150 @@
1
+ # pulp_ansible_client
2
+
3
+ PulpAnsibleClient - the Ruby gem for the Pulp 3 API
4
+
5
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: v3
10
+ - Package version: 0.2.0b1
11
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build pulp_ansible_client.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./pulp_ansible_client-0.2.0b1.gem
27
+ ```
28
+
29
+ (for development, run `gem install --dev ./pulp_ansible_client-0.2.0b1.gem` to install the development dependencies)
30
+
31
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
+
33
+ Finally add this to the Gemfile:
34
+
35
+ gem 'pulp_ansible_client', '~> 0.2.0b1'
36
+
37
+ ### Install from Git
38
+
39
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
40
+
41
+ gem 'pulp_ansible_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
42
+
43
+ ### Include the Ruby code directly
44
+
45
+ Include the Ruby code directly using `-I` as follows:
46
+
47
+ ```shell
48
+ ruby -Ilib script.rb
49
+ ```
50
+
51
+ ## Getting Started
52
+
53
+ Please follow the [installation](#installation) procedure and then run the following code:
54
+
55
+ ```ruby
56
+ # Load the gem
57
+ require 'pulp_ansible_client'
58
+
59
+ # Setup authorization
60
+ PulpAnsibleClient.configure do |config|
61
+ # Configure HTTP basic authorization: Basic
62
+ config.username = 'YOUR USERNAME'
63
+ config.password = 'YOUR PASSWORD'
64
+ end
65
+
66
+ api_instance = PulpAnsibleClient::AnsibleCollectionsApi.new
67
+ file = File.new('/path/to/file') # File | The Collection tarball.
68
+ opts = {
69
+ sha256: 'sha256_example' # String | An optional sha256 checksum of the uploaded file.
70
+ }
71
+
72
+ begin
73
+ #Upload a collection
74
+ result = api_instance.upload_collection(file, opts)
75
+ p result
76
+ rescue PulpAnsibleClient::ApiError => e
77
+ puts "Exception when calling AnsibleCollectionsApi->upload_collection: #{e}"
78
+ end
79
+
80
+ ```
81
+
82
+ ## Documentation for API Endpoints
83
+
84
+ All URIs are relative to *http://localhost:24817*
85
+
86
+ Class | Method | HTTP request | Description
87
+ ------------ | ------------- | ------------- | -------------
88
+ *PulpAnsibleClient::AnsibleCollectionsApi* | [**upload_collection**](docs/AnsibleCollectionsApi.md#upload_collection) | **POST** /ansible/collections/ | Upload a collection
89
+ *PulpAnsibleClient::ContentCollectionsApi* | [**create**](docs/ContentCollectionsApi.md#create) | **POST** /pulp/api/v3/content/ansible/collections/ | Create a collection
90
+ *PulpAnsibleClient::ContentCollectionsApi* | [**list**](docs/ContentCollectionsApi.md#list) | **GET** /pulp/api/v3/content/ansible/collections/ | List collections
91
+ *PulpAnsibleClient::ContentRolesApi* | [**create**](docs/ContentRolesApi.md#create) | **POST** /pulp/api/v3/content/ansible/roles/ | Create a role
92
+ *PulpAnsibleClient::ContentRolesApi* | [**list**](docs/ContentRolesApi.md#list) | **GET** /pulp/api/v3/content/ansible/roles/ | List roles
93
+ *PulpAnsibleClient::ContentRolesApi* | [**read**](docs/ContentRolesApi.md#read) | **GET** {role_href} | Inspect a role
94
+ *PulpAnsibleClient::DistributionsAnsibleApi* | [**create**](docs/DistributionsAnsibleApi.md#create) | **POST** /pulp/api/v3/distributions/ansible/ansible/ | Create an ansible distribution
95
+ *PulpAnsibleClient::DistributionsAnsibleApi* | [**delete**](docs/DistributionsAnsibleApi.md#delete) | **DELETE** {ansible_distribution_href} | Delete an ansible distribution
96
+ *PulpAnsibleClient::DistributionsAnsibleApi* | [**list**](docs/DistributionsAnsibleApi.md#list) | **GET** /pulp/api/v3/distributions/ansible/ansible/ | List ansible distributions
97
+ *PulpAnsibleClient::DistributionsAnsibleApi* | [**partial_update**](docs/DistributionsAnsibleApi.md#partial_update) | **PATCH** {ansible_distribution_href} | Partially update an ansible distribution
98
+ *PulpAnsibleClient::DistributionsAnsibleApi* | [**read**](docs/DistributionsAnsibleApi.md#read) | **GET** {ansible_distribution_href} | Inspect an ansible distribution
99
+ *PulpAnsibleClient::DistributionsAnsibleApi* | [**update**](docs/DistributionsAnsibleApi.md#update) | **PUT** {ansible_distribution_href} | Update an ansible distribution
100
+ *PulpAnsibleClient::PulpAnsibleApiApi* | [**list**](docs/PulpAnsibleApiApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/ |
101
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi* | [**create**](docs/PulpAnsibleGalaxyApiCollectionsApi.md#create) | **POST** /pulp_ansible/galaxy/{path}/api/v2/collections/ |
102
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi* | [**read**](docs/PulpAnsibleGalaxyApiCollectionsApi.md#read) | **GET** {collection_href} |
103
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiRolesApi* | [**list**](docs/PulpAnsibleGalaxyApiRolesApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v1/roles/ |
104
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiV1VersionsApi* | [**list**](docs/PulpAnsibleGalaxyApiV1VersionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v1/roles/{role_pk}/versions/ |
105
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiV2VersionsApi* | [**list**](docs/PulpAnsibleGalaxyApiV2VersionsApi.md#list) | **GET** {collection_href}versions/ |
106
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**create**](docs/RemotesAnsibleApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/ansible/ | Create an ansible remote
107
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**delete**](docs/RemotesAnsibleApi.md#delete) | **DELETE** {ansible_remote_href} | Delete an ansible remote
108
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**list**](docs/RemotesAnsibleApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/ansible/ | List ansible remotes
109
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**partial_update**](docs/RemotesAnsibleApi.md#partial_update) | **PATCH** {ansible_remote_href} | Partially update an ansible remote
110
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**read**](docs/RemotesAnsibleApi.md#read) | **GET** {ansible_remote_href} | Inspect an ansible remote
111
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**sync**](docs/RemotesAnsibleApi.md#sync) | **POST** {ansible_remote_href}sync/ |
112
+ *PulpAnsibleClient::RemotesAnsibleApi* | [**update**](docs/RemotesAnsibleApi.md#update) | **PUT** {ansible_remote_href} | Update an ansible remote
113
+ *PulpAnsibleClient::RemotesCollectionApi* | [**create**](docs/RemotesCollectionApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/collection/ | Create a collection remote
114
+ *PulpAnsibleClient::RemotesCollectionApi* | [**delete**](docs/RemotesCollectionApi.md#delete) | **DELETE** {collection_remote_href} | Delete a collection remote
115
+ *PulpAnsibleClient::RemotesCollectionApi* | [**list**](docs/RemotesCollectionApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/collection/ | List collection remotes
116
+ *PulpAnsibleClient::RemotesCollectionApi* | [**partial_update**](docs/RemotesCollectionApi.md#partial_update) | **PATCH** {collection_remote_href} | Partially update a collection remote
117
+ *PulpAnsibleClient::RemotesCollectionApi* | [**read**](docs/RemotesCollectionApi.md#read) | **GET** {collection_remote_href} | Inspect a collection remote
118
+ *PulpAnsibleClient::RemotesCollectionApi* | [**sync**](docs/RemotesCollectionApi.md#sync) | **POST** {collection_remote_href}sync/ |
119
+ *PulpAnsibleClient::RemotesCollectionApi* | [**update**](docs/RemotesCollectionApi.md#update) | **PUT** {collection_remote_href} | Update a collection remote
120
+
121
+
122
+ ## Documentation for Models
123
+
124
+ - [PulpAnsibleClient::AnsibleDistribution](docs/AnsibleDistribution.md)
125
+ - [PulpAnsibleClient::AnsibleRemote](docs/AnsibleRemote.md)
126
+ - [PulpAnsibleClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
127
+ - [PulpAnsibleClient::Collection](docs/Collection.md)
128
+ - [PulpAnsibleClient::CollectionRemote](docs/CollectionRemote.md)
129
+ - [PulpAnsibleClient::GalaxyCollection](docs/GalaxyCollection.md)
130
+ - [PulpAnsibleClient::GalaxyRole](docs/GalaxyRole.md)
131
+ - [PulpAnsibleClient::GalaxyRoleVersion](docs/GalaxyRoleVersion.md)
132
+ - [PulpAnsibleClient::InlineResponse200](docs/InlineResponse200.md)
133
+ - [PulpAnsibleClient::InlineResponse2001](docs/InlineResponse2001.md)
134
+ - [PulpAnsibleClient::InlineResponse2002](docs/InlineResponse2002.md)
135
+ - [PulpAnsibleClient::InlineResponse2003](docs/InlineResponse2003.md)
136
+ - [PulpAnsibleClient::InlineResponse2004](docs/InlineResponse2004.md)
137
+ - [PulpAnsibleClient::InlineResponse2005](docs/InlineResponse2005.md)
138
+ - [PulpAnsibleClient::InlineResponse2006](docs/InlineResponse2006.md)
139
+ - [PulpAnsibleClient::InlineResponse2007](docs/InlineResponse2007.md)
140
+ - [PulpAnsibleClient::RepositorySyncURL](docs/RepositorySyncURL.md)
141
+ - [PulpAnsibleClient::Role](docs/Role.md)
142
+
143
+
144
+ ## Documentation for Authorization
145
+
146
+
147
+ ### Basic
148
+
149
+ - **Type**: HTTP basic authentication
150
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
@@ -0,0 +1,66 @@
1
+ # PulpAnsibleClient::AnsibleCollectionsApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**upload_collection**](AnsibleCollectionsApi.md#upload_collection) | **POST** /ansible/collections/ | Upload a collection
8
+
9
+
10
+
11
+ ## upload_collection
12
+
13
+ > AsyncOperationResponse upload_collection(file, opts)
14
+
15
+ Upload a collection
16
+
17
+ Create an artifact and trigger an asynchronous task to create Collection content from it.
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'pulp_ansible_client'
24
+ # setup authorization
25
+ PulpAnsibleClient.configure do |config|
26
+ # Configure HTTP basic authorization: Basic
27
+ config.username = 'YOUR USERNAME'
28
+ config.password = 'YOUR PASSWORD'
29
+ end
30
+
31
+ api_instance = PulpAnsibleClient::AnsibleCollectionsApi.new
32
+ file = File.new('/path/to/file') # File | The Collection tarball.
33
+ opts = {
34
+ sha256: 'sha256_example' # String | An optional sha256 checksum of the uploaded file.
35
+ }
36
+
37
+ begin
38
+ #Upload a collection
39
+ result = api_instance.upload_collection(file, opts)
40
+ p result
41
+ rescue PulpAnsibleClient::ApiError => e
42
+ puts "Exception when calling AnsibleCollectionsApi->upload_collection: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+
49
+ Name | Type | Description | Notes
50
+ ------------- | ------------- | ------------- | -------------
51
+ **file** | **File**| The Collection tarball. |
52
+ **sha256** | **String**| An optional sha256 checksum of the uploaded file. | [optional]
53
+
54
+ ### Return type
55
+
56
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
57
+
58
+ ### Authorization
59
+
60
+ [Basic](../README.md#Basic)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
65
+ - **Accept**: application/json
66
+
@@ -0,0 +1,31 @@
1
+ # PulpAnsibleClient::AnsibleDistribution
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
9
+ **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \&quot;foo\&quot; and \&quot;foo/bar\&quot;) |
10
+ **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional]
11
+ **content_guard** | **String** | An optional content-guard. | [optional]
12
+ **name** | **String** | A unique name. Ex, &#x60;rawhide&#x60; and &#x60;stable&#x60;. |
13
+ **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
14
+ **repository_version** | **String** | RepositoryVersion to be served | [optional]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'PulpAnsibleClient'
20
+
21
+ instance = PulpAnsibleClient::AnsibleDistribution.new(_href: null,
22
+ _created: null,
23
+ base_path: null,
24
+ base_url: null,
25
+ content_guard: null,
26
+ name: null,
27
+ repository: null,
28
+ repository_version: null)
29
+ ```
30
+
31
+
@@ -0,0 +1,45 @@
1
+ # PulpAnsibleClient::AnsibleRemote
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
9
+ **_type** | **String** | | [optional]
10
+ **name** | **String** | A unique name for this remote. |
11
+ **url** | **String** | The URL of an external content source. |
12
+ **ssl_ca_certificate** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
13
+ **ssl_client_certificate** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
14
+ **ssl_client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional]
15
+ **ssl_validation** | **Boolean** | If True, SSL peer validation must be performed. | [optional]
16
+ **proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional]
17
+ **username** | **String** | The username to be used for authentication when syncing. | [optional]
18
+ **password** | **String** | The password to be used for authentication when syncing. | [optional]
19
+ **_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional]
20
+ **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
21
+ **policy** | **String** | The policy to use when downloading content. | [optional] [default to &#39;immediate&#39;]
22
+
23
+ ## Code Sample
24
+
25
+ ```ruby
26
+ require 'PulpAnsibleClient'
27
+
28
+ instance = PulpAnsibleClient::AnsibleRemote.new(_href: null,
29
+ _created: null,
30
+ _type: null,
31
+ name: null,
32
+ url: null,
33
+ ssl_ca_certificate: null,
34
+ ssl_client_certificate: null,
35
+ ssl_client_key: null,
36
+ ssl_validation: null,
37
+ proxy_url: null,
38
+ username: null,
39
+ password: null,
40
+ _last_updated: null,
41
+ download_concurrency: null,
42
+ policy: null)
43
+ ```
44
+
45
+
@@ -0,0 +1,17 @@
1
+ # PulpAnsibleClient::AsyncOperationResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **task** | **String** | The href of the task. |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpAnsibleClient'
13
+
14
+ instance = PulpAnsibleClient::AsyncOperationResponse.new(task: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,41 @@
1
+ # PulpAnsibleClient::Collection
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
8
+ **_artifact** | **String** | Artifact file representing the physical content |
9
+ **_href** | **String** | | [optional]
10
+ **_type** | **String** | | [optional]
11
+ **md5** | **String** | The MD5 checksum if available. | [optional]
12
+ **sha1** | **String** | The SHA-1 checksum if available. | [optional]
13
+ **sha224** | **String** | The SHA-224 checksum if available. | [optional]
14
+ **sha256** | **String** | The SHA-256 checksum if available. | [optional]
15
+ **sha384** | **String** | The SHA-384 checksum if available. | [optional]
16
+ **sha512** | **String** | The SHA-512 checksum if available. | [optional]
17
+ **version** | **String** | |
18
+ **name** | **String** | |
19
+ **namespace** | **String** | |
20
+
21
+ ## Code Sample
22
+
23
+ ```ruby
24
+ require 'PulpAnsibleClient'
25
+
26
+ instance = PulpAnsibleClient::Collection.new(_created: null,
27
+ _artifact: null,
28
+ _href: null,
29
+ _type: null,
30
+ md5: null,
31
+ sha1: null,
32
+ sha224: null,
33
+ sha256: null,
34
+ sha384: null,
35
+ sha512: null,
36
+ version: null,
37
+ name: null,
38
+ namespace: null)
39
+ ```
40
+
41
+
@@ -0,0 +1,47 @@
1
+ # PulpAnsibleClient::CollectionRemote
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_href** | **String** | | [optional]
8
+ **_created** | **DateTime** | Timestamp of creation. | [optional]
9
+ **_type** | **String** | | [optional]
10
+ **name** | **String** | A unique name for this remote. |
11
+ **url** | **String** | The URL of an external content source. |
12
+ **ssl_ca_certificate** | **String** | A string containing the PEM encoded CA certificate used to validate the server certificate presented by the remote server. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
13
+ **ssl_client_certificate** | **String** | A string containing the PEM encoded client certificate used for authentication. All new line characters must be escaped. Returns SHA256 sum on GET. | [optional]
14
+ **ssl_client_key** | **String** | A PEM encoded private key used for authentication. Returns SHA256 sum on GET. | [optional]
15
+ **ssl_validation** | **Boolean** | If True, SSL peer validation must be performed. | [optional]
16
+ **proxy_url** | **String** | The proxy URL. Format: scheme://user:password@host:port | [optional]
17
+ **username** | **String** | The username to be used for authentication when syncing. | [optional]
18
+ **password** | **String** | The password to be used for authentication when syncing. | [optional]
19
+ **_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional]
20
+ **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
21
+ **policy** | **String** | The policy to use when downloading content. | [optional] [default to &#39;immediate&#39;]
22
+ **whitelist** | **String** | |
23
+
24
+ ## Code Sample
25
+
26
+ ```ruby
27
+ require 'PulpAnsibleClient'
28
+
29
+ instance = PulpAnsibleClient::CollectionRemote.new(_href: null,
30
+ _created: null,
31
+ _type: null,
32
+ name: null,
33
+ url: null,
34
+ ssl_ca_certificate: null,
35
+ ssl_client_certificate: null,
36
+ ssl_client_key: null,
37
+ ssl_validation: null,
38
+ proxy_url: null,
39
+ username: null,
40
+ password: null,
41
+ _last_updated: null,
42
+ download_concurrency: null,
43
+ policy: null,
44
+ whitelist: null)
45
+ ```
46
+
47
+
@@ -0,0 +1,134 @@
1
+ # PulpAnsibleClient::ContentCollectionsApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](ContentCollectionsApi.md#create) | **POST** /pulp/api/v3/content/ansible/collections/ | Create a collection
8
+ [**list**](ContentCollectionsApi.md#list) | **GET** /pulp/api/v3/content/ansible/collections/ | List collections
9
+
10
+
11
+
12
+ ## create
13
+
14
+ > Collection create(data)
15
+
16
+ Create a collection
17
+
18
+ ViewSet for Ansible Collection.
19
+
20
+ ### Example
21
+
22
+ ```ruby
23
+ # load the gem
24
+ require 'pulp_ansible_client'
25
+ # setup authorization
26
+ PulpAnsibleClient.configure do |config|
27
+ # Configure HTTP basic authorization: Basic
28
+ config.username = 'YOUR USERNAME'
29
+ config.password = 'YOUR PASSWORD'
30
+ end
31
+
32
+ api_instance = PulpAnsibleClient::ContentCollectionsApi.new
33
+ data = PulpAnsibleClient::Collection.new # Collection |
34
+
35
+ begin
36
+ #Create a collection
37
+ result = api_instance.create(data)
38
+ p result
39
+ rescue PulpAnsibleClient::ApiError => e
40
+ puts "Exception when calling ContentCollectionsApi->create: #{e}"
41
+ end
42
+ ```
43
+
44
+ ### Parameters
45
+
46
+
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **data** | [**Collection**](Collection.md)| |
50
+
51
+ ### Return type
52
+
53
+ [**Collection**](Collection.md)
54
+
55
+ ### Authorization
56
+
57
+ [Basic](../README.md#Basic)
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: application/json
62
+ - **Accept**: application/json
63
+
64
+
65
+ ## list
66
+
67
+ > InlineResponse200 list(opts)
68
+
69
+ List collections
70
+
71
+ ViewSet for Ansible Collection.
72
+
73
+ ### Example
74
+
75
+ ```ruby
76
+ # load the gem
77
+ require 'pulp_ansible_client'
78
+ # setup authorization
79
+ PulpAnsibleClient.configure do |config|
80
+ # Configure HTTP basic authorization: Basic
81
+ config.username = 'YOUR USERNAME'
82
+ config.password = 'YOUR PASSWORD'
83
+ end
84
+
85
+ api_instance = PulpAnsibleClient::ContentCollectionsApi.new
86
+ opts = {
87
+ name: 'name_example', # String | Filter results where name matches value
88
+ namespace: 'namespace_example', # String | Filter results where namespace matches value
89
+ version: 'version_example', # String | Filter results where version matches value
90
+ repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
91
+ repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
92
+ repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
93
+ latest: 'latest_example', # String |
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 collections
100
+ result = api_instance.list(opts)
101
+ p result
102
+ rescue PulpAnsibleClient::ApiError => e
103
+ puts "Exception when calling ContentCollectionsApi->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
+ **latest** | **String**| | [optional]
119
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
120
+ **page_size** | **Integer**| Number of results to return per page. | [optional]
121
+
122
+ ### Return type
123
+
124
+ [**InlineResponse200**](InlineResponse200.md)
125
+
126
+ ### Authorization
127
+
128
+ [Basic](../README.md#Basic)
129
+
130
+ ### HTTP request headers
131
+
132
+ - **Content-Type**: Not defined
133
+ - **Accept**: application/json
134
+