pulp_python_client 3.3.0 → 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -4
  3. data/build/lib/pulpcore/__init__.py +2 -0
  4. data/build/lib/pulpcore/client/__init__.py +2 -0
  5. data/build/lib/pulpcore/client/pulp_python/__init__.py +75 -0
  6. data/build/lib/pulpcore/client/pulp_python/api/__init__.py +15 -0
  7. data/build/lib/pulpcore/client/pulp_python/api/content_packages_api.py +626 -0
  8. data/build/lib/pulpcore/client/pulp_python/api/distributions_pypi_api.py +830 -0
  9. data/build/lib/pulpcore/client/pulp_python/api/publications_pypi_api.py +566 -0
  10. data/build/lib/pulpcore/client/pulp_python/api/pypi_api.py +162 -0
  11. data/build/lib/pulpcore/client/pulp_python/api/pypi_legacy_api.py +185 -0
  12. data/build/lib/pulpcore/client/pulp_python/api/pypi_metadata_api.py +171 -0
  13. data/build/lib/pulpcore/client/pulp_python/api/pypi_simple_api.py +434 -0
  14. data/build/lib/pulpcore/client/pulp_python/api/remotes_python_api.py +972 -0
  15. data/build/lib/pulpcore/client/pulp_python/api/repositories_python_api.py +1063 -0
  16. data/build/lib/pulpcore/client/pulp_python/api/repositories_python_versions_api.py +614 -0
  17. data/build/lib/pulpcore/client/pulp_python/api_client.py +667 -0
  18. data/build/lib/pulpcore/client/pulp_python/configuration.py +427 -0
  19. data/build/lib/pulpcore/client/pulp_python/exceptions.py +121 -0
  20. data/build/lib/pulpcore/client/pulp_python/models/__init__.py +51 -0
  21. data/build/lib/pulpcore/client/pulp_python/models/async_operation_response.py +124 -0
  22. data/build/lib/pulpcore/client/pulp_python/models/content_summary.py +176 -0
  23. data/build/lib/pulpcore/client/pulp_python/models/content_summary_response.py +176 -0
  24. data/build/lib/pulpcore/client/pulp_python/models/exclude_platforms_enum.py +103 -0
  25. data/build/lib/pulpcore/client/pulp_python/models/package_metadata_response.py +209 -0
  26. data/build/lib/pulpcore/client/pulp_python/models/package_types_enum.py +107 -0
  27. data/build/lib/pulpcore/client/pulp_python/models/package_upload.py +187 -0
  28. data/build/lib/pulpcore/client/pulp_python/models/package_upload_task_response.py +176 -0
  29. data/build/lib/pulpcore/client/pulp_python/models/paginated_repository_version_response_list.py +197 -0
  30. data/build/lib/pulpcore/client/pulp_python/models/paginatedpython_python_distribution_response_list.py +197 -0
  31. data/build/lib/pulpcore/client/pulp_python/models/paginatedpython_python_package_content_response_list.py +197 -0
  32. data/build/lib/pulpcore/client/pulp_python/models/paginatedpython_python_publication_response_list.py +197 -0
  33. data/build/lib/pulpcore/client/pulp_python/models/paginatedpython_python_remote_response_list.py +197 -0
  34. data/build/lib/pulpcore/client/pulp_python/models/paginatedpython_python_repository_response_list.py +197 -0
  35. data/build/lib/pulpcore/client/pulp_python/models/patchedpython_python_distribution.py +286 -0
  36. data/build/lib/pulpcore/client/pulp_python/models/patchedpython_python_remote.py +823 -0
  37. data/build/lib/pulpcore/client/pulp_python/models/patchedpython_python_repository.py +259 -0
  38. data/build/lib/pulpcore/client/pulp_python/models/policy_enum.py +102 -0
  39. data/build/lib/pulpcore/client/pulp_python/models/python_bander_remote.py +181 -0
  40. data/build/lib/pulpcore/client/pulp_python/models/python_python_distribution.py +288 -0
  41. data/build/lib/pulpcore/client/pulp_python/models/python_python_distribution_response.py +368 -0
  42. data/build/lib/pulpcore/client/pulp_python/models/python_python_package_content.py +824 -0
  43. data/build/lib/pulpcore/client/pulp_python/models/python_python_package_content_response.py +933 -0
  44. data/build/lib/pulpcore/client/pulp_python/models/python_python_publication.py +149 -0
  45. data/build/lib/pulpcore/client/pulp_python/models/python_python_publication_response.py +231 -0
  46. data/build/lib/pulpcore/client/pulp_python/models/python_python_remote.py +825 -0
  47. data/build/lib/pulpcore/client/pulp_python/models/python_python_remote_response.py +772 -0
  48. data/build/lib/pulpcore/client/pulp_python/models/python_python_repository.py +260 -0
  49. data/build/lib/pulpcore/client/pulp_python/models/python_python_repository_response.py +366 -0
  50. data/build/lib/pulpcore/client/pulp_python/models/repository_add_remove_content.py +179 -0
  51. data/build/lib/pulpcore/client/pulp_python/models/repository_sync_url.py +151 -0
  52. data/build/lib/pulpcore/client/pulp_python/models/repository_version.py +123 -0
  53. data/build/lib/pulpcore/client/pulp_python/models/repository_version_response.py +257 -0
  54. data/build/lib/pulpcore/client/pulp_python/models/summary_response.py +182 -0
  55. data/build/lib/pulpcore/client/pulp_python/rest.py +292 -0
  56. data/dist/pulp_python-client-3.4.0.tar.gz +0 -0
  57. data/dist/pulp_python_client-3.4.0-py3-none-any.whl +0 -0
  58. data/docs/ContentPackagesApi.md +6 -0
  59. data/docs/DistributionsPypiApi.md +2 -2
  60. data/docs/PackageMetadataResponse.md +23 -0
  61. data/docs/PackageUpload.md +21 -0
  62. data/docs/PackageUploadTaskResponse.md +21 -0
  63. data/docs/PatchedpythonPythonDistribution.md +3 -1
  64. data/docs/PatchedpythonPythonRemote.md +1 -1
  65. data/docs/PublicationsPypiApi.md +1 -1
  66. data/docs/PypiApi.md +62 -0
  67. data/docs/PypiLegacyApi.md +70 -0
  68. data/docs/PypiMetadataApi.md +64 -0
  69. data/docs/PypiSimpleApi.md +190 -0
  70. data/docs/PythonBanderRemote.md +1 -1
  71. data/docs/PythonPythonDistribution.md +3 -1
  72. data/docs/PythonPythonDistributionResponse.md +4 -2
  73. data/docs/PythonPythonPackageContent.md +6 -0
  74. data/docs/PythonPythonPackageContentResponse.md +5 -1
  75. data/docs/PythonPythonRemote.md +1 -1
  76. data/docs/PythonPythonRemoteResponse.md +1 -1
  77. data/docs/RemotesPythonApi.md +3 -3
  78. data/docs/RepositoriesPythonApi.md +4 -4
  79. data/docs/SummaryResponse.md +21 -0
  80. data/lib/pulp_python_client/api/content_packages_api.rb +9 -0
  81. data/lib/pulp_python_client/api/distributions_pypi_api.rb +4 -4
  82. data/lib/pulp_python_client/api/publications_pypi_api.rb +2 -2
  83. data/lib/pulp_python_client/api/pypi_api.rb +90 -0
  84. data/lib/pulp_python_client/api/pypi_legacy_api.rb +111 -0
  85. data/lib/pulp_python_client/api/pypi_metadata_api.rb +96 -0
  86. data/lib/pulp_python_client/api/pypi_simple_api.rb +249 -0
  87. data/lib/pulp_python_client/api/remotes_python_api.rb +4 -4
  88. data/lib/pulp_python_client/api/repositories_python_api.rb +8 -8
  89. data/lib/pulp_python_client/models/package_metadata_response.rb +257 -0
  90. data/lib/pulp_python_client/models/package_upload.rb +268 -0
  91. data/lib/pulp_python_client/models/package_upload_task_response.rb +240 -0
  92. data/lib/pulp_python_client/models/patchedpython_python_distribution.rb +17 -5
  93. data/lib/pulp_python_client/models/patchedpython_python_remote.rb +1 -1
  94. data/lib/pulp_python_client/models/python_bander_remote.rb +1 -1
  95. data/lib/pulp_python_client/models/python_python_distribution.rb +17 -5
  96. data/lib/pulp_python_client/models/python_python_distribution_response.rb +17 -6
  97. data/lib/pulp_python_client/models/python_python_package_content.rb +33 -1
  98. data/lib/pulp_python_client/models/python_python_package_content_response.rb +23 -1
  99. data/lib/pulp_python_client/models/python_python_remote.rb +1 -1
  100. data/lib/pulp_python_client/models/python_python_remote_response.rb +1 -1
  101. data/lib/pulp_python_client/models/summary_response.rb +243 -0
  102. data/lib/pulp_python_client/version.rb +1 -1
  103. data/lib/pulp_python_client.rb +8 -0
  104. data/pulp_python_client.egg-info/PKG-INFO +15 -0
  105. data/pulp_python_client.egg-info/SOURCES.txt +105 -0
  106. data/pulp_python_client.egg-info/dependency_links.txt +1 -0
  107. data/pulp_python_client.egg-info/requires.txt +4 -0
  108. data/pulp_python_client.egg-info/top_level.txt +1 -0
  109. data/pulpcore/__init__.py +2 -0
  110. data/pulpcore/client/__init__.py +2 -0
  111. data/pulpcore/client/pulp_python/__init__.py +75 -0
  112. data/pulpcore/client/pulp_python/api/__init__.py +15 -0
  113. data/pulpcore/client/pulp_python/api/content_packages_api.py +626 -0
  114. data/pulpcore/client/pulp_python/api/distributions_pypi_api.py +830 -0
  115. data/pulpcore/client/pulp_python/api/publications_pypi_api.py +566 -0
  116. data/pulpcore/client/pulp_python/api/pypi_api.py +162 -0
  117. data/pulpcore/client/pulp_python/api/pypi_legacy_api.py +185 -0
  118. data/pulpcore/client/pulp_python/api/pypi_metadata_api.py +171 -0
  119. data/pulpcore/client/pulp_python/api/pypi_simple_api.py +434 -0
  120. data/pulpcore/client/pulp_python/api/remotes_python_api.py +972 -0
  121. data/pulpcore/client/pulp_python/api/repositories_python_api.py +1063 -0
  122. data/pulpcore/client/pulp_python/api/repositories_python_versions_api.py +614 -0
  123. data/pulpcore/client/pulp_python/api_client.py +667 -0
  124. data/pulpcore/client/pulp_python/configuration.py +427 -0
  125. data/pulpcore/client/pulp_python/exceptions.py +121 -0
  126. data/pulpcore/client/pulp_python/models/__init__.py +51 -0
  127. data/pulpcore/client/pulp_python/models/async_operation_response.py +124 -0
  128. data/pulpcore/client/pulp_python/models/content_summary.py +176 -0
  129. data/pulpcore/client/pulp_python/models/content_summary_response.py +176 -0
  130. data/pulpcore/client/pulp_python/models/exclude_platforms_enum.py +103 -0
  131. data/pulpcore/client/pulp_python/models/package_metadata_response.py +209 -0
  132. data/pulpcore/client/pulp_python/models/package_types_enum.py +107 -0
  133. data/pulpcore/client/pulp_python/models/package_upload.py +187 -0
  134. data/pulpcore/client/pulp_python/models/package_upload_task_response.py +176 -0
  135. data/pulpcore/client/pulp_python/models/paginated_repository_version_response_list.py +197 -0
  136. data/pulpcore/client/pulp_python/models/paginatedpython_python_distribution_response_list.py +197 -0
  137. data/pulpcore/client/pulp_python/models/paginatedpython_python_package_content_response_list.py +197 -0
  138. data/pulpcore/client/pulp_python/models/paginatedpython_python_publication_response_list.py +197 -0
  139. data/pulpcore/client/pulp_python/models/paginatedpython_python_remote_response_list.py +197 -0
  140. data/pulpcore/client/pulp_python/models/paginatedpython_python_repository_response_list.py +197 -0
  141. data/pulpcore/client/pulp_python/models/patchedpython_python_distribution.py +286 -0
  142. data/pulpcore/client/pulp_python/models/patchedpython_python_remote.py +823 -0
  143. data/pulpcore/client/pulp_python/models/patchedpython_python_repository.py +259 -0
  144. data/pulpcore/client/pulp_python/models/policy_enum.py +102 -0
  145. data/pulpcore/client/pulp_python/models/python_bander_remote.py +181 -0
  146. data/pulpcore/client/pulp_python/models/python_python_distribution.py +288 -0
  147. data/pulpcore/client/pulp_python/models/python_python_distribution_response.py +368 -0
  148. data/pulpcore/client/pulp_python/models/python_python_package_content.py +824 -0
  149. data/pulpcore/client/pulp_python/models/python_python_package_content_response.py +933 -0
  150. data/pulpcore/client/pulp_python/models/python_python_publication.py +149 -0
  151. data/pulpcore/client/pulp_python/models/python_python_publication_response.py +231 -0
  152. data/pulpcore/client/pulp_python/models/python_python_remote.py +825 -0
  153. data/pulpcore/client/pulp_python/models/python_python_remote_response.py +772 -0
  154. data/pulpcore/client/pulp_python/models/python_python_repository.py +260 -0
  155. data/pulpcore/client/pulp_python/models/python_python_repository_response.py +366 -0
  156. data/pulpcore/client/pulp_python/models/repository_add_remove_content.py +179 -0
  157. data/pulpcore/client/pulp_python/models/repository_sync_url.py +151 -0
  158. data/pulpcore/client/pulp_python/models/repository_version.py +123 -0
  159. data/pulpcore/client/pulp_python/models/repository_version_response.py +257 -0
  160. data/pulpcore/client/pulp_python/models/summary_response.py +182 -0
  161. data/pulpcore/client/pulp_python/rest.py +292 -0
  162. data/requirements.txt +6 -0
  163. data/setup.cfg +2 -0
  164. data/setup.py +42 -0
  165. data/spec/api/content_packages_api_spec.rb +3 -0
  166. data/spec/api/distributions_pypi_api_spec.rb +2 -2
  167. data/spec/api/publications_pypi_api_spec.rb +1 -1
  168. data/spec/api/pypi_api_spec.rb +49 -0
  169. data/spec/api/pypi_legacy_api_spec.rb +50 -0
  170. data/spec/api/pypi_metadata_api_spec.rb +50 -0
  171. data/spec/api/pypi_simple_api_spec.rb +79 -0
  172. data/spec/api/remotes_python_api_spec.rb +2 -2
  173. data/spec/api/repositories_python_api_spec.rb +4 -4
  174. data/spec/models/package_metadata_response_spec.rb +59 -0
  175. data/spec/models/package_upload_spec.rb +53 -0
  176. data/spec/models/package_upload_task_response_spec.rb +53 -0
  177. data/spec/models/patchedpython_python_distribution_spec.rb +6 -0
  178. data/spec/models/python_python_distribution_response_spec.rb +6 -0
  179. data/spec/models/python_python_distribution_spec.rb +6 -0
  180. data/spec/models/python_python_package_content_response_spec.rb +12 -0
  181. data/spec/models/python_python_package_content_spec.rb +18 -0
  182. data/spec/models/summary_response_spec.rb +53 -0
  183. data/test/__init__.py +0 -0
  184. data/test/test_async_operation_response.py +54 -0
  185. data/test/test_content_packages_api.py +55 -0
  186. data/test/test_content_summary.py +70 -0
  187. data/test/test_content_summary_response.py +70 -0
  188. data/test/test_distributions_pypi_api.py +76 -0
  189. data/test/test_exclude_platforms_enum.py +52 -0
  190. data/test/test_package_metadata_response.py +60 -0
  191. data/test/test_package_types_enum.py +52 -0
  192. data/test/test_package_upload.py +57 -0
  193. data/test/test_package_upload_task_response.py +58 -0
  194. data/test/test_paginated_repository_version_response_list.py +64 -0
  195. data/test/test_paginatedpython_python_distribution_response_list.py +68 -0
  196. data/test/test_paginatedpython_python_package_content_response_list.py +88 -0
  197. data/test/test_paginatedpython_python_publication_response_list.py +65 -0
  198. data/test/test_paginatedpython_python_remote_response_list.py +88 -0
  199. data/test/test_paginatedpython_python_repository_response_list.py +68 -0
  200. data/test/test_patchedpython_python_distribution.py +59 -0
  201. data/test/test_patchedpython_python_remote.py +84 -0
  202. data/test/test_patchedpython_python_repository.py +58 -0
  203. data/test/test_policy_enum.py +52 -0
  204. data/test/test_publications_pypi_api.py +62 -0
  205. data/test/test_pypi_api.py +41 -0
  206. data/test/test_pypi_legacy_api.py +41 -0
  207. data/test/test_pypi_metadata_api.py +41 -0
  208. data/test/test_pypi_simple_api.py +55 -0
  209. data/test/test_python_bander_remote.py +57 -0
  210. data/test/test_python_python_distribution.py +61 -0
  211. data/test/test_python_python_distribution_response.py +64 -0
  212. data/test/test_python_python_package_content.py +79 -0
  213. data/test/test_python_python_package_content_response.py +82 -0
  214. data/test/test_python_python_publication.py +54 -0
  215. data/test/test_python_python_publication_response.py +59 -0
  216. data/test/test_python_python_remote.py +86 -0
  217. data/test/test_python_python_remote_response.py +84 -0
  218. data/test/test_python_python_repository.py +59 -0
  219. data/test/test_python_python_repository_response.py +63 -0
  220. data/test/test_remotes_python_api.py +83 -0
  221. data/test/test_repositories_python_api.py +90 -0
  222. data/test/test_repositories_python_versions_api.py +61 -0
  223. data/test/test_repository_add_remove_content.py +59 -0
  224. data/test/test_repository_sync_url.py +54 -0
  225. data/test/test_repository_version.py +53 -0
  226. data/test/test_repository_version_response.py +58 -0
  227. data/test/test_summary_response.py +58 -0
  228. data/test-requirements.txt +3 -0
  229. data/tox.ini +9 -0
  230. metadata +221 -26
