pulp_ansible_client 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -21
  3. data/docs/AnsibleCollectionVersionResponse.md +3 -3
  4. data/docs/AnsibleCollectionsApi.md +43 -43
  5. data/docs/AnsibleRoleResponse.md +3 -3
  6. data/docs/CollectionVersionDocsResponse.md +17 -0
  7. data/docs/GalaxyCollectionListApi.md +7 -9
  8. data/docs/GalaxyDetailApi.md +5 -5
  9. data/docs/PulpAnsibleApiApi.md +5 -5
  10. data/docs/PulpAnsibleGalaxyApiV2VersionsApi.md +5 -5
  11. data/docs/PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi.md +67 -0
  12. data/docs/RoleListApi.md +5 -5
  13. data/docs/V1RolesApi.md +5 -5
  14. data/docs/V2CollectionsApi.md +26 -26
  15. data/lib/pulp_ansible_client/api/ansible_collections_api.rb +70 -70
  16. data/lib/pulp_ansible_client/api/galaxy_collection_list_api.rb +9 -12
  17. data/lib/pulp_ansible_client/api/galaxy_detail_api.rb +6 -6
  18. data/lib/pulp_ansible_client/api/pulp_ansible_api_api.rb +6 -6
  19. data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v2_versions_api.rb +9 -9
  20. data/lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_docs_blob_api.rb +106 -0
  21. data/lib/pulp_ansible_client/api/role_list_api.rb +6 -6
  22. data/lib/pulp_ansible_client/api/v1_roles_api.rb +6 -6
  23. data/lib/pulp_ansible_client/api/v2_collections_api.rb +43 -43
  24. data/lib/pulp_ansible_client/models/ansible_collection_version.rb +0 -44
  25. data/lib/pulp_ansible_client/models/ansible_collection_version_response.rb +10 -54
  26. data/lib/pulp_ansible_client/models/ansible_role_response.rb +10 -10
  27. data/lib/pulp_ansible_client/models/collection_metadata_response.rb +0 -68
  28. data/lib/pulp_ansible_client/models/collection_version_docs_response.rb +212 -0
  29. data/lib/pulp_ansible_client/version.rb +1 -1
  30. data/lib/pulp_ansible_client.rb +2 -0
  31. data/spec/api/ansible_collections_api_spec.rb +16 -16
  32. data/spec/api/galaxy_collection_list_api_spec.rb +3 -4
  33. data/spec/api/galaxy_detail_api_spec.rb +2 -2
  34. data/spec/api/pulp_ansible_api_api_spec.rb +2 -2
  35. data/spec/api/pulp_ansible_galaxy_api_v2_versions_api_spec.rb +2 -2
  36. data/spec/api/pulp_ansible_galaxy_api_v3_collections_docs_blob_api_spec.rb +51 -0
  37. data/spec/api/role_list_api_spec.rb +2 -2
  38. data/spec/api/v1_roles_api_spec.rb +2 -2
  39. data/spec/api/v2_collections_api_spec.rb +12 -12
  40. data/spec/models/ansible_collection_version_response_spec.rb +3 -3
  41. data/spec/models/ansible_role_response_spec.rb +3 -3
  42. data/spec/models/collection_version_docs_response_spec.rb +41 -0
  43. metadata +10 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d16c73eb2f97726596429074ceed688962743214693caab199a10c23194eabce
4
- data.tar.gz: 503c0851385c3fe83d245fa93526dec3e6f0f5e5abf8367aa6e08eda1bbe8229
3
+ metadata.gz: 2a10f623daa56f535174339adbe8e6c57b9889d81c74500d9cf51e45e976739a
4
+ data.tar.gz: 9d85be31c468be53c46a95b0b33afc22abd2dcc37050def7c1048af7ab27e53e
5
5
  SHA512:
