pulp_python_client 3.12.5 → 3.13.0

data/docs/ExcludePlatformsEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
 instance = PulpPythonClient::ExcludePlatformsEnum.new()
 ```
 
-

data/docs/MyPermissionsResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**permissions** | **Array<String>** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **permissions** | **Array<String>** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::MyPermissionsResponse.new(permissions: null)
+instance = PulpPythonClient::MyPermissionsResponse.new(
+  permissions: null
+)
 ```
 
-

data/docs/NestedRole.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**users** | **Array<String>** |  | [optional] 
-**groups** | **Array<String>** |  | [optional] 
-**role** | **String** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | **Array<String>** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **role** | **String** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::NestedRole.new(users: null,
-                                 groups: null,
-                                 role: null)
+instance = PulpPythonClient::NestedRole.new(
+  users: null,
+  groups: null,
+  role: null
+)
 ```
 
-

data/docs/NestedRoleResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**users** | **Array<String>** |  | [optional] 
-**groups** | **Array<String>** |  | [optional] 
-**role** | **String** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | **Array<String>** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **role** | **String** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::NestedRoleResponse.new(users: null,
-                                 groups: null,
-                                 role: null)
+instance = PulpPythonClient::NestedRoleResponse.new(
+  users: null,
+  groups: null,
+  role: null
+)
 ```
 
-

data/docs/ObjectRolesResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **roles** | [**Array<NestedRoleResponse>**](NestedRoleResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::ObjectRolesResponse.new(roles: null)
+instance = PulpPythonClient::ObjectRolesResponse.new(
+  roles: null
+)
 ```
 
-

data/docs/PackageMetadataResponse.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**last_serial** | **Integer** | Cache value from last PyPI sync | 
-**info** | [**Object**](.md) | Core metadata of the package | 
-**releases** | [**Object**](.md) | List of all the releases of the package | 
-**urls** | [**Object**](.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last_serial** | **Integer** | Cache value from last PyPI sync |  |
+| **info** | **Object** | Core metadata of the package |  |
+| **releases** | **Object** | List of all the releases of the package |  |
+| **urls** | **Object** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PackageMetadataResponse.new(last_serial: null,
-                                 info: null,
-                                 releases: null,
-                                 urls: null)
+instance = PulpPythonClient::PackageMetadataResponse.new(
+  last_serial: null,
+  info: null,
+  releases: null,
+  urls: null
+)
 ```
 
-

data/docs/PackageTypesEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
 instance = PulpPythonClient::PackageTypesEnum.new()
 ```
 
-

data/docs/PackageUploadTaskResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**session** | **String** |  | 
-**task** | **String** |  | 
-**task_start_time** | **DateTime** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session** | **String** |  |  |
+| **task** | **String** |  |  |
+| **task_start_time** | **Time** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PackageUploadTaskResponse.new(session: null,
-                                 task: null,
-                                 task_start_time: null)
+instance = PulpPythonClient::PackageUploadTaskResponse.new(
+  session: null,
+  task: null,
+  task_start_time: null
+)
 ```
 
-

data/docs/PaginatedRepositoryVersionResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<RepositoryVersionResponse>**](RepositoryVersionResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PaginatedRepositoryVersionResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpPythonClient::PaginatedRepositoryVersionResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedpythonPythonDistributionResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<PythonPythonDistributionResponse>**](PythonPythonDistributionResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<PythonPythonDistributionResponse>**](PythonPythonDistributionResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PaginatedpythonPythonDistributionResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpPythonClient::PaginatedpythonPythonDistributionResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedpythonPythonPackageContentResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<PythonPythonPackageContentResponse>**](PythonPythonPackageContentResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<PythonPythonPackageContentResponse>**](PythonPythonPackageContentResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PaginatedpythonPythonPackageContentResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpPythonClient::PaginatedpythonPythonPackageContentResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedpythonPythonPublicationResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<PythonPythonPublicationResponse>**](PythonPythonPublicationResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<PythonPythonPublicationResponse>**](PythonPythonPublicationResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PaginatedpythonPythonPublicationResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpPythonClient::PaginatedpythonPythonPublicationResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedpythonPythonRemoteResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<PythonPythonRemoteResponse>**](PythonPythonRemoteResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<PythonPythonRemoteResponse>**](PythonPythonRemoteResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PaginatedpythonPythonRemoteResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpPythonClient::PaginatedpythonPythonRemoteResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PaginatedpythonPythonRepositoryResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<PythonPythonRepositoryResponse>**](PythonPythonRepositoryResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<PythonPythonRepositoryResponse>**](PythonPythonRepositoryResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PaginatedpythonPythonRepositoryResponseList.new(count: 123,
-                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
-                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
-                                 results: null)
+instance = PulpPythonClient::PaginatedpythonPythonRepositoryResponseList.new(
+  count: 123,
+  _next: http://api.example.org/accounts/?offset=400&limit=100,
+  previous: http://api.example.org/accounts/?offset=200&limit=100,
+  results: null
+)
 ```
 
-

data/docs/PatchedpythonPythonDistribution.md

@@ -2,32 +2,33 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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\") | [optional] 
-**content_guard** | **String** | An optional content-guard. | [optional] 
-**hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional] [default to false]
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
-**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
-**publication** | **String** | Publication to be served | [optional] 
-**allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional] [default to true]
-**remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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\") | [optional] |
+| **content_guard** | **String** | An optional content-guard. | [optional] |
+| **hidden** | **Boolean** | Whether this distribution should be shown in the content app. | [optional][default to false] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] |
+| **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] |
+| **publication** | **String** | Publication to be served | [optional] |
+| **allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional][default to true] |
+| **remote** | **String** | Remote that can be used to fetch content when using pull-through caching. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpPythonClient'
+require 'pulp_python_client'
 
-instance = PulpPythonClient::PatchedpythonPythonDistribution.new(base_path: null,
-                                 content_guard: null,
-                                 hidden: null,
-                                 pulp_labels: null,
-                                 name: null,
-                                 repository: null,
-                                 publication: null,
-                                 allow_uploads: null,
-                                 remote: null)
+instance = PulpPythonClient::PatchedpythonPythonDistribution.new(
+  base_path: null,
+  content_guard: null,
+  hidden: null,
+  pulp_labels: null,
+  name: null,
+  repository: null,
+  publication: null,
+  allow_uploads: null,
+  remote: null
+)
 ```
 
-