@@ -0,0 +1,190 @@
1
+ # PulpPythonClient::PypiSimpleApi
2
+
3
+ All URIs are relative to *http://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](PypiSimpleApi.md#create) | **POST** /pypi/{path}/simple/ | Upload a package
8
+ [**read**](PypiSimpleApi.md#read) | **GET** /pypi/{path}/simple/ | Get index simple page
9
+ [**read_0**](PypiSimpleApi.md#read_0) | **GET** /pypi/{path}/simple/{package}/ | Get package simple page
10
+
11
+
12
+
13
+ ## create
14
+
15
+ > PackageUploadTaskResponse create(path, content, sha256_digest, opts)
16
+
17
+ Upload a package
18
+
19
+ Upload package to the index. This endpoint has the same functionality as the upload endpoint at the `/legacy` url of the index. This is provided for convenience for users who want a single index url for all their Python tools. (pip, twine, poetry, pipenv, ...)
20
+
21
+ ### Example
22
+
23
+ ```ruby
24
+ # load the gem
25
+ require 'pulp_python_client'
26
+ # setup authorization
27
+ PulpPythonClient.configure do |config|
28
+ # Configure HTTP basic authorization: basicAuth
29
+ config.username = 'YOUR USERNAME'
30
+ config.password = 'YOUR PASSWORD'
31
+ end
32
+
33
+ api_instance = PulpPythonClient::PypiSimpleApi.new
34
+ path = 'path_example' # String |
35
+ content = File.new('/path/to/file') # File | A Python package release file to upload to the index.
36
+ sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
37
+ opts = {
38
+ action: 'file_upload' # String | Defaults to `file_upload`, don't change it or request will fail!
39
+ }
40
+
41
+ begin
42
+ #Upload a package
43
+ result = api_instance.create(path, content, sha256_digest, opts)
44
+ p result
45
+ rescue PulpPythonClient::ApiError => e
46
+ puts "Exception when calling PypiSimpleApi->create: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+
53
+ Name | Type | Description | Notes
54
+ ------------- | ------------- | ------------- | -------------
55
+ **path** | **String**| |
56
+ **content** | **File**| A Python package release file to upload to the index. |
57
+ **sha256_digest** | **String**| SHA256 of package to validate upload integrity. |
58
+ **action** | **String**| Defaults to `file_upload`, don't change it or request will fail! | [optional] [default to 'file_upload']
59
+
60
+ ### Return type
61
+
62
+ [**PackageUploadTaskResponse**](PackageUploadTaskResponse.md)
63
+
64
+ ### Authorization
65
+
66
+ [basicAuth](../README.md#basicAuth)
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
71
+ - **Accept**: application/json
72
+
73
+
74
+ ## read
75
+
76
+ > read(path, opts)
77
+
78
+ Get index simple page
79
+
80
+ Gets the simple api html page for the index.
81
+
82
+ ### Example
83
+
84
+ ```ruby
85
+ # load the gem
86
+ require 'pulp_python_client'
87
+ # setup authorization
88
+ PulpPythonClient.configure do |config|
89
+ # Configure HTTP basic authorization: basicAuth
90
+ config.username = 'YOUR USERNAME'
91
+ config.password = 'YOUR PASSWORD'
92
+ end
93
+
94
+ api_instance = PulpPythonClient::PypiSimpleApi.new
95
+ path = 'path_example' # String |
96
+ opts = {
97
+ fields: 'fields_example', # String | A list of fields to include in the response.
98
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
99
+ }
100
+
101
+ begin
102
+ #Get index simple page
103
+ api_instance.read(path, opts)
104
+ rescue PulpPythonClient::ApiError => e
105
+ puts "Exception when calling PypiSimpleApi->read: #{e}"
106
+ end
107
+ ```
108
+
109
+ ### Parameters
110
+
111
+
112
+ Name | Type | Description | Notes
113
+ ------------- | ------------- | ------------- | -------------
114
+ **path** | **String**| |
115
+ **fields** | **String**| A list of fields to include in the response. | [optional]
116
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
117
+
118
+ ### Return type
119
+
120
+ nil (empty response body)
121
+
122
+ ### Authorization
123
+
124
+ [basicAuth](../README.md#basicAuth)
125
+
126
+ ### HTTP request headers
127
+
128
+ - **Content-Type**: Not defined
129
+ - **Accept**: Not defined
130
+
131
+
132
+ ## read_0
133
+
134
+ > read_0(package, path, opts)
135
+
136
+ Get package simple page
137
+
138
+ Retrieves the simple api html page for a package.
139
+
140
+ ### Example
141
+
142
+ ```ruby
143
+ # load the gem
144
+ require 'pulp_python_client'
145
+ # setup authorization
146
+ PulpPythonClient.configure do |config|
147
+ # Configure HTTP basic authorization: basicAuth
148
+ config.username = 'YOUR USERNAME'
149
+ config.password = 'YOUR PASSWORD'
150
+ end
151
+
152
+ api_instance = PulpPythonClient::PypiSimpleApi.new
153
+ package = 'package_example' # String |
154
+ path = 'path_example' # String |
155
+ opts = {
156
+ fields: 'fields_example', # String | A list of fields to include in the response.
157
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
158
+ }
159
+
160
+ begin
161
+ #Get package simple page
162
+ api_instance.read_0(package, path, opts)
163
+ rescue PulpPythonClient::ApiError => e
164
+ puts "Exception when calling PypiSimpleApi->read_0: #{e}"
165
+ end
166
+ ```
167
+
168
+ ### Parameters
169
+
170
+
171
+ Name | Type | Description | Notes
172
+ ------------- | ------------- | ------------- | -------------
173
+ **package** | **String**| |
174
+ **path** | **String**| |
175
+ **fields** | **String**| A list of fields to include in the response. | [optional]
176
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
177
+
178
+ ### Return type
179
+
180
+ nil (empty response body)
181
+
182
+ ### Authorization
183
+
184
+ [basicAuth](../README.md#basicAuth)
185
+
186
+ ### HTTP request headers
187
+
188
+ - **Content-Type**: Not defined
189
+ - **Accept**: Not defined
190
+
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **config** | **File** | A Bandersnatch config that may be used to construct a Python Remote. |
8
8
  **name** | **String** | A unique name for this remote |
9
- **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional]
9
+ **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. | [optional]
10
10
 
11
11
  ## Code Sample
12
12
 
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
11
11
  **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
12
12
  **publication** | **String** | Publication to be served | [optional]
13
+ **allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional] [default to true]
13
14
 
14
15
  ## Code Sample
15
16
 
@@ -21,7 +22,8 @@ instance = PulpPythonClient::PythonPythonDistribution.new(base_path: null,
21
22
  pulp_labels: null,
22
23
  name: null,
23
24
  repository: null,
24
- publication: null)
25
+ publication: null,
26
+ allow_uploads: null)
25
27
  ```
26
28
 
27
29
 
@@ -7,12 +7,13 @@ Name | Type | Description | Notes
7
7
  **pulp_href** | **String** | | [optional] [readonly]
8
8
  **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
9
9
  **base_path** | **String** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
10
- **base_url** | **String** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
10
+ **base_url** | **String** | | [optional] [readonly]
11
11
  **content_guard** | **String** | An optional content-guard. | [optional]
12
12
  **pulp_labels** | [**Object**](.md) | | [optional]
13
13
  **name** | **String** | A unique name. Ex, `rawhide` and `stable`. |
14
14
  **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional]
15
15
  **publication** | **String** | Publication to be served | [optional]
16
+ **allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional] [default to true]
16
17
 