6
- metadata.gz: 01f822160fae3c42ccaa1086b86ef1fa1121fdb68b0938313342722aedbf49edfc932e2a9fbce64a708591b9b58a0898a654b8f1bf1b37866e57dd62f603e946
7
- data.tar.gz: b1509ca6bc767cdd47f6a08056057339fec76ec61dd8018aef3a2fd10de4cfdd0b358a584140867e0e93e0c7a67cc060b2a1e5b29a3c25f9c4bd5946f12fd309
6
+ metadata.gz: 6642f3b317966921b2b931cbbe6bb5683cbde6dcfbd3be9250269db579128e2e32f7f400d169b8995be92a5c87423bc2e0d12169a91a7ef755be1c485aa08224
7
+ data.tar.gz: 4a3e3fbcbd029902569902ba4b2107cf6eb5a7dcd7c728818d0098bea997546a107bda4fe603c2550f3f5fa49850df59e36a6da0d7df0a24032deaf280a75f19
data/README.md CHANGED
@@ -7,7 +7,7 @@ Fetch, Upload, Organize, and Distribute Software Packages
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: v3
10
- - Package version: 0.2.0
10
+ - Package version: 0.3.0
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://pulpproject.org](https://pulpproject.org)
13
13
 
@@ -24,16 +24,16 @@ gem build pulp_ansible_client.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./pulp_ansible_client-0.2.0.gem
27
+ gem install ./pulp_ansible_client-0.3.0.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./pulp_ansible_client-0.2.0.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./pulp_ansible_client-0.3.0.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'pulp_ansible_client', '~> 0.2.0'
36
+ gem 'pulp_ansible_client', '~> 0.3.0'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -65,20 +65,22 @@ PulpAnsibleClient.configure do |config|
65
65
  end
66
66
 
67
67
  api_instance = PulpAnsibleClient::AnsibleCollectionsApi.new
68
- file = File.new('/path/to/file') # File | The Collection tarball.
69
68
  opts = {
70
- sha256: 'sha256_example', # String | An optional sha256 checksum of the uploaded file.
71
- expected_namespace: 'expected_namespace_example', # String | The expected 'namespace' of the Collection to be verified against the metadata during import.
72
- expected_name: 'expected_name_example', # String | The expected 'name' of the Collection to be verified against the metadata during import.
73
- expected_version: 'expected_version_example' # String | The expected version of the Collection to be verified against the metadata during import.
69
+ limit: 56, # Integer | Number of results to return per page.
70
+ name: 'name_example', # String | name
71
+ namespace: 'namespace_example', # String | namespace
72
+ offset: 56, # Integer | The initial index from which to return the results.
73
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
74
+ fields: 'fields_example', # String | A list of fields to include in the response.
75
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
74
76
  }
75
77
 
76
78
  begin
77
- #Upload a collection
78
- result = api_instance.create(file, opts)
79
+ #List collections
80
+ result = api_instance.list(opts)
79
81
  p result
80
82
  rescue PulpAnsibleClient::ApiError => e
81
- puts "Exception when calling AnsibleCollectionsApi->create: #{e}"
83
+ puts "Exception when calling AnsibleCollectionsApi->list: #{e}"
82
84
  end
83
85
 
