pulp_file_client 3.69.1 → 3.70.0

data/docs/FileFileRepository.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**name** | **String** | A unique name for this repository. | 
-**description** | **String** | An optional description. | [optional] 
-**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] 
-**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
-**autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional] [default to false]
-**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name for this repository. |  |
+| **description** | **String** | An optional description. | [optional] |
+| **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] |
+| **remote** | **String** | An optional remote to use by default when syncing. | [optional] |
+| **autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional][default to false] |
+| **manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional][default to 'PULP_MANIFEST'] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::FileFileRepository.new(pulp_labels: null,
-                                 name: null,
-                                 description: null,
-                                 retain_repo_versions: null,
-                                 remote: null,
-                                 autopublish: null,
-                                 manifest: null)
+instance = PulpFileClient::FileFileRepository.new(
+  pulp_labels: null,
+  name: null,
+  description: null,
+  retain_repo_versions: null,
+  remote: null,
+  autopublish: null,
+  manifest: null
+)
 ```
 
-

data/docs/FileFileRepositoryResponse.md

@@ -2,40 +2,41 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**versions_href** | **String** |  | [optional] [readonly] 
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**latest_version_href** | **String** |  | [optional] [readonly] 
-**name** | **String** | A unique name for this repository. | 
-**description** | **String** | An optional description. | [optional] 
-**retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] 
-**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
-**autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional] [default to false]
-**manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional] [default to 'PULP_MANIFEST']
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional][readonly] |
+| **versions_href** | **String** |  | [optional][readonly] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **latest_version_href** | **String** |  | [optional][readonly] |
+| **name** | **String** | A unique name for this repository. |  |
+| **description** | **String** | An optional description. | [optional] |
+| **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] |
+| **remote** | **String** | An optional remote to use by default when syncing. | [optional] |
+| **autopublish** | **Boolean** | Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository. | [optional][default to false] |
+| **manifest** | **String** | Filename to use for manifest file containing metadata for all the files. | [optional][default to 'PULP_MANIFEST'] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::FileFileRepositoryResponse.new(pulp_href: null,
-                                 prn: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 versions_href: null,
-                                 pulp_labels: null,
-                                 latest_version_href: null,
-                                 name: null,
-                                 description: null,
-                                 retain_repo_versions: null,
-                                 remote: null,
-                                 autopublish: null,
-                                 manifest: null)
+instance = PulpFileClient::FileFileRepositoryResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  versions_href: null,
+  pulp_labels: null,
+  latest_version_href: null,
+  name: null,
+  description: null,
+  retain_repo_versions: null,
+  remote: null,
+  autopublish: null,
+  manifest: null
+)
 ```
 
-

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 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::MyPermissionsResponse.new(permissions: null)
+instance = PulpFileClient::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 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::NestedRole.new(users: null,
-                                 groups: null,
-                                 role: null)
+instance = PulpFileClient::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 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::NestedRoleResponse.new(users: null,
-                                 groups: null,
-                                 role: null)
+instance = PulpFileClient::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 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::ObjectRolesResponse.new(roles: null)
+instance = PulpFileClient::ObjectRolesResponse.new(
+  roles: 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 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::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 = PulpFileClient::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/PaginatedfileFileAlternateContentSourceResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileAlternateContentSourceResponse>**](FileFileAlternateContentSourceResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<FileFileAlternateContentSourceResponse>**](FileFileAlternateContentSourceResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList.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 = PulpFileClient::PaginatedfileFileAlternateContentSourceResponseList.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/PaginatedfileFileContentResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileContentResponse>**](FileFileContentResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<FileFileContentResponse>**](FileFileContentResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PaginatedfileFileContentResponseList.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 = PulpFileClient::PaginatedfileFileContentResponseList.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/PaginatedfileFileDistributionResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileDistributionResponse>**](FileFileDistributionResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<FileFileDistributionResponse>**](FileFileDistributionResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PaginatedfileFileDistributionResponseList.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 = PulpFileClient::PaginatedfileFileDistributionResponseList.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/PaginatedfileFilePublicationResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<FileFilePublicationResponse>**](FileFilePublicationResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<FileFilePublicationResponse>**](FileFilePublicationResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PaginatedfileFilePublicationResponseList.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 = PulpFileClient::PaginatedfileFilePublicationResponseList.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/PaginatedfileFileRemoteResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileRemoteResponse>**](FileFileRemoteResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<FileFileRemoteResponse>**](FileFileRemoteResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PaginatedfileFileRemoteResponseList.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 = PulpFileClient::PaginatedfileFileRemoteResponseList.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/PaginatedfileFileRepositoryResponseList.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<FileFileRepositoryResponse>**](FileFileRepositoryResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<FileFileRepositoryResponse>**](FileFileRepositoryResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PaginatedfileFileRepositoryResponseList.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 = PulpFileClient::PaginatedfileFileRepositoryResponseList.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/PatchedfileFileAlternateContentSource.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of Alternate Content Source. | [optional] 
-**last_refreshed** | **DateTime** | Date of last refresh of AlternateContentSource. | [optional] 
-**paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] 
-**remote** | **String** | The remote to provide alternate content source. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of Alternate Content Source. | [optional] |
+| **last_refreshed** | **Time** | Date of last refresh of AlternateContentSource. | [optional] |
+| **paths** | **Array<String>** | List of paths that will be appended to the Remote url when searching for content. | [optional] |
+| **remote** | **String** | The remote to provide alternate content source. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PatchedfileFileAlternateContentSource.new(name: null,
-                                 last_refreshed: null,
-                                 paths: null,
-                                 remote: null)
+instance = PulpFileClient::PatchedfileFileAlternateContentSource.new(
+  name: null,
+  last_refreshed: null,
+  paths: null,
+  remote: null
+)
 ```
 
-

data/docs/PatchedfileFileDistribution.md

@@ -2,28 +2,29 @@
 
 ## 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] 
+| 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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::PatchedfileFileDistribution.new(base_path: null,
-                                 content_guard: null,
-                                 hidden: null,
-                                 pulp_labels: null,
-                                 name: null,
-                                 repository: null,
-                                 publication: null)
+instance = PulpFileClient::PatchedfileFileDistribution.new(
+  base_path: null,
+  content_guard: null,
+  hidden: null,
+  pulp_labels: null,
+  name: null,
+  repository: null,
+  publication: null
+)
 ```
 
-