17
18
  ## Code Sample
18
19
 
@@ -27,7 +28,8 @@ instance = PulpPythonClient::PythonPythonDistributionResponse.new(pulp_href: nul
27
28
  pulp_labels: null,
28
29
  name: null,
29
30
  repository: null,
30
- publication: null)
31
+ publication: null,
32
+ allow_uploads: null)
31
33
  ```
32
34
 
33
35
 
@@ -8,8 +8,10 @@ Name | Type | Description | Notes
8
8
  **relative_path** | **String** | Path where the artifact is located relative to distributions base_path |
9
9
  **file** | **File** | An uploaded file that may be turned into the artifact of the content unit. | [optional]
10
10
  **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional]
11
+ **sha256** | **String** | The SHA256 digest of this package. | [optional] [default to '']
11
12
  **summary** | **String** | A one-line summary of what the package does. | [optional]
12
13
  **description** | **String** | A longer description of the package that can run to several paragraphs. | [optional]
14
+ **description_content_type** | **String** | A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description. | [optional]
13
15
  **keywords** | **String** | Additional keywords to be used to assist searching for the package in a larger catalog. | [optional]
14
16
  **home_page** | **String** | The URL for the package's home page. | [optional]
15
17
  **download_url** | **String** | Legacy field denoting the URL from which this package can be downloaded. | [optional]
@@ -20,6 +22,7 @@ Name | Type | Description | Notes
20
22
  **license** | **String** | Text indicating the license covering the distribution | [optional]
21
23
  **requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional]
22
24
  **project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional]
25
+ **project_urls** | [**Object**](.md) | A dictionary of labels and URLs for the project. | [optional]
23
26
  **platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional]
24
27
  **supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled. | [optional]
25
28
  **requires_dist** | [**Object**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional]
@@ -37,8 +40,10 @@ instance = PulpPythonClient::PythonPythonPackageContent.new(artifact: null,
37
40
  relative_path: null,
38
41
  file: null,
39
42
  repository: null,
43
+ sha256: null,
40
44
  summary: null,
41
45
  description: null,
46
+ description_content_type: null,
42
47
  keywords: null,
43
48
  home_page: null,
44
49
  download_url: null,
@@ -49,6 +54,7 @@ instance = PulpPythonClient::PythonPythonPackageContent.new(artifact: null,
49
54
  license: null,
50
55
  requires_python: null,
51
56
  project_url: null,
57
+ project_urls: null,
52
58
  platform: null,
53
59
  supported_platform: null,
54
60
  requires_dist: null,
@@ -11,10 +11,11 @@ Name | Type | Description | Notes
11
11
  **packagetype** | **String** | The type of the distribution package (e.g. sdist, bdist_wheel, bdist_egg, etc) | [optional] [readonly]
12
12
  **name** | **String** | The name of the python project. | [optional] [readonly]
13
13
  **version** | **String** | The packages version number. | [optional] [readonly]
14
- **sha256** | **String** | The SHA256 digest of this package. | [optional] [readonly]
14
+ **sha256** | **String** | The SHA256 digest of this package. | [optional] [default to '']
15
15
  **metadata_version** | **String** | Version of the file format | [optional] [readonly]
16
16
  **summary** | **String** | A one-line summary of what the package does. | [optional]
17
17
  **description** | **String** | A longer description of the package that can run to several paragraphs. | [optional]
18
+ **description_content_type** | **String** | A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description. | [optional]
18
19
  **keywords** | **String** | Additional keywords to be used to assist searching for the package in a larger catalog. | [optional]
19
20
  **home_page** | **String** | The URL for the package's home page. | [optional]
20
21
  **download_url** | **String** | Legacy field denoting the URL from which this package can be downloaded. | [optional]
@@ -25,6 +26,7 @@ Name | Type | Description | Notes
25
26
  **license** | **String** | Text indicating the license covering the distribution | [optional]
26
27
  **requires_python** | **String** | The Python version(s) that the distribution is guaranteed to be compatible with. | [optional]
27
28
  **project_url** | **String** | A browsable URL for the project and a label for it, separated by a comma. | [optional]
29
+ **project_urls** | [**Object**](.md) | A dictionary of labels and URLs for the project. | [optional]
28
30
  **platform** | **String** | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional]
29
31
  **supported_platform** | **String** | Field to specify the OS and CPU for which the binary package was compiled. | [optional]
30
32
  **requires_dist** | [**Object**](.md) | A JSON list containing names of some other distutils project required by this distribution. | [optional]
@@ -49,6 +51,7 @@ instance = PulpPythonClient::PythonPythonPackageContentResponse.new(pulp_href: n
49
51
  metadata_version: null,
50
52
  summary: null,
51
53
  description: null,
54
+ description_content_type: null,
52
55
  keywords: null,
53
56
  home_page: null,
54
57
  download_url: null,
@@ -59,6 +62,7 @@ instance = PulpPythonClient::PythonPythonPackageContentResponse.new(pulp_href: n
59
62
  license: null,
60
63
  requires_python: null,
61
64
  project_url: null,
65
+ project_urls: null,
62
66
  platform: null,
63
67
  supported_platform: null,
64
68
  requires_dist: null,
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
17
17
  **password** | **String** | The password to be used for authentication when syncing. | [optional]
18
18
  **pulp_labels** | [**Object**](.md) | | [optional]
19
19
  **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
20
- **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional]
20
+ **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. | [optional]
21
21
  **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. | [optional]
22
22
  **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. | [optional]
23
23
  **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. | [optional]
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
15
15
  **pulp_labels** | [**Object**](.md) | | [optional]
16
16
  **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
17
17
  **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional]
18
- **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional]
18
+ **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. | [optional]
19
19
  **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. | [optional]
20
20
  **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. | [optional]
21
21
  **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. | [optional]
@@ -126,7 +126,7 @@ Name | Type | Description | Notes
126
126
 
127
127
  Create from Bandersnatch
128
128
 
129
- Create a remote from a Bandersnatch config
129
+ Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
130
130
 
131
131
  ### Example
132
132
 
@@ -144,7 +144,7 @@ api_instance = PulpPythonClient::RemotesPythonApi.new
144
144
  config = File.new('/path/to/file') # File | A Bandersnatch config that may be used to construct a Python Remote.
145
145
  name = 'name_example' # String | A unique name for this remote
146
146
  opts = {
147
- policy: PulpPythonClient::PolicyEnum.new # PolicyEnum | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default.
147
+ policy: PulpPythonClient::PolicyEnum.new # PolicyEnum | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default.
148
148
  }
149
149
 
150
150
  begin
@@ -163,7 +163,7 @@ Name | Type | Description | Notes
163
163
  ------------- | ------------- | ------------- | -------------
164
164
  **config** | **File**| A Bandersnatch config that may be used to construct a Python Remote. |
165
165
  **name** | **String**| A unique name for this remote |
166
- **policy** | [**PolicyEnum**](PolicyEnum.md)| The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional]
166
+ **policy** | [**PolicyEnum**](PolicyEnum.md)| The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. | [optional]
167
167
 
168
168
  ### Return type
169
169
 
@@ -21,7 +21,7 @@ Method | HTTP request | Description
21
21
 
22
22
  Create a python repository
23
23
 
24
- A ViewSet for PythonRepository.
24
+ PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
25
25
 
26
26
  ### Example
27
27
 
@@ -127,7 +127,7 @@ Name | Type | Description | Notes
127
127
 
128
128
  List python repositorys
129
129
 
130
- A ViewSet for PythonRepository.
130
+ PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
131
131
 
132
132
  ### Example
133
133
 
@@ -312,7 +312,7 @@ Name | Type | Description | Notes
312
312
 
313
313
  Inspect a python repository
314
314
 
315
- A ViewSet for PythonRepository.
315
+ PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
316
316
 
317
317
  ### Example
318
318
 
@@ -371,7 +371,7 @@ Name | Type | Description | Notes
371
371
 
372
372
  Sync from remote
373
373
 
374
- Trigger an asynchronous task to sync Python content.
374
+ Trigger an asynchronous task to sync python content. The sync task will retrieve Python content from the specified `Remote` and update the specified `Respository`, creating a new `RepositoryVersion`.
375
375
 
376
376
  ### Example
377
377
 
@@ -0,0 +1,21 @@
1
+ # PulpPythonClient::SummaryResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **projects** | **Integer** | Number of Python projects in index |
8
+ **releases** | **Integer** | Number of Python distribution releases in index |
9
+ **files** | **Integer** | Number of files for all distributions in index |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'PulpPythonClient'
15
+
16
+ instance = PulpPythonClient::SummaryResponse.new(projects: null,
17
+ releases: null,
18
+ files: null)
19
+ ```
20
+
21
+
@@ -26,8 +26,10 @@ module PulpPythonClient
26
26
  # @option opts [String] :artifact Artifact file representing the physical content