84
86
  ```
@@ -89,8 +91,8 @@ All URIs are relative to *http://pulp*
89
91
 
90
92
  Class | Method | HTTP request | Description
91
93
  ------------ | ------------- | ------------- | -------------
92
- *PulpAnsibleClient::AnsibleCollectionsApi* | [**create**](docs/AnsibleCollectionsApi.md#create) | **POST** /ansible/collections/ | Upload a collection
93
94
  *PulpAnsibleClient::AnsibleCollectionsApi* | [**list**](docs/AnsibleCollectionsApi.md#list) | **GET** /pulp/api/v3/ansible/collections/ | List collections
95
+ *PulpAnsibleClient::AnsibleCollectionsApi* | [**upload_collection**](docs/AnsibleCollectionsApi.md#upload_collection) | **POST** /ansible/collections/ | Upload a collection
94
96
  *PulpAnsibleClient::CollectionImportApi* | [**read**](docs/CollectionImportApi.md#read) | **GET** {ansible_collection_import_href} | Inspect a collection import
95
97
  *PulpAnsibleClient::ContentCollectionVersionsApi* | [**create**](docs/ContentCollectionVersionsApi.md#create) | **POST** /pulp/api/v3/content/ansible/collection_versions/ | Create a collection version
96
98
  *PulpAnsibleClient::ContentCollectionVersionsApi* | [**list**](docs/ContentCollectionVersionsApi.md#list) | **GET** /pulp/api/v3/content/ansible/collection_versions/ | List collection versions
@@ -104,15 +106,16 @@ Class | Method | HTTP request | Description
104
106
  *PulpAnsibleClient::DistributionsAnsibleApi* | [**partial_update**](docs/DistributionsAnsibleApi.md#partial_update) | **PATCH** {ansible_ansible_distribution_href} | Update an ansible distribution
105
107
  *PulpAnsibleClient::DistributionsAnsibleApi* | [**read**](docs/DistributionsAnsibleApi.md#read) | **GET** {ansible_ansible_distribution_href} | Inspect an ansible distribution
106
108
  *PulpAnsibleClient::DistributionsAnsibleApi* | [**update**](docs/DistributionsAnsibleApi.md#update) | **PUT** {ansible_ansible_distribution_href} | Update an ansible distribution
107
- *PulpAnsibleClient::GalaxyCollectionListApi* | [**list**](docs/GalaxyCollectionListApi.md#list) | **GET** {ansible_collection_version_href}versions/ |
108
- *PulpAnsibleClient::GalaxyDetailApi* | [**read**](docs/GalaxyDetailApi.md#read) | **GET** {ansible_collection_href} |
109
- *PulpAnsibleClient::PulpAnsibleApiApi* | [**read**](docs/PulpAnsibleApiApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/ |
109
+ *PulpAnsibleClient::GalaxyCollectionListApi* | [**get**](docs/GalaxyCollectionListApi.md#get) | **GET** {ansible_collection_version_href}versions/ |
110
+ *PulpAnsibleClient::GalaxyDetailApi* | [**get**](docs/GalaxyDetailApi.md#get) | **GET** {ansible_collection_href} |
111
+ *PulpAnsibleClient::PulpAnsibleApiApi* | [**get**](docs/PulpAnsibleApiApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/ |
110
112
  *PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi* | [**list**](docs/PulpAnsibleGalaxyApiCollectionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/ |
111
113
  *PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi* | [**read**](docs/PulpAnsibleGalaxyApiCollectionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ |
112
114
  *PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi* | [**update**](docs/PulpAnsibleGalaxyApiCollectionsApi.md#update) | **PUT** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ |
113
- *PulpAnsibleClient::PulpAnsibleGalaxyApiV2VersionsApi* | [**read**](docs/PulpAnsibleGalaxyApiV2VersionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/ |
115
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiV2VersionsApi* | [**get**](docs/PulpAnsibleGalaxyApiV2VersionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/ |
114
116
  *PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi* | [**create**](docs/PulpAnsibleGalaxyApiV3CollectionsApi.md#create) | **POST** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/ | Upload a collection
115
117
  *PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsCertifiedApi* | [**set_certified**](docs/PulpAnsibleGalaxyApiV3CollectionsCertifiedApi.md#set_certified) | **PUT** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/certified/ |
118
+ *PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi* | [**read**](docs/PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/docs-blob/ |
116
119
  *PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi* | [**list**](docs/PulpAnsibleGalaxyApiV3VersionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/ |
117
120
  *PulpAnsibleClient::PulpAnsibleGalaxyApiV3VersionsApi* | [**read**](docs/PulpAnsibleGalaxyApiV3VersionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/ |
118
121
  *PulpAnsibleClient::PulpAnsibleTagsApi* | [**list**](docs/PulpAnsibleTagsApi.md#list) | **GET** /pulp/api/v3/pulp_ansible/tags/ | List tags
@@ -140,10 +143,10 @@ Class | Method | HTTP request | Description
140
143
  *PulpAnsibleClient::RepositoriesAnsibleVersionsApi* | [**list**](docs/RepositoriesAnsibleVersionsApi.md#list) | **GET** {ansible_ansible_repository_href}versions/ | List repository versions
141
144
  *PulpAnsibleClient::RepositoriesAnsibleVersionsApi* | [**read**](docs/RepositoriesAnsibleVersionsApi.md#read) | **GET** {ansible_ansible_repository_version_href} | Inspect a repository version
142
145
  *PulpAnsibleClient::RepositoriesAnsibleVersionsApi* | [**repair**](docs/RepositoriesAnsibleVersionsApi.md#repair) | **POST** {ansible_ansible_repository_version_href}repair/ |
143
- *PulpAnsibleClient::RoleListApi* | [**list**](docs/RoleListApi.md#list) | **GET** {ansible_role_href}versions/ |
144
- *PulpAnsibleClient::V1RolesApi* | [**list**](docs/V1RolesApi.md#list) | **GET** {ansible_role_href}api/v1/roles/ |
145
- *PulpAnsibleClient::V2CollectionsApi* | [**create**](docs/V2CollectionsApi.md#create) | **POST** {ansible_collection_href}api/v2/collections/ |
146
- *PulpAnsibleClient::V2CollectionsApi* | [**list**](docs/V2CollectionsApi.md#list) | **GET** {ansible_collection_href}api/v2/collections/ |
146
+ *PulpAnsibleClient::RoleListApi* | [**get**](docs/RoleListApi.md#get) | **GET** {ansible_role_href}versions/ |
147
+ *PulpAnsibleClient::V1RolesApi* | [**get**](docs/V1RolesApi.md#get) | **GET** {ansible_role_href}api/v1/roles/ |
148
+ *PulpAnsibleClient::V2CollectionsApi* | [**get**](docs/V2CollectionsApi.md#get) | **GET** {ansible_collection_href}api/v2/collections/ |
149
+ *PulpAnsibleClient::V2CollectionsApi* | [**post**](docs/V2CollectionsApi.md#post) | **POST** {ansible_collection_href}api/v2/collections/ |
147
150
 
148
151
 
149
152
  ## Documentation for Models
@@ -175,6 +178,7 @@ Class | Method | HTTP request | Description
175
178
  - [PulpAnsibleClient::CollectionRefResponse](docs/CollectionRefResponse.md)
176
179
  - [PulpAnsibleClient::CollectionResponse](docs/CollectionResponse.md)
177
180
  - [PulpAnsibleClient::CollectionVersion](docs/CollectionVersion.md)
181
+ - [PulpAnsibleClient::CollectionVersionDocsResponse](docs/CollectionVersionDocsResponse.md)
178
182
  - [PulpAnsibleClient::CollectionVersionResponse](docs/CollectionVersionResponse.md)
179
183
  - [PulpAnsibleClient::ContentSummary](docs/ContentSummary.md)
180
184
  - [PulpAnsibleClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **pulp_href** | **String** | | [optional] [readonly]
7
8
  **artifact** | **String** | Artifact file representing the physical content |
8
9
  **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
- **pulp_href** | **String** | | [optional] [readonly]
10
10
  **md5** | **String** | The MD5 checksum if available. | [optional] [readonly]
11
11
  **sha1** | **String** | The SHA-1 checksum if available. | [optional] [readonly]
12
12
  **sha224** | **String** | The SHA-224 checksum if available. | [optional] [readonly]
@@ -36,9 +36,9 @@ Name | Type | Description | Notes
36
36
  ```ruby
