pulp_ostree_client 2.4.5 → 2.4.6

data/docs/PaginatedostreeOstreeObjectResponseList.md

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

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

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

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

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **Integer** |  | 
-**_next** | **String** |  | [optional] 
-**previous** | **String** |  | [optional] 
-**results** | [**Array<OstreeOstreeSummaryResponse>**](OstreeOstreeSummaryResponse.md) |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** |  |  |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<OstreeOstreeSummaryResponse>**](OstreeOstreeSummaryResponse.md) |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpOstreeClient'
+require 'pulp_ostree_client'
 
-instance = PulpOstreeClient::PaginatedostreeOstreeSummaryResponseList.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 = PulpOstreeClient::PaginatedostreeOstreeSummaryResponseList.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/PatchedostreeOstreeDistribution.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] 
-**repository_version** | **String** | RepositoryVersion 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] |
+| **repository_version** | **String** | RepositoryVersion to be served | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpOstreeClient'
+require 'pulp_ostree_client'
 
-instance = PulpOstreeClient::PatchedostreeOstreeDistribution.new(base_path: null,
-                                 content_guard: null,
-                                 hidden: null,
-                                 pulp_labels: null,
-                                 name: null,
-                                 repository: null,
-                                 repository_version: null)
+instance = PulpOstreeClient::PatchedostreeOstreeDistribution.new(
+  base_path: null,
+  content_guard: null,
+  hidden: null,
+  pulp_labels: null,
+  name: null,
+  repository: null,
+  repository_version: null
+)
 ```
 
-

data/docs/PatchedostreeOstreeRemote.md

@@ -2,62 +2,63 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A unique name for this remote. | [optional] 
-**url** | **String** | The URL of an external content source. | [optional] 
-**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
-**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
-**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
-**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
-**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
-**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**username** | **String** | The username to be used for authentication when syncing. | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
-**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
-**policy** | [**PolicyEnum**](PolicyEnum.md) |          immediate - All OSTree objects are downloaded and saved during synchronization.         on_demand - Only commits, dirtrees, and refs are downloaded. Other OSTree objects are                     not downloaded until they are requested for the first time by a client.           * `immediate` - immediate * `on_demand` - on_demand | [optional] 
-**total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
-**depth** | **Integer** | An option to specify how many commits to traverse. | [optional] [default to 0]
-**include_refs** | **Array<String>** |              A list of refs to include during a sync.             The wildcards *, ? are recognized.             'include_refs' is evaluated before 'exclude_refs'.              | [optional] 
-**exclude_refs** | **Array<String>** |              A list of tags to exclude during a sync.             The wildcards *, ? are recognized.             'exclude_refs' is evaluated after 'include_refs'.              | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A unique name for this remote. | [optional] |
+| **url** | **String** | The URL of an external content source. | [optional] |
+| **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
+| **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
+| **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
+| **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
+| **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
+| **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
+| **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **username** | **String** | The username to be used for authentication when syncing. | [optional] |
+| **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
+| **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
+| **policy** | [**PolicyEnum**](PolicyEnum.md) |          immediate - All OSTree objects are downloaded and saved during synchronization.         on_demand - Only commits, dirtrees, and refs are downloaded. Other OSTree objects are                     not downloaded until they are requested for the first time by a client.           * `immediate` - immediate * `on_demand` - on_demand | [optional] |
+| **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
+| **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
+| **depth** | **Integer** | An option to specify how many commits to traverse. | [optional][default to 0] |
+| **include_refs** | **Array<String>** |              A list of refs to include during a sync.             The wildcards *, ? are recognized.             'include_refs' is evaluated before 'exclude_refs'.              | [optional] |
+| **exclude_refs** | **Array<String>** |              A list of tags to exclude during a sync.             The wildcards *, ? are recognized.             'exclude_refs' is evaluated after 'include_refs'.              | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpOstreeClient'
+require 'pulp_ostree_client'
 
-instance = PulpOstreeClient::PatchedostreeOstreeRemote.new(name: null,
-                                 url: null,
-                                 ca_cert: null,
-                                 client_cert: null,
-                                 client_key: null,
-                                 tls_validation: null,
-                                 proxy_url: null,
-                                 proxy_username: null,
-                                 proxy_password: null,
-                                 username: null,
-                                 password: null,
-                                 pulp_labels: null,
-                                 download_concurrency: null,
-                                 max_retries: null,
-                                 policy: null,
-                                 total_timeout: null,
-                                 connect_timeout: null,
-                                 sock_connect_timeout: null,
-                                 sock_read_timeout: null,
-                                 headers: null,
-                                 rate_limit: null,
-                                 depth: null,
-                                 include_refs: null,
-                                 exclude_refs: null)
+instance = PulpOstreeClient::PatchedostreeOstreeRemote.new(
+  name: null,
+  url: null,
+  ca_cert: null,
+  client_cert: null,
+  client_key: null,
+  tls_validation: null,
+  proxy_url: null,
+  proxy_username: null,
+  proxy_password: null,
+  username: null,
+  password: null,
+  pulp_labels: null,
+  download_concurrency: null,
+  max_retries: null,
+  policy: null,
+  total_timeout: null,
+  connect_timeout: null,
+  sock_connect_timeout: null,
+  sock_read_timeout: null,
+  headers: null,
+  rate_limit: null,
+  depth: null,
+  include_refs: null,
+  exclude_refs: null
+)
 ```
 
-

data/docs/PatchedostreeOstreeRepository.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**name** | **String** | A unique name for this repository. | [optional] 
-**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] 
-**compute_delta** | **Boolean** |  | [optional] [default to true]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name for this repository. | [optional] |
+| **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] |
+| **compute_delta** | **Boolean** |  | [optional][default to true] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpOstreeClient'
+require 'pulp_ostree_client'
 
-instance = PulpOstreeClient::PatchedostreeOstreeRepository.new(pulp_labels: null,
-                                 name: null,
-                                 description: null,
-                                 retain_repo_versions: null,
-                                 remote: null,
-                                 compute_delta: null)
+instance = PulpOstreeClient::PatchedostreeOstreeRepository.new(
+  pulp_labels: null,
+  name: null,
+  description: null,
+  retain_repo_versions: null,
+  remote: null,
+  compute_delta: null
+)
 ```
 
-

data/docs/PolicyEnum.md

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