27
27
  # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit.
28
28
  # @option opts [String] :repository A URI of a repository the new content unit should be associated with.
29
+ # @option opts [String] :sha256 The SHA256 digest of this package. (default to '')
29
30
  # @option opts [String] :summary A one-line summary of what the package does.
30
31
  # @option opts [String] :description A longer description of the package that can run to several paragraphs.
32
+ # @option opts [String] :description_content_type A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.
31
33
  # @option opts [String] :keywords Additional keywords to be used to assist searching for the package in a larger catalog.
32
34
  # @option opts [String] :home_page The URL for the package's home page.
33
35
  # @option opts [String] :download_url Legacy field denoting the URL from which this package can be downloaded.
@@ -38,6 +40,7 @@ module PulpPythonClient
38
40
  # @option opts [String] :license Text indicating the license covering the distribution
39
41
  # @option opts [String] :requires_python The Python version(s) that the distribution is guaranteed to be compatible with.
40
42
  # @option opts [String] :project_url A browsable URL for the project and a label for it, separated by a comma.
43
+ # @option opts [Object] :project_urls A dictionary of labels and URLs for the project.
41
44
  # @option opts [String] :platform A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
42
45
  # @option opts [String] :supported_platform Field to specify the OS and CPU for which the binary package was compiled.
