pulp_python_client 3.12.5 → 3.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (169) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -16
  3. data/docs/AsyncOperationResponse.md +8 -7
  4. data/docs/ContentPackagesApi.md +170 -120
  5. data/docs/ContentSummaryResponse.md +12 -11
  6. data/docs/DistributionsPypiApi.md +385 -182
  7. data/docs/ExcludePlatformsEnum.md +4 -5
  8. data/docs/MyPermissionsResponse.md +8 -7
  9. data/docs/NestedRole.md +12 -11
  10. data/docs/NestedRoleResponse.md +12 -11
  11. data/docs/ObjectRolesResponse.md +8 -7
  12. data/docs/PackageMetadataResponse.md +14 -13
  13. data/docs/PackageTypesEnum.md +4 -5
  14. data/docs/PackageUploadTaskResponse.md +12 -11
  15. data/docs/PaginatedRepositoryVersionResponseList.md +14 -13
  16. data/docs/PaginatedpythonPythonDistributionResponseList.md +14 -13
  17. data/docs/PaginatedpythonPythonPackageContentResponseList.md +14 -13
  18. data/docs/PaginatedpythonPythonPublicationResponseList.md +14 -13
  19. data/docs/PaginatedpythonPythonRemoteResponseList.md +14 -13
  20. data/docs/PaginatedpythonPythonRepositoryResponseList.md +14 -13
  21. data/docs/PatchedpythonPythonDistribution.md +24 -23
  22. data/docs/PatchedpythonPythonRemote.md +60 -59
  23. data/docs/PatchedpythonPythonRepository.md +18 -17
  24. data/docs/PolicyEnum.md +4 -5
  25. data/docs/PublicationsPypiApi.md +267 -130
  26. data/docs/PypiApi.md +33 -17
  27. data/docs/PypiLegacyApi.md +34 -18
  28. data/docs/PypiMetadataApi.md +34 -18
  29. data/docs/PypiSimpleApi.md +95 -45
  30. data/docs/PythonPythonDistribution.md +24 -23
  31. data/docs/PythonPythonDistributionResponse.md +36 -35
  32. data/docs/PythonPythonPackageContentResponse.md +70 -69
  33. data/docs/PythonPythonPublication.md +10 -9
  34. data/docs/PythonPythonPublicationResponse.md +20 -19
  35. data/docs/PythonPythonRemote.md +60 -59
  36. data/docs/PythonPythonRemoteResponse.md +60 -59
  37. data/docs/PythonPythonRemoteResponseHiddenFieldsInner.md +20 -0
  38. data/docs/PythonPythonRepository.md +18 -17
  39. data/docs/PythonPythonRepositoryResponse.md +30 -29
  40. data/docs/RemotesPythonApi.md +420 -198
  41. data/docs/Repair.md +8 -7
  42. data/docs/RepositoriesPythonApi.md +444 -207
  43. data/docs/RepositoriesPythonVersionsApi.md +152 -82
  44. data/docs/RepositoryAddRemoveContent.md +12 -11
  45. data/docs/RepositorySyncURL.md +10 -9
  46. data/docs/RepositoryVersionResponse.md +22 -21
  47. data/docs/SetLabel.md +10 -9
  48. data/docs/SetLabelResponse.md +10 -9
  49. data/docs/SummaryResponse.md +12 -11
  50. data/docs/UnsetLabel.md +8 -7
  51. data/docs/UnsetLabelResponse.md +10 -9
  52. data/lib/pulp_python_client/api/content_packages_api.rb +21 -15
  53. data/lib/pulp_python_client/api/distributions_pypi_api.rb +89 -56
  54. data/lib/pulp_python_client/api/publications_pypi_api.rb +67 -47
  55. data/lib/pulp_python_client/api/pypi_api.rb +6 -5
  56. data/lib/pulp_python_client/api/pypi_legacy_api.rb +11 -7
  57. data/lib/pulp_python_client/api/pypi_metadata_api.rb +6 -5
  58. data/lib/pulp_python_client/api/pypi_simple_api.rb +19 -13
  59. data/lib/pulp_python_client/api/remotes_python_api.rb +113 -73
  60. data/lib/pulp_python_client/api/repositories_python_api.rb +107 -66
  61. data/lib/pulp_python_client/api/repositories_python_versions_api.rb +40 -30
  62. data/lib/pulp_python_client/api_client.rb +137 -102
  63. data/lib/pulp_python_client/api_error.rb +2 -1
  64. data/lib/pulp_python_client/configuration.rb +162 -21
  65. data/lib/pulp_python_client/models/async_operation_response.rb +32 -22
  66. data/lib/pulp_python_client/models/content_summary_response.rb +36 -22
  67. data/lib/pulp_python_client/models/exclude_platforms_enum.rb +8 -4
  68. data/lib/pulp_python_client/models/my_permissions_response.rb +32 -22
  69. data/lib/pulp_python_client/models/nested_role.rb +32 -22
  70. data/lib/pulp_python_client/models/nested_role_response.rb +32 -22
  71. data/lib/pulp_python_client/models/object_roles_response.rb +32 -22
  72. data/lib/pulp_python_client/models/package_metadata_response.rb +41 -37
  73. data/lib/pulp_python_client/models/package_types_enum.rb +8 -4
  74. data/lib/pulp_python_client/models/package_upload_task_response.rb +37 -23
  75. data/lib/pulp_python_client/models/paginated_repository_version_response_list.rb +34 -22
  76. data/lib/pulp_python_client/models/paginatedpython_python_distribution_response_list.rb +34 -22
  77. data/lib/pulp_python_client/models/paginatedpython_python_package_content_response_list.rb +34 -22
  78. data/lib/pulp_python_client/models/paginatedpython_python_publication_response_list.rb +34 -22
  79. data/lib/pulp_python_client/models/paginatedpython_python_remote_response_list.rb +34 -22
  80. data/lib/pulp_python_client/models/paginatedpython_python_repository_response_list.rb +34 -22
  81. data/lib/pulp_python_client/models/patchedpython_python_distribution.rb +40 -24
  82. data/lib/pulp_python_client/models/patchedpython_python_remote.rb +82 -44
  83. data/lib/pulp_python_client/models/patchedpython_python_repository.rb +35 -23
  84. data/lib/pulp_python_client/models/policy_enum.rb +8 -4
  85. data/lib/pulp_python_client/models/python_python_distribution.rb +34 -22
  86. data/lib/pulp_python_client/models/python_python_distribution_response.rb +36 -24
  87. data/lib/pulp_python_client/models/python_python_package_content_response.rb +38 -24
  88. data/lib/pulp_python_client/models/python_python_publication.rb +30 -22
  89. data/lib/pulp_python_client/models/python_python_publication_response.rb +32 -24
  90. data/lib/pulp_python_client/models/python_python_remote.rb +76 -42
  91. data/lib/pulp_python_client/models/python_python_remote_response.rb +79 -45
  92. data/lib/pulp_python_client/models/{python_python_remote_response_hidden_fields.rb → python_python_remote_response_hidden_fields_inner.rb} +37 -25
  93. data/lib/pulp_python_client/models/python_python_repository.rb +32 -22
  94. data/lib/pulp_python_client/models/python_python_repository_response.rb +34 -24
  95. data/lib/pulp_python_client/models/repair.rb +30 -22
  96. data/lib/pulp_python_client/models/repository_add_remove_content.rb +30 -22
  97. data/lib/pulp_python_client/models/repository_sync_url.rb +30 -22
  98. data/lib/pulp_python_client/models/repository_version_response.rb +32 -24
  99. data/lib/pulp_python_client/models/set_label.rb +34 -22
  100. data/lib/pulp_python_client/models/set_label_response.rb +34 -22
  101. data/lib/pulp_python_client/models/summary_response.rb +36 -22
  102. data/lib/pulp_python_client/models/unset_label.rb +32 -22
  103. data/lib/pulp_python_client/models/unset_label_response.rb +32 -22
  104. data/lib/pulp_python_client/version.rb +2 -2
  105. data/lib/pulp_python_client.rb +2 -5
  106. data/pulp_python_client.gemspec +9 -6
  107. data/spec/api/content_packages_api_spec.rb +4 -4
  108. data/spec/api/distributions_pypi_api_spec.rb +13 -13
  109. data/spec/api/publications_pypi_api_spec.rb +16 -15
  110. data/spec/api/pypi_api_spec.rb +2 -2
  111. data/spec/api/pypi_legacy_api_spec.rb +2 -2
  112. data/spec/api/pypi_metadata_api_spec.rb +2 -2
  113. data/spec/api/pypi_simple_api_spec.rb +4 -4
  114. data/spec/api/remotes_python_api_spec.rb +21 -20
  115. data/spec/api/repositories_python_api_spec.rb +15 -15
  116. data/spec/api/repositories_python_versions_api_spec.rb +12 -11
  117. data/spec/models/async_operation_response_spec.rb +7 -12
  118. data/spec/models/content_summary_response_spec.rb +9 -14
  119. data/spec/models/exclude_platforms_enum_spec.rb +6 -11
  120. data/spec/models/my_permissions_response_spec.rb +7 -12
  121. data/spec/models/nested_role_response_spec.rb +9 -14
  122. data/spec/models/nested_role_spec.rb +9 -14
  123. data/spec/models/object_roles_response_spec.rb +7 -12
  124. data/spec/models/package_metadata_response_spec.rb +10 -15
  125. data/spec/models/package_types_enum_spec.rb +6 -11
  126. data/spec/models/package_upload_task_response_spec.rb +9 -14
  127. data/spec/models/paginated_repository_version_response_list_spec.rb +10 -15
  128. data/spec/models/paginatedpython_python_distribution_response_list_spec.rb +10 -15
  129. data/spec/models/paginatedpython_python_package_content_response_list_spec.rb +10 -15
  130. data/spec/models/paginatedpython_python_publication_response_list_spec.rb +10 -15
  131. data/spec/models/paginatedpython_python_remote_response_list_spec.rb +10 -15
  132. data/spec/models/paginatedpython_python_repository_response_list_spec.rb +10 -15
  133. data/spec/models/patchedpython_python_distribution_spec.rb +15 -20
  134. data/spec/models/patchedpython_python_remote_spec.rb +33 -38
  135. data/spec/models/patchedpython_python_repository_spec.rb +12 -17
  136. data/spec/models/policy_enum_spec.rb +6 -11
  137. data/spec/models/python_python_distribution_response_spec.rb +21 -26
  138. data/spec/models/python_python_distribution_spec.rb +15 -20
  139. data/spec/models/python_python_package_content_response_spec.rb +38 -43
  140. data/spec/models/python_python_publication_response_spec.rb +13 -18
  141. data/spec/models/python_python_publication_spec.rb +8 -13
  142. data/spec/models/{python_python_remote_response_hidden_fields_spec.rb → python_python_remote_response_hidden_fields_inner_spec.rb} +11 -16
  143. data/spec/models/python_python_remote_response_spec.rb +33 -38
  144. data/spec/models/python_python_remote_spec.rb +33 -38
  145. data/spec/models/python_python_repository_response_spec.rb +18 -23
  146. data/spec/models/python_python_repository_spec.rb +12 -17
  147. data/spec/models/repair_spec.rb +7 -12
  148. data/spec/models/repository_add_remove_content_spec.rb +9 -14
  149. data/spec/models/repository_sync_url_spec.rb +8 -13
  150. data/spec/models/repository_version_response_spec.rb +14 -19
  151. data/spec/models/set_label_response_spec.rb +8 -13
  152. data/spec/models/set_label_spec.rb +8 -13
  153. data/spec/models/summary_response_spec.rb +9 -14
  154. data/spec/models/unset_label_response_spec.rb +8 -13
  155. data/spec/models/unset_label_spec.rb +7 -12
  156. data/spec/spec_helper.rb +1 -1
  157. metadata +81 -69
  158. data/docs/PackageUpload.md +0 -21
  159. data/docs/PythonBanderRemote.md +0 -21
  160. data/docs/PythonPythonPackageContent.md +0 -71
  161. data/docs/PythonPythonRemoteResponseHiddenFields.md +0 -19
  162. data/lib/pulp_python_client/models/package_upload.rb +0 -283
  163. data/lib/pulp_python_client/models/python_bander_remote.rb +0 -257
  164. data/lib/pulp_python_client/models/python_python_package_content.rb +0 -534
  165. data/spec/api_client_spec.rb +0 -188
  166. data/spec/configuration_spec.rb +0 -42
  167. data/spec/models/package_upload_spec.rb +0 -53
  168. data/spec/models/python_bander_remote_spec.rb +0 -53
  169. data/spec/models/python_python_package_content_spec.rb +0 -203