37
37
  require 'PulpAnsibleClient'
38
38
 
39
- instance = PulpAnsibleClient::AnsibleCollectionVersionResponse.new(artifact: null,
39
+ instance = PulpAnsibleClient::AnsibleCollectionVersionResponse.new(pulp_href: null,
40
+ artifact: null,
40
41
  pulp_created: null,
41
- pulp_href: null,
42
42
  md5: null,
43
43
  sha1: null,
44
44
  sha224: null,
@@ -4,18 +4,18 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**create**](AnsibleCollectionsApi.md#create) | **POST** /ansible/collections/ | Upload a collection
8
7
  [**list**](AnsibleCollectionsApi.md#list) | **GET** /pulp/api/v3/ansible/collections/ | List collections
8
+ [**upload_collection**](AnsibleCollectionsApi.md#upload_collection) | **POST** /ansible/collections/ | Upload a collection
9
9
 
10
10
 
11
11
 
12
- ## create
12
+ ## list
13
13
 
14
- > AsyncOperationResponse create(file, opts)
14
+ > InlineResponse200 list(opts)
15
15
 
16
- Upload a collection
16
+ List collections
17
17
 
18
- Create an artifact and trigger an asynchronous task to create Collection content from it.
18
+ Viewset for Ansible Collections.
19
19
 
20
20
  ### Example
21
21
 
@@ -30,20 +30,22 @@ PulpAnsibleClient.configure do |config|
30
30
  end
31
31
 
32
32
  api_instance = PulpAnsibleClient::AnsibleCollectionsApi.new
33
- file = File.new('/path/to/file') # File | The Collection tarball.
34
33
  opts = {
35
- sha256: 'sha256_example', # String | An optional sha256 checksum of the uploaded file.
36
- expected_namespace: 'expected_namespace_example', # String | The expected 'namespace' of the Collection to be verified against the metadata during import.
37
- expected_name: 'expected_name_example', # String | The expected 'name' of the Collection to be verified against the metadata during import.
38
- expected_version: 'expected_version_example' # String | The expected version of the Collection to be verified against the metadata during import.
34
+ limit: 56, # Integer | Number of results to return per page.
35
+ name: 'name_example', # String | name
36
+ namespace: 'namespace_example', # String | namespace
37
+ offset: 56, # Integer | The initial index from which to return the results.
38
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
39
+ fields: 'fields_example', # String | A list of fields to include in the response.
40
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
39
41
  }
40
42
 
41
43
  begin
42
- #Upload a collection
43
- result = api_instance.create(file, opts)
44
+ #List collections
45
+ result = api_instance.list(opts)
44
46
  p result
45
47
  rescue PulpAnsibleClient::ApiError => e
46
- puts "Exception when calling AnsibleCollectionsApi->create: #{e}"
48
+ puts "Exception when calling AnsibleCollectionsApi->list: #{e}"
47
49
  end
48
50
  ```
49
51
 
@@ -52,15 +54,17 @@ end
52
54
 
53
55
  Name | Type | Description | Notes
54
56
  ------------- | ------------- | ------------- | -------------
55
- **file** | **File**| The Collection tarball. |
56
- **sha256** | **String**| An optional sha256 checksum of the uploaded file. | [optional]
57
- **expected_namespace** | **String**| The expected 'namespace' of the Collection to be verified against the metadata during import. | [optional]
58
- **expected_name** | **String**| The expected 'name' of the Collection to be verified against the metadata during import. | [optional]
59
- **expected_version** | **String**| The expected version of the Collection to be verified against the metadata during import. | [optional]
57
+ **limit** | **Integer**| Number of results to return per page. | [optional]
58
+ **name** | **String**| name | [optional]
59
+ **namespace** | **String**| namespace | [optional]
60
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
61
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
62
+ **fields** | **String**| A list of fields to include in the response. | [optional]
63
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
60
64
 
61
65
  ### Return type
62
66
 
63
- [**AsyncOperationResponse**](AsyncOperationResponse.md)
67
+ [**InlineResponse200**](InlineResponse200.md)
64
68
 
65
69
  ### Authorization
66
70
 
@@ -68,17 +72,17 @@ Name | Type | Description | Notes
68
72
 
69
73
  ### HTTP request headers
70
74
 
71
- - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
75
+ - **Content-Type**: Not defined
72
76
  - **Accept**: application/json
73
77
 
74
78
 
75
- ## list
79
+ ## upload_collection
76
80
 
77
- > InlineResponse200 list(opts)
81
+ > AsyncOperationResponse upload_collection(file, opts)
78
82
 
79
- List collections
83
+ Upload a collection
80
84
 
81
- Viewset for Ansible Collections.
85
+ Create an artifact and trigger an asynchronous task to create Collection content from it.
82
86
 
83
87
  ### Example
84
88
 
@@ -93,22 +97,20 @@ PulpAnsibleClient.configure do |config|
93
97
  end
94
98
 
95
99
  api_instance = PulpAnsibleClient::AnsibleCollectionsApi.new
100
+ file = File.new('/path/to/file') # File | The Collection tarball.
96
101
  opts = {
97
- limit: 56, # Integer | Number of results to return per page.
98
- name: 'name_example', # String | name
99
- namespace: 'namespace_example', # String | namespace
100
- offset: 56, # Integer | The initial index from which to return the results.
101
- ordering: 'ordering_example', # String | Which field to use when ordering the results.
102
- fields: 'fields_example', # String | A list of fields to include in the response.
103
- exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
102
+ sha256: 'sha256_example', # String | An optional sha256 checksum of the uploaded file.
103
+ expected_namespace: 'expected_namespace_example', # String | The expected 'namespace' of the Collection to be verified against the metadata during import.
104
+ expected_name: 'expected_name_example', # String | The expected 'name' of the Collection to be verified against the metadata during import.
105
+ expected_version: 'expected_version_example' # String | The expected version of the Collection to be verified against the metadata during import.
104
106
  }
105
107
 
106
108
  begin
107
- #List collections
108
- result = api_instance.list(opts)
109
+ #Upload a collection
110
+ result = api_instance.upload_collection(file, opts)
109
111
  p result
110
112
  rescue PulpAnsibleClient::ApiError => e
111
- puts "Exception when calling AnsibleCollectionsApi->list: #{e}"
113
+ puts "Exception when calling AnsibleCollectionsApi->upload_collection: #{e}"
112
114
  end
113
115
  ```
114
116
 
@@ -117,17 +119,15 @@ end
117
119
 
118
120
  Name | Type | Description | Notes
119
121
  ------------- | ------------- | ------------- | -------------
120
- **limit** | **Integer**| Number of results to return per page. | [optional]
121
- **name** | **String**| name | [optional]
122
- **namespace** | **String**| namespace | [optional]
123
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
124
- **ordering** | **String**| Which field to use when ordering the results. | [optional]
125
- **fields** | **String**| A list of fields to include in the response. | [optional]
126
- **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
122
+ **file** | **File**| The Collection tarball. |
123
+ **sha256** | **String**| An optional sha256 checksum of the uploaded file. | [optional]
124
+ **expected_namespace** | **String**| The expected 'namespace' of the Collection to be verified against the metadata during import. | [optional]
125
+ **expected_name** | **String**| The expected 'name' of the Collection to be verified against the metadata during import. | [optional]
126
+ **expected_version** | **String**| The expected version of the Collection to be verified against the metadata during import. | [optional]
127
127
 
128
128
  ### Return type
129
129
 
130
- [**InlineResponse200**](InlineResponse200.md)
130
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
131
131
 
132
132
  ### Authorization
133
133
 
@@ -135,6 +135,6 @@ Name | Type | Description | Notes
135
135
 
136
136
  ### HTTP request headers
137
137
 
138
- - **Content-Type**: Not defined
138
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
139
139
  - **Accept**: application/json
140
140
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
+ **pulp_href** | **String** | | [optional] [readonly]
7
8
  **artifact** | **String** | Artifact file representing the physical content |
8
9
  **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
- **pulp_href** | **String** | | [optional] [readonly]
10
10
  **version** | **String** | |
11
11
  **name** | **String** | |
12
12
  **namespace** | **String** | |
@@ -16,9 +16,9 @@ Name | Type | Description | Notes
16
16
  ```ruby
17
17
  require 'PulpAnsibleClient'
18
18
 
19
- instance = PulpAnsibleClient::AnsibleRoleResponse.new(artifact: null,
19
+ instance = PulpAnsibleClient::AnsibleRoleResponse.new(pulp_href: null,
20
+ artifact: null,
20
21
  pulp_created: null,
21
- pulp_href: null,
22
22
  version: null,
23
23
  name: null,
24
24
  namespace: null)
@@ -0,0 +1,17 @@
1
+ # PulpAnsibleClient::CollectionVersionDocsResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **docs_blob** | [**Object**](.md) | |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpAnsibleClient'
13
+
14
+ instance = PulpAnsibleClient::CollectionVersionDocsResponse.new(docs_blob: null)
15
+ ```
16
+
17
+
@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**list**](GalaxyCollectionListApi.md#list) | **GET** {ansible_collection_version_href}versions/ |
7
+ [**get**](GalaxyCollectionListApi.md#get) | **GET** {ansible_collection_version_href}versions/ |
8
8
 
9
9
 
10
10
 
11
- ## list
11
+ ## get
12
12
 
13
- > InlineResponse20012 list(ansible_collection_version_href, opts)
13
+ > InlineResponse20012 get(ansible_collection_version_href, opts)
14
14
 
15
15
 
16
16
 
@@ -25,17 +25,16 @@ require 'pulp_ansible_client'
25
25
  api_instance = PulpAnsibleClient::GalaxyCollectionListApi.new
26
26
  ansible_collection_version_href = 'ansible_collection_version_href_example' # String |
27
27
  opts = {
28
- limit: 56, # Integer | Number of results to return per page.
29
- offset: 56, # Integer | The initial index from which to return the results.
28
+ page: 56, # Integer | A page number within the paginated result set.
30
29
  fields: 'fields_example', # String | A list of fields to include in the response.
31
30
  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
32
31
  }
33
32
 
34
33
  begin
35
- result = api_instance.list(ansible_collection_version_href, opts)
34
+ result = api_instance.get(ansible_collection_version_href, opts)
36
35
  p result
37
36
  rescue PulpAnsibleClient::ApiError => e
38
- puts "Exception when calling GalaxyCollectionListApi->list: #{e}"
37
+ puts "Exception when calling GalaxyCollectionListApi->get: #{e}"
39
38
  end
40
39
  ```
41
40
 
@@ -45,8 +44,7 @@ end
45
44
  Name | Type | Description | Notes
46
45
  ------------- | ------------- | ------------- | -------------
47
46
  **ansible_collection_version_href** | **String**| |
48
- **limit** | **Integer**| Number of results to return per page. | [optional]
49
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
47
+ **page** | **Integer**| A page number within the paginated result set. | [optional]
50
48
  **fields** | **String**| A list of fields to include in the response. | [optional]
51
49
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
52
50
 
@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**read**](GalaxyDetailApi.md#read) | **GET** {ansible_collection_href} |
7
+ [**get**](GalaxyDetailApi.md#get) | **GET** {ansible_collection_href} |
8
8
 
9
9
 
10
10
 
11
- ## read
11
+ ## get
12
12
 
13
- > GalaxyCollectionResponse read(ansible_collection_href, opts)
13
+ > GalaxyCollectionResponse get(ansible_collection_href, opts)
14
14
 
15
15
 
16
16
 
@@ -30,10 +30,10 @@ opts = {
30
30
  }
31
31
 
32
32
  begin
33
- result = api_instance.read(ansible_collection_href, opts)
33
+ result = api_instance.get(ansible_collection_href, opts)
34
34
  p result
35
35
  rescue PulpAnsibleClient::ApiError => e
36
- puts "Exception when calling GalaxyDetailApi->read: #{e}"
36
+ puts "Exception when calling GalaxyDetailApi->get: #{e}"
37
37
  end
38
38
  ```
39
39
 
@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**read**](PulpAnsibleApiApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/ |
7
+ [**get**](PulpAnsibleApiApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/ |
8
8
 
9
9
 
10
10
 
11
- ## read
11
+ ## get
12
12
 
13
- > read(path, opts)
13
+ > get(path, opts)
14
14
 
15
15
 
16
16
 
@@ -30,9 +30,9 @@ opts = {
30
30
  }
31
31
 
32
32
  begin
33
- api_instance.read(path, opts)
33
+ api_instance.get(path, opts)
34
34
  rescue PulpAnsibleClient::ApiError => e
35
- puts "Exception when calling PulpAnsibleApiApi->read: #{e}"
35
+ puts "Exception when calling PulpAnsibleApiApi->get: #{e}"
36
36
  end
37
37
  ```
38
38
 
@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**read**](PulpAnsibleGalaxyApiV2VersionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/ |
7
+ [**get**](PulpAnsibleGalaxyApiV2VersionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v2/collections/{namespace}/{name}/versions/{version}/ |
8
8
 
9
9
 
10
10
 
11
- ## read
11
+ ## get
12
12
 
13
- > read(name, namespace, path, version, opts)
13
+ > get(name, namespace, path, version, opts)
14
14
 
15
15
 
16
16
 
@@ -33,9 +33,9 @@ opts = {
33
33
  }
34
34
 
35
35
  begin
36
- api_instance.read(name, namespace, path, version, opts)
36
+ api_instance.get(name, namespace, path, version, opts)
37
37
  rescue PulpAnsibleClient::ApiError => e
38
- puts "Exception when calling PulpAnsibleGalaxyApiV2VersionsApi->read: #{e}"
38
+ puts "Exception when calling PulpAnsibleGalaxyApiV2VersionsApi->get: #{e}"
39
39
  end
40
40
  ```
41
41
 
@@ -0,0 +1,67 @@
1
+ # PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi
2
+
3
+ All URIs are relative to *http://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**read**](PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/docs-blob/ |
8
+
9
+
10
+
11
+ ## read
12
+
13
+ > CollectionVersionDocsResponse read(name, namespace, path, version, opts)
14
+
15
+
16
+
17
+ Returns a CollectionVersion object.
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'pulp_ansible_client'
24
+
25
+ api_instance = PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi.new
26
+ name = 'name_example' # String |
27
+ namespace = 'namespace_example' # String |
28
+ path = 'path_example' # String |
29
+ version = 'version_example' # String |
30
+ opts = {
31
+ fields: 'fields_example', # String | A list of fields to include in the response.
32
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
33
+ }
34
+
35
+ begin
36
+ result = api_instance.read(name, namespace, path, version, opts)
37
+ p result
38
+ rescue PulpAnsibleClient::ApiError => e
39
+ puts "Exception when calling PulpAnsibleGalaxyApiV3CollectionsDocsBlobApi->read: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+
46
+ Name | Type | Description | Notes
47
+ ------------- | ------------- | ------------- | -------------
48
+ **name** | **String**| |
49
+ **namespace** | **String**| |
50
+ **path** | **String**| |
51
+ **version** | **String**| |
52
+ **fields** | **String**| A list of fields to include in the response. | [optional]
53
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
54
+
55
+ ### Return type
56
+
57
+ [**CollectionVersionDocsResponse**](CollectionVersionDocsResponse.md)
58
+
59
+ ### Authorization
60
+
61
+ No authorization required
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: Not defined
66
+ - **Accept**: application/json
67
+
data/docs/RoleListApi.md CHANGED
@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**list**](RoleListApi.md#list) | **GET** {ansible_role_href}versions/ |
7
+ [**get**](RoleListApi.md#get) | **GET** {ansible_role_href}versions/ |
8
8
 
9
9
 
10
10
 
11
- ## list
11
+ ## get
12
12
 
13
- > InlineResponse20010 list(ansible_role_href, opts)
13
+ > InlineResponse20010 get(ansible_role_href, opts)
14
14
 
15
15
 
16
16
 
@@ -32,10 +32,10 @@ opts = {
32
32
  }
33
33
 
34
34
  begin
35
- result = api_instance.list(ansible_role_href, opts)
35
+ result = api_instance.get(ansible_role_href, opts)
36
36
  p result
37
37
  rescue PulpAnsibleClient::ApiError => e
38
- puts "Exception when calling RoleListApi->list: #{e}"
38
+ puts "Exception when calling RoleListApi->get: #{e}"
39
39
  end
40
40
  ```
41
41
 
data/docs/V1RolesApi.md CHANGED
@@ -4,13 +4,13 @@ All URIs are relative to *http://pulp*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**list**](V1RolesApi.md#list) | **GET** {ansible_role_href}api/v1/roles/ |
7
+ [**get**](V1RolesApi.md#get) | **GET** {ansible_role_href}api/v1/roles/ |
8
8
 
9
9
 
10
10
 
11
- ## list
11
+ ## get
12
12
 
13
- > InlineResponse2009 list(ansible_role_href, opts)
13
+ > InlineResponse2009 get(ansible_role_href, opts)
14
14
 
15
15
 
16
16
 
@@ -32,10 +32,10 @@ opts = {
32
32
  }
33
33
 
34
34
  begin
35
- result = api_instance.list(ansible_role_href, opts)
35
+ result = api_instance.get(ansible_role_href, opts)
36
36
  p result
37
37
  rescue PulpAnsibleClient::ApiError => e
38
- puts "Exception when calling V1RolesApi->list: #{e}"
38
+ puts "Exception when calling V1RolesApi->get: #{e}"
39
39
  end
40
40
  ```
41
41