43
46
  # @option opts [Object] :requires_dist A JSON list containing names of some other distutils project required by this distribution.
@@ -58,8 +61,10 @@ module PulpPythonClient
58
61
  # @option opts [String] :artifact Artifact file representing the physical content
59
62
  # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit.
60
63
  # @option opts [String] :repository A URI of a repository the new content unit should be associated with.
64
+ # @option opts [String] :sha256 The SHA256 digest of this package.
61
65
  # @option opts [String] :summary A one-line summary of what the package does.
62
66
  # @option opts [String] :description A longer description of the package that can run to several paragraphs.
67
+ # @option opts [String] :description_content_type A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.
63
68
  # @option opts [String] :keywords Additional keywords to be used to assist searching for the package in a larger catalog.
64
69
  # @option opts [String] :home_page The URL for the package's home page.
65
70
  # @option opts [String] :download_url Legacy field denoting the URL from which this package can be downloaded.
@@ -70,6 +75,7 @@ module PulpPythonClient
70
75
  # @option opts [String] :license Text indicating the license covering the distribution
71
76
  # @option opts [String] :requires_python The Python version(s) that the distribution is guaranteed to be compatible with.
72
77
  # @option opts [String] :project_url A browsable URL for the project and a label for it, separated by a comma.
78
+ # @option opts [Object] :project_urls A dictionary of labels and URLs for the project.
73
79
  # @option opts [String] :platform A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