@@ -2,35 +2,34 @@
2
2
 
3
3
  All URIs are relative to *http://localhost:24817*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**add_role**](DistributionsPypiApi.md#add_role) | **POST** {python_python_distribution_href}add_role/ | Add a role
8
- [**create**](DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
9
- [**delete**](DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution
10
- [**list**](DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions
11
- [**list_roles**](DistributionsPypiApi.md#list_roles) | **GET** {python_python_distribution_href}list_roles/ | List roles
12
- [**my_permissions**](DistributionsPypiApi.md#my_permissions) | **GET** {python_python_distribution_href}my_permissions/ | List user permissions
13
- [**partial_update**](DistributionsPypiApi.md#partial_update) | **PATCH** {python_python_distribution_href} | Update a python distribution
14
- [**read**](DistributionsPypiApi.md#read) | **GET** {python_python_distribution_href} | Inspect a python distribution
15
- [**remove_role**](DistributionsPypiApi.md#remove_role) | **POST** {python_python_distribution_href}remove_role/ | Remove a role
16
- [**set_label**](DistributionsPypiApi.md#set_label) | **POST** {python_python_distribution_href}set_label/ | Set a label
17
- [**unset_label**](DistributionsPypiApi.md#unset_label) | **POST** {python_python_distribution_href}unset_label/ | Unset a label
18
- [**update**](DistributionsPypiApi.md#update) | **PUT** {python_python_distribution_href} | Update a python distribution
19
-
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**add_role**](DistributionsPypiApi.md#add_role) | **POST** {python_python_distribution_href}add_role/ | Add a role |
8
+ | [**create**](DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution |
9
+ | [**delete**](DistributionsPypiApi.md#delete) | **DELETE** {python_python_distribution_href} | Delete a python distribution |
10
+ | [**list**](DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions |
11
+ | [**list_roles**](DistributionsPypiApi.md#list_roles) | **GET** {python_python_distribution_href}list_roles/ | List roles |
12
+ | [**my_permissions**](DistributionsPypiApi.md#my_permissions) | **GET** {python_python_distribution_href}my_permissions/ | List user permissions |
13
+ | [**partial_update**](DistributionsPypiApi.md#partial_update) | **PATCH** {python_python_distribution_href} | Update a python distribution |
14
+ | [**read**](DistributionsPypiApi.md#read) | **GET** {python_python_distribution_href} | Inspect a python distribution |
15
+ | [**remove_role**](DistributionsPypiApi.md#remove_role) | **POST** {python_python_distribution_href}remove_role/ | Remove a role |
16
+ | [**set_label**](DistributionsPypiApi.md#set_label) | **POST** {python_python_distribution_href}set_label/ | Set a label |
17
+ | [**unset_label**](DistributionsPypiApi.md#unset_label) | **POST** {python_python_distribution_href}unset_label/ | Unset a label |
18
+ | [**update**](DistributionsPypiApi.md#update) | **PUT** {python_python_distribution_href} | Update a python distribution |
20
19
 
21
20
 
22
21
  ## add_role
23
22
 
24
- > NestedRoleResponse add_role(python_python_distribution_href, nested_role)
23
+ > <NestedRoleResponse> add_role(python_python_distribution_href, nested_role)
25
24
 
26
25
  Add a role
27
26
 
28
27
  Add a role for this object to users/groups.
29
28
 
30
- ### Example
29
+ ### Examples
31
30
 
32
31
  ```ruby
33
- # load the gem
32
+ require 'time'
34
33
  require 'pulp_python_client'
35
34
  # setup authorization
36
35
  PulpPythonClient.configure do |config|
@@ -41,24 +40,41 @@ end
41
40
 
42
41
  api_instance = PulpPythonClient::DistributionsPypiApi.new
43
42
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
44
- nested_role = PulpPythonClient::NestedRole.new # NestedRole |
43
+ nested_role = PulpPythonClient::NestedRole.new({role: 'role_example'}) # NestedRole |
45
44
 
46
45
  begin
47
- #Add a role
46
+ # Add a role
48
47
  result = api_instance.add_role(python_python_distribution_href, nested_role)
49
48
  p result
50
49
  rescue PulpPythonClient::ApiError => e
51
- puts "Exception when calling DistributionsPypiApi->add_role: #{e}"
50
+ puts "Error when calling DistributionsPypiApi->add_role: #{e}"
52
51
  end
53
52
  ```
54
53
 
55
- ### Parameters
54
+ #### Using the add_role_with_http_info variant
55
+
56
+ This returns an Array which contains the response data, status code and headers.
57
+
58
+ > <Array(<NestedRoleResponse>, Integer, Hash)> add_role_with_http_info(python_python_distribution_href, nested_role)
59
+
60
+ ```ruby
61
+ begin
62
+ # Add a role
63
+ data, status_code, headers = api_instance.add_role_with_http_info(python_python_distribution_href, nested_role)
64
+ p status_code # => 2xx
65
+ p headers # => { ... }
66
+ p data # => <NestedRoleResponse>
67
+ rescue PulpPythonClient::ApiError => e
68
+ puts "Error when calling DistributionsPypiApi->add_role_with_http_info: #{e}"
69
+ end
70
+ ```
56
71
 
72
+ ### Parameters
57
73
 
58
- Name | Type | Description | Notes
59
- ------------- | ------------- | ------------- | -------------
60
- **python_python_distribution_href** | **String**| |
61
- **nested_role** | [**NestedRole**](NestedRole.md)| |
74
+ | Name | Type | Description | Notes |
75
+ | ---- | ---- | ----------- | ----- |
76
+ | **python_python_distribution_href** | **String** | | |
77
+ | **nested_role** | [**NestedRole**](NestedRole.md) | | |
62
78
 
63
79
  ### Return type
64
80
 
@@ -76,16 +92,16 @@ Name | Type | Description | Notes
76
92
 
77
93
  ## create
78
94
 
79
- > AsyncOperationResponse create(python_python_distribution)
95
+ > <AsyncOperationResponse> create(python_python_distribution)
80
96
 
81
97
  Create a python distribution
82
98
 
83
99
  Trigger an asynchronous create task
84
100
 
85
- ### Example
101
+ ### Examples
86
102
 
87
103
  ```ruby
88
- # load the gem
104
+ require 'time'
89
105
  require 'pulp_python_client'
90
106
  # setup authorization
91
107
  PulpPythonClient.configure do |config|
@@ -95,23 +111,40 @@ PulpPythonClient.configure do |config|
95
111
  end
96
112
 
97
113
  api_instance = PulpPythonClient::DistributionsPypiApi.new
98
- python_python_distribution = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution |
114
+ python_python_distribution = PulpPythonClient::PythonPythonDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # PythonPythonDistribution |
99
115
 
100
116
  begin
101
- #Create a python distribution
117
+ # Create a python distribution
102
118
  result = api_instance.create(python_python_distribution)
103
119
  p result
104
120
  rescue PulpPythonClient::ApiError => e
105
- puts "Exception when calling DistributionsPypiApi->create: #{e}"
121
+ puts "Error when calling DistributionsPypiApi->create: #{e}"
106
122
  end
107
123
  ```
108
124
 
109
- ### Parameters
125
+ #### Using the create_with_http_info variant
110
126
 
127
+ This returns an Array which contains the response data, status code and headers.
111
128
 
112
- Name | Type | Description | Notes
113
- ------------- | ------------- | ------------- | -------------
114
- **python_python_distribution** | [**PythonPythonDistribution**](PythonPythonDistribution.md)| |
129
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(python_python_distribution)
130
+
131
+ ```ruby
132
+ begin
133
+ # Create a python distribution
134
+ data, status_code, headers = api_instance.create_with_http_info(python_python_distribution)
135
+ p status_code # => 2xx
136
+ p headers # => { ... }
137
+ p data # => <AsyncOperationResponse>
138
+ rescue PulpPythonClient::ApiError => e
139
+ puts "Error when calling DistributionsPypiApi->create_with_http_info: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ | Name | Type | Description | Notes |
146
+ | ---- | ---- | ----------- | ----- |
147
+ | **python_python_distribution** | [**PythonPythonDistribution**](PythonPythonDistribution.md) | | |
115
148
 
116
149
  ### Return type
117
150
 
@@ -129,16 +162,16 @@ Name | Type | Description | Notes
129
162
 
130
163
  ## delete
131
164
 
132
- > AsyncOperationResponse delete(python_python_distribution_href)
165
+ > <AsyncOperationResponse> delete(python_python_distribution_href)
133
166
 
134
167
  Delete a python distribution
135
168
 
136
169
  Trigger an asynchronous delete task
137
170
 
138
- ### Example
171
+ ### Examples
139
172
 
140
173
  ```ruby
141
- # load the gem
174
+ require 'time'
142
175
  require 'pulp_python_client'
143
176
  # setup authorization
144
177
  PulpPythonClient.configure do |config|
@@ -151,20 +184,37 @@ api_instance = PulpPythonClient::DistributionsPypiApi.new
151
184
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
152
185
 
153
186
  begin
154
- #Delete a python distribution
187
+ # Delete a python distribution
155
188
  result = api_instance.delete(python_python_distribution_href)
156
189
  p result
157
190
  rescue PulpPythonClient::ApiError => e
158
- puts "Exception when calling DistributionsPypiApi->delete: #{e}"
191
+ puts "Error when calling DistributionsPypiApi->delete: #{e}"
159
192
  end
160
193
  ```
161
194
 
162
- ### Parameters
195
+ #### Using the delete_with_http_info variant
196
+
197
+ This returns an Array which contains the response data, status code and headers.
198
+
199
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(python_python_distribution_href)
163
200
 
201
+ ```ruby
202
+ begin
203
+ # Delete a python distribution
204
+ data, status_code, headers = api_instance.delete_with_http_info(python_python_distribution_href)
205
+ p status_code # => 2xx
206
+ p headers # => { ... }
207
+ p data # => <AsyncOperationResponse>
208
+ rescue PulpPythonClient::ApiError => e
209
+ puts "Error when calling DistributionsPypiApi->delete_with_http_info: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
164
214
 
165
- Name | Type | Description | Notes
166
- ------------- | ------------- | ------------- | -------------
167
- **python_python_distribution_href** | **String**| |
215
+ | Name | Type | Description | Notes |
216
+ | ---- | ---- | ----------- | ----- |
217
+ | **python_python_distribution_href** | **String** | | |
168
218
 
169
219
  ### Return type
170
220
 
@@ -182,16 +232,16 @@ Name | Type | Description | Notes
182
232
 
183
233
  ## list
184
234
 
185
- > PaginatedpythonPythonDistributionResponseList list(opts)
235
+ > <PaginatedpythonPythonDistributionResponseList> list(opts)
186
236
 
187
237
  List python distributions
188
238
 
189
239
  Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications. Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.
190
240
 
191
- ### Example
241
+ ### Examples
192
242
 
193
243
  ```ruby
194
- # load the gem
244
+ require 'time'
195
245
  require 'pulp_python_client'
196
246
  # setup authorization
197
247
  PulpPythonClient.configure do |config|
@@ -205,71 +255,88 @@ opts = {
205
255
  base_path: 'base_path_example', # String | Filter results where base_path matches value
206
256
  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
207
257
  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
208
- base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
258
+ base_path__in: ['inner_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
209
259
  limit: 56, # Integer | Number of results to return per page.
210
260
  name: 'name_example', # String | Filter results where name matches value
211
261
  name__contains: 'name__contains_example', # String | Filter results where name contains value
212
262
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
213
263
  name__iexact: 'name__iexact_example', # String | Filter results where name matches value
214
- name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
264
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
215
265
  name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
216
266
  name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
217
267
  name__regex: 'name__regex_example', # String | Filter results where name matches regex value
218
268
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
219
269
  offset: 56, # Integer | The initial index from which to return the results.
220
- ordering: ['ordering_example'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
221
- prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
222
- pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
223
- pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
270
+ ordering: ['-base_path'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
271
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
272
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
273
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
224
274
  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
225
275
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
226
- repository: 'repository_example', # String | Filter results where repository matches value
227
- repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
276
+ repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
277
+ repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
228
278
  with_content: 'with_content_example', # String | Filter distributions based on the content served by them
229
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
230
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
279
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
280
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
231
281
  }
232
282
 
233
283
  begin
234
- #List python distributions
284
+ # List python distributions
235
285
  result = api_instance.list(opts)
236
286
  p result
237
287
  rescue PulpPythonClient::ApiError => e
238
- puts "Exception when calling DistributionsPypiApi->list: #{e}"
288
+ puts "Error when calling DistributionsPypiApi->list: #{e}"
239
289
  end
240
290
  ```
241
291
 
242
- ### Parameters
292
+ #### Using the list_with_http_info variant
293
+
294
+ This returns an Array which contains the response data, status code and headers.
243
295
 
296
+ > <Array(<PaginatedpythonPythonDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
244
297
 
245
- Name | Type | Description | Notes
246
- ------------- | ------------- | ------------- | -------------
247
- **base_path** | **String**| Filter results where base_path matches value | [optional]
248
- **base_path__contains** | **String**| Filter results where base_path contains value | [optional]
249
- **base_path__icontains** | **String**| Filter results where base_path contains value | [optional]
250
- **base_path__in** | [**Array&lt;String&gt;**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional]
251
- **limit** | **Integer**| Number of results to return per page. | [optional]
252
- **name** | **String**| Filter results where name matches value | [optional]
253
- **name__contains** | **String**| Filter results where name contains value | [optional]
254
- **name__icontains** | **String**| Filter results where name contains value | [optional]
255
- **name__iexact** | **String**| Filter results where name matches value | [optional]
256
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
257
- **name__iregex** | **String**| Filter results where name matches regex value | [optional]
258
- **name__istartswith** | **String**| Filter results where name starts with value | [optional]
259
- **name__regex** | **String**| Filter results where name matches regex value | [optional]
260
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
261
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
262
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional]
263
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
264
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
265
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
266
- **pulp_label_select** | **String**| Filter labels by search string | [optional]
267
- **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [optional]
268
- **repository** | [**String**](.md)| Filter results where repository matches value | [optional]
269
- **repository__in** | [**Array&lt;String&gt;**](String.md)| Filter results where repository is in a comma-separated list of values | [optional]
270
- **with_content** | **String**| Filter distributions based on the content served by them | [optional]
271
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
272
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
298
+ ```ruby
299
+ begin
300
+ # List python distributions
301
+ data, status_code, headers = api_instance.list_with_http_info(opts)
302
+ p status_code # => 2xx
303
+ p headers # => { ... }
304
+ p data # => <PaginatedpythonPythonDistributionResponseList>
305
+ rescue PulpPythonClient::ApiError => e
306
+ puts "Error when calling DistributionsPypiApi->list_with_http_info: #{e}"
307
+ end
308
+ ```
309
+
310
+ ### Parameters
311
+
312
+ | Name | Type | Description | Notes |
313
+ | ---- | ---- | ----------- | ----- |
314
+ | **base_path** | **String** | Filter results where base_path matches value | [optional] |
315
+ | **base_path__contains** | **String** | Filter results where base_path contains value | [optional] |
316
+ | **base_path__icontains** | **String** | Filter results where base_path contains value | [optional] |
317
+ | **base_path__in** | [**Array&lt;String&gt;**](String.md) | Filter results where base_path is in a comma-separated list of values | [optional] |
318
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
319
+ | **name** | **String** | Filter results where name matches value | [optional] |
320
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
321
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
322
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
323
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
324
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
325
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
326
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
327
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
328
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
329
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
330
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
331
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
332
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
333
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
334
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
335
+ | **repository** | **String** | Filter results where repository matches value | [optional] |
336
+ | **repository__in** | [**Array&lt;String&gt;**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
337
+ | **with_content** | **String** | Filter distributions based on the content served by them | [optional] |
338
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
339
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
273
340
 
274
341
  ### Return type
275
342
 
@@ -287,16 +354,16 @@ Name | Type | Description | Notes
287
354
 
288
355
  ## list_roles
289
356
 
290
- > ObjectRolesResponse list_roles(python_python_distribution_href, opts)
357
+ > <ObjectRolesResponse> list_roles(python_python_distribution_href, opts)
291
358
 
292
359
  List roles
293
360
 
294
361
  List roles assigned to this object.
295
362
 
296
- ### Example
363
+ ### Examples
297
364
 
298
365
  ```ruby
299
- # load the gem
366
+ require 'time'
300
367
  require 'pulp_python_client'
301
368
  # setup authorization
302
369
  PulpPythonClient.configure do |config|
@@ -308,27 +375,44 @@ end
308
375
  api_instance = PulpPythonClient::DistributionsPypiApi.new
309
376
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
310
377
  opts = {
311
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
312
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
378
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
379
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
313
380
  }
314
381
 
315
382
  begin
316
- #List roles
383
+ # List roles
317
384
  result = api_instance.list_roles(python_python_distribution_href, opts)
318
385
  p result
319
386
  rescue PulpPythonClient::ApiError => e
320
- puts "Exception when calling DistributionsPypiApi->list_roles: #{e}"
387
+ puts "Error when calling DistributionsPypiApi->list_roles: #{e}"
321
388
  end
322
389
  ```
323
390
 
324
- ### Parameters
391
+ #### Using the list_roles_with_http_info variant
392
+
393
+ This returns an Array which contains the response data, status code and headers.
394
+
395
+ > <Array(<ObjectRolesResponse>, Integer, Hash)> list_roles_with_http_info(python_python_distribution_href, opts)
396
+
397
+ ```ruby
398
+ begin
399
+ # List roles
400
+ data, status_code, headers = api_instance.list_roles_with_http_info(python_python_distribution_href, opts)
401
+ p status_code # => 2xx
402
+ p headers # => { ... }
403
+ p data # => <ObjectRolesResponse>
404
+ rescue PulpPythonClient::ApiError => e
405
+ puts "Error when calling DistributionsPypiApi->list_roles_with_http_info: #{e}"
406
+ end
407
+ ```
325
408
 
409
+ ### Parameters
326
410
 
327
- Name | Type | Description | Notes
328
- ------------- | ------------- | ------------- | -------------
329
- **python_python_distribution_href** | **String**| |
330
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
331
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
411
+ | Name | Type | Description | Notes |
412
+ | ---- | ---- | ----------- | ----- |
413
+ | **python_python_distribution_href** | **String** | | |
414
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
415
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
332
416
 
333
417
  ### Return type
334
418
 
@@ -346,16 +430,16 @@ Name | Type | Description | Notes
346
430
 
347
431
  ## my_permissions
348
432
 
349
- > MyPermissionsResponse my_permissions(python_python_distribution_href, opts)
433
+ > <MyPermissionsResponse> my_permissions(python_python_distribution_href, opts)
350
434
 
351
435
  List user permissions
352
436
 
353
437
  List permissions available to the current user on this object.
354
438
 
355
- ### Example
439
+ ### Examples
356
440
 
357
441
  ```ruby
358
- # load the gem
442
+ require 'time'
359
443
  require 'pulp_python_client'
360
444
  # setup authorization
361
445
  PulpPythonClient.configure do |config|
@@ -367,27 +451,44 @@ end
367
451
  api_instance = PulpPythonClient::DistributionsPypiApi.new
368
452
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
369
453
  opts = {
370
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
371
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
454
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
455
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
372
456
  }
373
457
 
374
458
  begin
375
- #List user permissions
459
+ # List user permissions
376
460
  result = api_instance.my_permissions(python_python_distribution_href, opts)
377
461
  p result
378
462
  rescue PulpPythonClient::ApiError => e
379
- puts "Exception when calling DistributionsPypiApi->my_permissions: #{e}"
463
+ puts "Error when calling DistributionsPypiApi->my_permissions: #{e}"
380
464
  end
381
465
  ```
382
466
 
383
- ### Parameters
467
+ #### Using the my_permissions_with_http_info variant
468
+
469
+ This returns an Array which contains the response data, status code and headers.
470
+
471
+ > <Array(<MyPermissionsResponse>, Integer, Hash)> my_permissions_with_http_info(python_python_distribution_href, opts)
384
472
 
473
+ ```ruby
474
+ begin
475
+ # List user permissions
476
+ data, status_code, headers = api_instance.my_permissions_with_http_info(python_python_distribution_href, opts)
477
+ p status_code # => 2xx
478
+ p headers # => { ... }
479
+ p data # => <MyPermissionsResponse>
480
+ rescue PulpPythonClient::ApiError => e
481
+ puts "Error when calling DistributionsPypiApi->my_permissions_with_http_info: #{e}"
482
+ end
483
+ ```
484
+
485
+ ### Parameters
385
486
 
386
- Name | Type | Description | Notes
387
- ------------- | ------------- | ------------- | -------------
388
- **python_python_distribution_href** | **String**| |
389
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
390
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
487
+ | Name | Type | Description | Notes |
488
+ | ---- | ---- | ----------- | ----- |
489
+ | **python_python_distribution_href** | **String** | | |
490
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
491
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
391
492
 
392
493
  ### Return type
393
494
 
@@ -405,16 +506,16 @@ Name | Type | Description | Notes
405
506
 
406
507
  ## partial_update
407
508
 
408
- > AsyncOperationResponse partial_update(python_python_distribution_href, patchedpython_python_distribution)
509
+ > <AsyncOperationResponse> partial_update(python_python_distribution_href, patchedpython_python_distribution)
409
510
 
410
511
  Update a python distribution
411
512
 
412
513
  Trigger an asynchronous partial update task
413
514
 
414
- ### Example
515
+ ### Examples
415
516
 
416
517
  ```ruby
417
- # load the gem
518
+ require 'time'
418
519
  require 'pulp_python_client'
419
520
  # setup authorization
420
521
  PulpPythonClient.configure do |config|
@@ -428,21 +529,38 @@ python_python_distribution_href = 'python_python_distribution_href_example' # St
428
529
  patchedpython_python_distribution = PulpPythonClient::PatchedpythonPythonDistribution.new # PatchedpythonPythonDistribution |
429
530
 
430
531
  begin
431
- #Update a python distribution
532
+ # Update a python distribution
432
533
  result = api_instance.partial_update(python_python_distribution_href, patchedpython_python_distribution)
433
534
  p result
434
535
  rescue PulpPythonClient::ApiError => e
435
- puts "Exception when calling DistributionsPypiApi->partial_update: #{e}"
536
+ puts "Error when calling DistributionsPypiApi->partial_update: #{e}"
436
537
  end
437
538
  ```
438
539
 
439
- ### Parameters
540
+ #### Using the partial_update_with_http_info variant
541
+
542
+ This returns an Array which contains the response data, status code and headers.
440
543
 
544
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(python_python_distribution_href, patchedpython_python_distribution)
441
545
 
442
- Name | Type | Description | Notes
443
- ------------- | ------------- | ------------- | -------------
444
- **python_python_distribution_href** | **String**| |
445
- **patchedpython_python_distribution** | [**PatchedpythonPythonDistribution**](PatchedpythonPythonDistribution.md)| |
546
+ ```ruby
547
+ begin
548
+ # Update a python distribution
549
+ data, status_code, headers = api_instance.partial_update_with_http_info(python_python_distribution_href, patchedpython_python_distribution)
550
+ p status_code # => 2xx
551
+ p headers # => { ... }
552
+ p data # => <AsyncOperationResponse>
553
+ rescue PulpPythonClient::ApiError => e
554
+ puts "Error when calling DistributionsPypiApi->partial_update_with_http_info: #{e}"
555
+ end
556
+ ```
557
+
558
+ ### Parameters
559
+
560
+ | Name | Type | Description | Notes |
561
+ | ---- | ---- | ----------- | ----- |
562
+ | **python_python_distribution_href** | **String** | | |
563
+ | **patchedpython_python_distribution** | [**PatchedpythonPythonDistribution**](PatchedpythonPythonDistribution.md) | | |
446
564
 
447
565
  ### Return type
448
566
 
@@ -460,16 +578,16 @@ Name | Type | Description | Notes
460
578
 
461
579
  ## read
462
580
 
463
- > PythonPythonDistributionResponse read(python_python_distribution_href, opts)
581
+ > <PythonPythonDistributionResponse> read(python_python_distribution_href, opts)
464
582
 
465
583
  Inspect a python distribution
466
584
 
467
585
  Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications. Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.
468
586
 
469
- ### Example
587
+ ### Examples
470
588
 
471
589
  ```ruby
472
- # load the gem
590
+ require 'time'
473
591
  require 'pulp_python_client'
474
592
  # setup authorization
475
593
  PulpPythonClient.configure do |config|
@@ -481,27 +599,44 @@ end
481
599
  api_instance = PulpPythonClient::DistributionsPypiApi.new
482
600
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
483
601
  opts = {
484
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
485
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
602
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
603
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
486
604
  }
487
605
 
488
606
  begin
489
- #Inspect a python distribution
607
+ # Inspect a python distribution
490
608
  result = api_instance.read(python_python_distribution_href, opts)
491
609
  p result
492
610
  rescue PulpPythonClient::ApiError => e
493
- puts "Exception when calling DistributionsPypiApi->read: #{e}"
611
+ puts "Error when calling DistributionsPypiApi->read: #{e}"
494
612
  end
495
613
  ```
496
614
 
497
- ### Parameters
615
+ #### Using the read_with_http_info variant
616
+
617
+ This returns an Array which contains the response data, status code and headers.
618
+
619
+ > <Array(<PythonPythonDistributionResponse>, Integer, Hash)> read_with_http_info(python_python_distribution_href, opts)
620
+
621
+ ```ruby
622
+ begin
623
+ # Inspect a python distribution
624
+ data, status_code, headers = api_instance.read_with_http_info(python_python_distribution_href, opts)
625
+ p status_code # => 2xx
626
+ p headers # => { ... }
627
+ p data # => <PythonPythonDistributionResponse>
628
+ rescue PulpPythonClient::ApiError => e
629
+ puts "Error when calling DistributionsPypiApi->read_with_http_info: #{e}"
630
+ end
631
+ ```
498
632
 
633
+ ### Parameters
499
634
 
500
- Name | Type | Description | Notes
501
- ------------- | ------------- | ------------- | -------------
502
- **python_python_distribution_href** | **String**| |
503
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
504
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
635
+ | Name | Type | Description | Notes |
636
+ | ---- | ---- | ----------- | ----- |
637
+ | **python_python_distribution_href** | **String** | | |
638
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
639
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
505
640
 
506
641
  ### Return type
507
642
 
@@ -519,16 +654,16 @@ Name | Type | Description | Notes
519
654
 
520
655
  ## remove_role
521
656
 
522
- > NestedRoleResponse remove_role(python_python_distribution_href, nested_role)
657
+ > <NestedRoleResponse> remove_role(python_python_distribution_href, nested_role)
523
658
 
524
659
  Remove a role
525
660
 
526
661
  Remove a role for this object from users/groups.
527
662
 
528
- ### Example
663
+ ### Examples
529
664
 
530
665
  ```ruby
531
- # load the gem
666
+ require 'time'
532
667
  require 'pulp_python_client'
533
668
  # setup authorization
534
669
  PulpPythonClient.configure do |config|
@@ -539,24 +674,41 @@ end
539
674
 
540
675
  api_instance = PulpPythonClient::DistributionsPypiApi.new
541
676
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
542
- nested_role = PulpPythonClient::NestedRole.new # NestedRole |
677
+ nested_role = PulpPythonClient::NestedRole.new({role: 'role_example'}) # NestedRole |
543
678
 
544
679
  begin
545
- #Remove a role
680
+ # Remove a role
546
681
  result = api_instance.remove_role(python_python_distribution_href, nested_role)
547
682
  p result
548
683
  rescue PulpPythonClient::ApiError => e
549
- puts "Exception when calling DistributionsPypiApi->remove_role: #{e}"
684
+ puts "Error when calling DistributionsPypiApi->remove_role: #{e}"
550
685
  end
551
686
  ```
552
687
 
553
- ### Parameters
688
+ #### Using the remove_role_with_http_info variant
689
+
690
+ This returns an Array which contains the response data, status code and headers.
691
+
692
+ > <Array(<NestedRoleResponse>, Integer, Hash)> remove_role_with_http_info(python_python_distribution_href, nested_role)
554
693
 
694
+ ```ruby
695
+ begin
696
+ # Remove a role
697
+ data, status_code, headers = api_instance.remove_role_with_http_info(python_python_distribution_href, nested_role)
698
+ p status_code # => 2xx
699
+ p headers # => { ... }
700
+ p data # => <NestedRoleResponse>
701
+ rescue PulpPythonClient::ApiError => e
702
+ puts "Error when calling DistributionsPypiApi->remove_role_with_http_info: #{e}"
703
+ end
704
+ ```
705
+
706
+ ### Parameters
555
707
 
556
- Name | Type | Description | Notes
557
- ------------- | ------------- | ------------- | -------------
558
- **python_python_distribution_href** | **String**| |
559
- **nested_role** | [**NestedRole**](NestedRole.md)| |
708
+ | Name | Type | Description | Notes |
709
+ | ---- | ---- | ----------- | ----- |
710
+ | **python_python_distribution_href** | **String** | | |
711
+ | **nested_role** | [**NestedRole**](NestedRole.md) | | |
560
712
 
561
713
  ### Return type
562
714
 
@@ -574,16 +726,16 @@ Name | Type | Description | Notes
574
726
 
575
727
  ## set_label
576
728
 
577
- > SetLabelResponse set_label(python_python_distribution_href, set_label)
729
+ > <SetLabelResponse> set_label(python_python_distribution_href, set_label)
578
730
 
579
731
  Set a label
580
732
 
581
733
  Set a single pulp_label on the object to a specific value or null.
582
734
 
583
- ### Example
735
+ ### Examples
584
736
 
585
737
  ```ruby
586
- # load the gem
738
+ require 'time'
587
739
  require 'pulp_python_client'
588
740
  # setup authorization
589
741
  PulpPythonClient.configure do |config|
@@ -594,24 +746,41 @@ end
594
746
 
595
747
  api_instance = PulpPythonClient::DistributionsPypiApi.new
596
748
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
597
- set_label = PulpPythonClient::SetLabel.new # SetLabel |
749
+ set_label = PulpPythonClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
598
750
 
599
751
  begin
600
- #Set a label
752
+ # Set a label
601
753
  result = api_instance.set_label(python_python_distribution_href, set_label)
602
754
  p result
603
755
  rescue PulpPythonClient::ApiError => e
604
- puts "Exception when calling DistributionsPypiApi->set_label: #{e}"
756
+ puts "Error when calling DistributionsPypiApi->set_label: #{e}"
605
757
  end
606
758
  ```
607
759
 
608
- ### Parameters
760
+ #### Using the set_label_with_http_info variant
761
+
762
+ This returns an Array which contains the response data, status code and headers.
609
763
 
764
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(python_python_distribution_href, set_label)
610
765
 
611
- Name | Type | Description | Notes
612
- ------------- | ------------- | ------------- | -------------
613
- **python_python_distribution_href** | **String**| |
614
- **set_label** | [**SetLabel**](SetLabel.md)| |
766
+ ```ruby
767
+ begin
768
+ # Set a label
769
+ data, status_code, headers = api_instance.set_label_with_http_info(python_python_distribution_href, set_label)
770
+ p status_code # => 2xx
771
+ p headers # => { ... }
772
+ p data # => <SetLabelResponse>
773
+ rescue PulpPythonClient::ApiError => e
774
+ puts "Error when calling DistributionsPypiApi->set_label_with_http_info: #{e}"
775
+ end
776
+ ```
777
+
778
+ ### Parameters
779
+
780
+ | Name | Type | Description | Notes |
781
+ | ---- | ---- | ----------- | ----- |
782
+ | **python_python_distribution_href** | **String** | | |
783
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
615
784
 
616
785
  ### Return type
617
786
 
@@ -629,16 +798,16 @@ Name | Type | Description | Notes
629
798
 
630
799
  ## unset_label
631
800
 
632
- > UnsetLabelResponse unset_label(python_python_distribution_href, unset_label)
801
+ > <UnsetLabelResponse> unset_label(python_python_distribution_href, unset_label)
633
802
 
634
803
  Unset a label
635
804
 
636
805
  Unset a single pulp_label on the object.
637
806
 
638
- ### Example
807
+ ### Examples
639
808
 
640
809
  ```ruby
641
- # load the gem
810
+ require 'time'
642
811
  require 'pulp_python_client'
643
812
  # setup authorization
644
813
  PulpPythonClient.configure do |config|
@@ -649,24 +818,41 @@ end
649
818
 
650
819
  api_instance = PulpPythonClient::DistributionsPypiApi.new
651
820
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
652
- unset_label = PulpPythonClient::UnsetLabel.new # UnsetLabel |
821
+ unset_label = PulpPythonClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
653
822
 
654
823
  begin
655
- #Unset a label
824
+ # Unset a label
656
825
  result = api_instance.unset_label(python_python_distribution_href, unset_label)
657
826
  p result
658
827
  rescue PulpPythonClient::ApiError => e
659
- puts "Exception when calling DistributionsPypiApi->unset_label: #{e}"
828
+ puts "Error when calling DistributionsPypiApi->unset_label: #{e}"
660
829
  end
661
830
  ```
662
831
 
663
- ### Parameters
832
+ #### Using the unset_label_with_http_info variant
833
+
834
+ This returns an Array which contains the response data, status code and headers.
835
+
836
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(python_python_distribution_href, unset_label)
837
+
838
+ ```ruby
839
+ begin
840
+ # Unset a label
841
+ data, status_code, headers = api_instance.unset_label_with_http_info(python_python_distribution_href, unset_label)
842
+ p status_code # => 2xx
843
+ p headers # => { ... }
844
+ p data # => <UnsetLabelResponse>
845
+ rescue PulpPythonClient::ApiError => e
846
+ puts "Error when calling DistributionsPypiApi->unset_label_with_http_info: #{e}"
847
+ end
848
+ ```
664
849
 
850
+ ### Parameters
665
851
 
666
- Name | Type | Description | Notes
667
- ------------- | ------------- | ------------- | -------------
668
- **python_python_distribution_href** | **String**| |
669
- **unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
852
+ | Name | Type | Description | Notes |
853
+ | ---- | ---- | ----------- | ----- |
854
+ | **python_python_distribution_href** | **String** | | |
855
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
670
856
 
671
857
  ### Return type
672
858
 
@@ -684,16 +870,16 @@ Name | Type | Description | Notes
684
870
 
685
871
  ## update
686
872
 
687
- > AsyncOperationResponse update(python_python_distribution_href, python_python_distribution)
873
+ > <AsyncOperationResponse> update(python_python_distribution_href, python_python_distribution)
688
874
 
689
875
  Update a python distribution
690
876
 
691
877
  Trigger an asynchronous update task
692
878
 
693
- ### Example
879
+ ### Examples
694
880
 
695
881
  ```ruby
696
- # load the gem
882
+ require 'time'
697
883
  require 'pulp_python_client'
698
884
  # setup authorization
699
885
  PulpPythonClient.configure do |config|
@@ -704,24 +890,41 @@ end
704
890
 
705
891
  api_instance = PulpPythonClient::DistributionsPypiApi.new
706
892
  python_python_distribution_href = 'python_python_distribution_href_example' # String |
707
- python_python_distribution = PulpPythonClient::PythonPythonDistribution.new # PythonPythonDistribution |
893
+ python_python_distribution = PulpPythonClient::PythonPythonDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # PythonPythonDistribution |
708
894
 
709
895
  begin
710
- #Update a python distribution
896
+ # Update a python distribution
711
897
  result = api_instance.update(python_python_distribution_href, python_python_distribution)
712
898
  p result
713
899
  rescue PulpPythonClient::ApiError => e
714
- puts "Exception when calling DistributionsPypiApi->update: #{e}"
900
+ puts "Error when calling DistributionsPypiApi->update: #{e}"
715
901
  end
716
902
  ```
717
903
 
718
- ### Parameters
904
+ #### Using the update_with_http_info variant
905
+
906
+ This returns an Array which contains the response data, status code and headers.
907
+
908
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(python_python_distribution_href, python_python_distribution)
719
909
 
910
+ ```ruby
911
+ begin
912
+ # Update a python distribution
913
+ data, status_code, headers = api_instance.update_with_http_info(python_python_distribution_href, python_python_distribution)
914
+ p status_code # => 2xx
915
+ p headers # => { ... }
916
+ p data # => <AsyncOperationResponse>
917
+ rescue PulpPythonClient::ApiError => e
918
+ puts "Error when calling DistributionsPypiApi->update_with_http_info: #{e}"
919
+ end
920
+ ```
921
+
922
+ ### Parameters
720
923
 
721
- Name | Type | Description | Notes
722
- ------------- | ------------- | ------------- | -------------
723
- **python_python_distribution_href** | **String**| |
724
- **python_python_distribution** | [**PythonPythonDistribution**](PythonPythonDistribution.md)| |
924
+ | Name | Type | Description | Notes |
925
+ | ---- | ---- | ----------- | ----- |
926
+ | **python_python_distribution_href** | **String** | | |
927
+ | **python_python_distribution** | [**PythonPythonDistribution**](PythonPythonDistribution.md) | | |
725
928
 
726
929
  ### Return type
727
930