74
80
  # @option opts [String] :supported_platform Field to specify the OS and CPU for which the binary package was compiled.
75
81
  # @option opts [Object] :requires_dist A JSON list containing names of some other distutils project required by this distribution.
@@ -105,8 +111,10 @@ module PulpPythonClient
105
111
  form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
106
112
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
107
113
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
114
+ form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
108
115
  form_params['summary'] = opts[:'summary'] if !opts[:'summary'].nil?
109
116
  form_params['description'] = opts[:'description'] if !opts[:'description'].nil?
117
+ form_params['description_content_type'] = opts[:'description_content_type'] if !opts[:'description_content_type'].nil?
110
118
  form_params['keywords'] = opts[:'keywords'] if !opts[:'keywords'].nil?
111
119
  form_params['home_page'] = opts[:'home_page'] if !opts[:'home_page'].nil?
112
120
  form_params['download_url'] = opts[:'download_url'] if !opts[:'download_url'].nil?
@@ -117,6 +125,7 @@ module PulpPythonClient
117
125
  form_params['license'] = opts[:'license'] if !opts[:'license'].nil?
118
126
  form_params['requires_python'] = opts[:'requires_python'] if !opts[:'requires_python'].nil?
119
127
  form_params['project_url'] = opts[:'project_url'] if !opts[:'project_url'].nil?
128
+ form_params['project_urls'] = opts[:'project_urls'] if !opts[:'project_urls'].nil?
120
129
  form_params['platform'] = opts[:'platform'] if !opts[:'platform'].nil?
121
130
  form_params['supported_platform'] = opts[:'supported_platform'] if !opts[:'supported_platform'].nil?
122
131
  form_params['requires_dist'] = opts[:'requires_dist'] if !opts[:'requires_dist'].nil?
@@ -146,7 +146,7 @@ module PulpPythonClient
146
146
  end
147
147
 
148
148
  # List python distributions
149
- # Pulp Python Distributions are used to distribute Python Publications. Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
149
+ # 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.
150
150
  # @param [Hash] opts the optional parameters
151
151
  # @option opts [String] :base_path
152
152
  # @option opts [String] :base_path__contains Filter results where base_path contains value
@@ -170,7 +170,7 @@ module PulpPythonClient
170
170
  end
171
171
 
172
172
  # List python distributions
173
- # Pulp Python Distributions are used to distribute Python Publications. Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
173
+ # 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.
174
174
  # @param [Hash] opts the optional parameters
175
175
  # @option opts [String] :base_path
176
176
  # @option opts [String] :base_path__contains Filter results where base_path contains value
@@ -317,7 +317,7 @@ module PulpPythonClient
317
317
  end
318
318
 
319
319
  # Inspect a python distribution
320
- # Pulp Python Distributions are used to distribute Python Publications. Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
320
+ # 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.
321
321
  # @param python_python_distribution_href [String]
322
322
  # @param [Hash] opts the optional parameters
323
323
  # @option opts [String] :fields A list of fields to include in the response.
@@ -329,7 +329,7 @@ module PulpPythonClient
329
329
  end
330
330
 
331
331
  # Inspect a python distribution
332
- # Pulp Python Distributions are used to distribute Python Publications. Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
332
+ # 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.
333
333
  # @param python_python_distribution_href [String]
334
334
  # @param [Hash] opts the optional parameters
335
335
  # @option opts [String] :fields A list of fields to include in the response.
@@ -20,7 +20,7 @@ module PulpPythonClient
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create a python publication
23
- # Trigger an asynchronous task to publish python content.
23
+ # Dispatches a publish task, which generates metadata that will be used by pip.
24
24
  # @param python_python_publication [PythonPythonPublication]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [AsyncOperationResponse]
@@ -30,7 +30,7 @@ module PulpPythonClient
30
30
  end
31
31
 
32
32
  # Create a python publication
33
- # Trigger an asynchronous task to publish python content.
33
+ # Dispatches a publish task, which generates metadata that will be used by pip.
34
34
  # @param python_python_publication [PythonPythonPublication]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
@@ -0,0 +1,90 @@
1
+ =begin
2
+ #Pulp 3 API
3
+
4
+ #Fetch, Upload, Organize, and Distribute Software Packages
5
+
6
+ The version of the OpenAPI document: v3
7
+ Contact: pulp-list@redhat.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module PulpPythonClient
16
+ class PypiApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get index summary
23
+ # Gets package summary stats of index.
24
+ # @param path [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :fields A list of fields to include in the response.
27
+ # @option opts [String] :exclude_fields A list of fields to exclude from the response.
28
+ # @return [SummaryResponse]
29
+ def read(path, opts = {})
30
+ data, _status_code, _headers = read_with_http_info(path, opts)
31
+ data
32
+ end
33
+
34
+ # Get index summary
35
+ # Gets package summary stats of index.
36
+ # @param path [String]
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [String] :fields A list of fields to include in the response.
39
+ # @option opts [String] :exclude_fields A list of fields to exclude from the response.
40
+ # @return [Array<(SummaryResponse, Integer, Hash)>] SummaryResponse data, response status code and response headers
41
+ def read_with_http_info(path, opts = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: PypiApi.read ...'
44
+ end
45
+ # verify the required parameter 'path' is set
46
+ if @api_client.config.client_side_validation && path.nil?
47
+ fail ArgumentError, "Missing the required parameter 'path' when calling PypiApi.read"
48
+ end
49
+ # resource path
50
+ local_var_path = '/pypi/{path}/'.sub('{' + 'path' + '}', CGI.escape(path.to_s).gsub('%2F', '/'))
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+ query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
55
+ query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
56
+
57
+ # header parameters
58
+ header_params = opts[:header_params] || {}
59
+ # HTTP header 'Accept' (if needed)
60
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+
62
+ # form parameters
63
+ form_params = opts[:form_params] || {}
64
+
65
+ # http body (model)
66
+ post_body = opts[:body]
67
+
68
+ # return_type
69
+ return_type = opts[:return_type] || 'SummaryResponse'
70
+
71
+ # auth_names
72
+ auth_names = opts[:auth_names] || []
73
+
74
+ new_options = opts.merge(
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: PypiApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+ end
90
+ end