RubyGems - pulp_ansible_client - Versions diffs - 0.23.1 → 0.24.0 - Mend

pulp_ansible_client 0.23.1 → 0.24.0

Files changed (475) hide show

data/docs/CollectionMetadataResponse.md CHANGED Viewed

@@ -2,34 +2,35 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**authors** | **Array&lt;String&gt;** |  | [optional] [readonly]
-**contents** | [**AnyType**](.md) |  | [optional] [readonly]
-**dependencies** | [**AnyType**](.md) |  | [optional] [readonly]
-**description** | **String** |  | [optional] [readonly]
-**documentation** | **String** |  | [optional] [readonly]
-**homepage** | **String** |  | [optional] [readonly]
-**issues** | **String** |  | [optional] [readonly]
-**license** | **Array&lt;String&gt;** |  | [optional] [readonly]
-**repository** | **String** |  | [optional] [readonly]
-**tags** | **Array&lt;String&gt;** |  |
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authors** | **Array&lt;String&gt;** |  | [optional][readonly] |
+| **contents** | **Object** |  | [optional][readonly] |
+| **dependencies** | **Object** |  | [optional][readonly] |
+| **description** | **String** |  | [optional][readonly] |
+| **documentation** | **String** |  | [optional][readonly] |
+| **homepage** | **String** |  | [optional][readonly] |
+| **issues** | **String** |  | [optional][readonly] |
+| **license** | **Array&lt;String&gt;** |  | [optional][readonly] |
+| **repository** | **String** |  | [optional][readonly] |
+| **tags** | **Array&lt;String&gt;** |  |  |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionMetadataResponse.new(authors: null,
-                                 contents: null,
-                                 dependencies: null,
-                                 description: null,
-                                 documentation: null,
-                                 homepage: null,
-                                 issues: null,
-                                 license: null,
-                                 repository: null,
-                                 tags: null)
+instance = PulpAnsibleClient::CollectionMetadataResponse.new(
+  authors: null,
+  contents: null,
+  dependencies: null,
+  description: null,
+  documentation: null,
+  homepage: null,
+  issues: null,
+  license: null,
+  repository: null,
+  tags: null
+)
 ```

data/docs/CollectionNamespaceResponse.md CHANGED Viewed

@@ -2,18 +2,19 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** |  |
-**metadata_sha256** | **String** |  |
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **metadata_sha256** | **String** |  |  |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionNamespaceResponse.new(name: null,
-                                 metadata_sha256: null)
+instance = PulpAnsibleClient::CollectionNamespaceResponse.new(
+  name: null,
+  metadata_sha256: null
+)
 ```

data/docs/CollectionRefResponse.md CHANGED Viewed

@@ -2,20 +2,21 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  |
-**name** | **String** |  |
-**href** | **String** | Returns link to a collection. | [optional] [readonly]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **href** | **String** | Returns link to a collection. | [optional][readonly] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionRefResponse.new(id: null,
-                                 name: null,
-                                 href: null)
+instance = PulpAnsibleClient::CollectionRefResponse.new(
+  id: null,
+  name: null,
+  href: null
+)
 ```

data/docs/CollectionResponse.md CHANGED Viewed

@@ -2,32 +2,33 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Get href. | [optional] [readonly]
-**namespace** | **String** |  | [optional] [readonly]
-**name** | **String** |  | [optional] [readonly]
-**deprecated** | **Boolean** |  |
-**versions_url** | **String** | Get a link to a collection versions list. | [optional] [readonly]
-**highest_version** | [**Object**](.md) | Get a highest version and its link. | [optional] [readonly]
-**created_at** | **DateTime** | Get the timestamp of the lowest version CollectionVersion&#39;s created timestamp. | [optional] [readonly]
-**updated_at** | **DateTime** | Get the timestamp of the latest version CollectionVersion&#39;s created timestamp. | [optional] [readonly]
-**download_count** | **String** |  | [optional] [readonly]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** | Get href. | [optional][readonly] |
+| **namespace** | **String** |  | [optional][readonly] |
+| **name** | **String** |  | [optional][readonly] |
+| **deprecated** | **Boolean** |  |  |
+| **versions_url** | **String** | Get a link to a collection versions list. | [optional][readonly] |
+| **highest_version** | **Object** | Get a highest version and its link. | [optional][readonly] |
+| **created_at** | **Time** | Get the timestamp of the lowest version CollectionVersion&#39;s created timestamp. | [optional][readonly] |
+| **updated_at** | **Time** | Get the timestamp of the latest version CollectionVersion&#39;s created timestamp. | [optional][readonly] |
+| **download_count** | **Integer** | Get the download count of the collection | [optional][readonly] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionResponse.new(href: null,
-                                 namespace: null,
-                                 name: null,
-                                 deprecated: null,
-                                 versions_url: null,
-                                 highest_version: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 download_count: null)
+instance = PulpAnsibleClient::CollectionResponse.new(
+  href: null,
+  namespace: null,
+  name: null,
+  deprecated: null,
+  versions_url: null,
+  highest_version: null,
+  created_at: null,
+  updated_at: null,
+  download_count: null
+)
 ```

data/docs/CollectionSummaryResponse.md CHANGED Viewed

@@ -2,34 +2,35 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly]
-**namespace** | **String** | The namespace of the collection. | [optional] [readonly]
-**name** | **String** | The name of the collection. | [optional] [readonly]
-**version** | **String** | The version of the collection. | [optional] [readonly]
-**requires_ansible** | **String** | The version of Ansible required to use the collection. Multiple versions can be separated with a comma. | [optional] [readonly]
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly]
-**contents** | [**Object**](.md) | A JSON field with data about the contents. | [optional] [readonly]
-**dependencies** | [**Object**](.md) | A dict declaring Collections that this collection requires to be installed for it to be usable. | [optional] [readonly]
-**description** | **String** | A short summary description of the collection. | [optional] [readonly]
-**tags** | [**Array&lt;AnsibleTagResponse&gt;**](AnsibleTagResponse.md) |  | [optional] [readonly]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **namespace** | **String** | The namespace of the collection. | [optional][readonly] |
+| **name** | **String** | The name of the collection. | [optional][readonly] |
+| **version** | **String** | The version of the collection. | [optional][readonly] |
+| **requires_ansible** | **String** | The version of Ansible required to use the collection. Multiple versions can be separated with a comma. | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **contents** | **Array&lt;Object&gt;** | A JSON field with data about the contents. | [optional][readonly] |
+| **dependencies** | **Object** | A dict declaring Collections that this collection requires to be installed for it to be usable. | [optional][readonly] |
+| **description** | **String** | A short summary description of the collection. | [optional][readonly] |
+| **tags** | [**Array&lt;AnsibleTagResponse&gt;**](AnsibleTagResponse.md) |  | [optional][readonly] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionSummaryResponse.new(pulp_href: null,
-                                 namespace: null,
-                                 name: null,
-                                 version: null,
-                                 requires_ansible: null,
-                                 pulp_created: null,
-                                 contents: null,
-                                 dependencies: null,
-                                 description: null,
-                                 tags: null)
+instance = PulpAnsibleClient::CollectionSummaryResponse.new(
+  pulp_href: null,
+  namespace: null,
+  name: null,
+  version: null,
+  requires_ansible: null,
+  pulp_created: null,
+  contents: null,
+  dependencies: null,
+  description: null,
+  tags: null
+)
 ```

data/docs/CollectionVersionCopyMove.md CHANGED Viewed

@@ -2,20 +2,21 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**collection_versions** | **Array&lt;String&gt;** | A list of collection versions to move or copy. |
-**destination_repositories** | **Array&lt;String&gt;** | List of repository HREFs to put content in. |
-**signing_service** | **String** | HREF for a signing service. This will be used to sign the collection before moving putting it in any new repositories. | [optional]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **collection_versions** | **Array&lt;String&gt;** | A list of collection versions to move or copy. |  |
+| **destination_repositories** | **Array&lt;String&gt;** | List of repository HREFs to put content in. |  |
+| **signing_service** | **String** | HREF for a signing service. This will be used to sign the collection before moving putting it in any new repositories. | [optional] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionCopyMove.new(collection_versions: null,
-                                 destination_repositories: null,
-                                 signing_service: null)
+instance = PulpAnsibleClient::CollectionVersionCopyMove.new(
+  collection_versions: null,
+  destination_repositories: null,
+  signing_service: null
+)
 ```

data/docs/CollectionVersionDocsResponse.md CHANGED Viewed

@@ -2,16 +2,17 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**docs_blob** | [**Object**](.md) |  |
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **docs_blob** | **Object** |  |  |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionDocsResponse.new(docs_blob: null)
+instance = PulpAnsibleClient::CollectionVersionDocsResponse.new(
+  docs_blob: null
+)
 ```

data/docs/CollectionVersionListResponse.md CHANGED Viewed

@@ -2,26 +2,27 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** |  |
-**href** | **String** | Get href. | [optional] [readonly]
-**created_at** | **DateTime** |  |
-**updated_at** | **DateTime** |  |
-**requires_ansible** | **String** |  | [optional]
-**marks** | **Array&lt;String&gt;** | Get a list of mark values filtering only those in the current repo. | [optional] [readonly]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** |  |  |
+| **href** | **String** | Get href. | [optional][readonly] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **requires_ansible** | **String** |  | [optional] |
+| **marks** | **Array&lt;String&gt;** | Get a list of mark values filtering only those in the current repo. | [optional][readonly] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionListResponse.new(version: null,
-                                 href: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 requires_ansible: null,
-                                 marks: null)
+instance = PulpAnsibleClient::CollectionVersionListResponse.new(
+  version: null,
+  href: null,
+  created_at: null,
+  updated_at: null,
+  requires_ansible: null,
+  marks: null
+)
 ```

data/docs/CollectionVersionResponse.md CHANGED Viewed

@@ -2,48 +2,49 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**version** | **String** |  |
-**href** | **String** | Get href. | [optional] [readonly]
-**created_at** | **DateTime** |  |
-**updated_at** | **DateTime** |  |
-**requires_ansible** | **String** |  | [optional]
-**marks** | **Array&lt;String&gt;** | Get a list of mark values filtering only those in the current repo. | [optional] [readonly]
-**artifact** | [**ArtifactRefResponse**](ArtifactRefResponse.md) |  | [optional] [readonly]
-**collection** | [**CollectionRefResponse**](CollectionRefResponse.md) |  | [optional] [readonly]
-**download_url** | **String** | Get artifact download URL. | [optional] [readonly]
-**name** | **String** |  | [optional] [readonly]
-**namespace** | [**CollectionNamespaceResponse**](CollectionNamespaceResponse.md) |  | [optional] [readonly]
-**signatures** | [**Array&lt;CollectionVersionSignatureResponse&gt;**](CollectionVersionSignatureResponse.md) |  |
-**metadata** | [**CollectionMetadataResponse**](CollectionMetadataResponse.md) |  | [optional] [readonly]
-**git_url** | **String** | Get the git URL. | [optional] [readonly]
-**git_commit_sha** | **String** | Get the git commit sha. | [optional] [readonly]
-**manifest** | [**Object**](.md) | A JSON field holding MANIFEST.json data. | [optional] [readonly]
-**files** | [**Object**](.md) | A JSON field holding FILES.json data. | [optional] [readonly]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** |  |  |
+| **href** | **String** | Get href. | [optional][readonly] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **requires_ansible** | **String** |  | [optional] |
+| **marks** | **Array&lt;String&gt;** | Get a list of mark values filtering only those in the current repo. | [optional][readonly] |
+| **artifact** | [**ArtifactRefResponse**](ArtifactRefResponse.md) |  | [optional][readonly] |
+| **collection** | [**CollectionRefResponse**](CollectionRefResponse.md) |  | [optional][readonly] |
+| **download_url** | **String** | Get artifact download URL. | [optional][readonly] |
+| **name** | **String** |  | [optional][readonly] |
+| **namespace** | [**CollectionNamespaceResponse**](CollectionNamespaceResponse.md) |  | [optional][readonly] |
+| **signatures** | [**Array&lt;CollectionVersionSignatureResponse&gt;**](CollectionVersionSignatureResponse.md) |  |  |
+| **metadata** | [**CollectionMetadataResponse**](CollectionMetadataResponse.md) |  | [optional][readonly] |
+| **git_url** | **String** | Get the git URL. | [optional][readonly] |
+| **git_commit_sha** | **String** | Get the git commit sha. | [optional][readonly] |
+| **manifest** | **Object** | A JSON field holding MANIFEST.json data. | [optional][readonly] |
+| **files** | **Object** | A JSON field holding FILES.json data. | [optional][readonly] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionResponse.new(version: null,
-                                 href: null,
-                                 created_at: null,
-                                 updated_at: null,
-                                 requires_ansible: null,
-                                 marks: null,
-                                 artifact: null,
-                                 collection: null,
-                                 download_url: null,
-                                 name: null,
-                                 namespace: null,
-                                 signatures: null,
-                                 metadata: null,
-                                 git_url: null,
-                                 git_commit_sha: null,
-                                 manifest: null,
-                                 files: null)
+instance = PulpAnsibleClient::CollectionVersionResponse.new(
+  version: null,
+  href: null,
+  created_at: null,
+  updated_at: null,
+  requires_ansible: null,
+  marks: null,
+  artifact: null,
+  collection: null,
+  download_url: null,
+  name: null,
+  namespace: null,
+  signatures: null,
+  metadata: null,
+  git_url: null,
+  git_commit_sha: null,
+  manifest: null,
+  files: null
+)
 ```

data/docs/CollectionVersionSearchList.md CHANGED Viewed

@@ -2,24 +2,25 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**repository** | [**Repository**](Repository.md) |  |
-**namespace_metadata** | [**AnsibleAnsibleNamespaceMetadata**](AnsibleAnsibleNamespaceMetadata.md) |  |
-**is_highest** | **Boolean** |  |
-**is_deprecated** | **Boolean** |  |
-**is_signed** | **Boolean** |  |
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repository** | [**Repository**](Repository.md) |  |  |
+| **namespace_metadata** | [**AnsibleAnsibleNamespaceMetadata**](AnsibleAnsibleNamespaceMetadata.md) |  |  |
+| **is_highest** | **Boolean** |  |  |
+| **is_deprecated** | **Boolean** |  |  |
+| **is_signed** | **Boolean** |  |  |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionSearchList.new(repository: null,
-                                 namespace_metadata: null,
-                                 is_highest: null,
-                                 is_deprecated: null,
-                                 is_signed: null)
+instance = PulpAnsibleClient::CollectionVersionSearchList.new(
+  repository: null,
+  namespace_metadata: null,
+  is_highest: null,
+  is_deprecated: null,
+  is_signed: null
+)
 ```

data/docs/CollectionVersionSearchListResponse.md CHANGED Viewed

@@ -2,28 +2,29 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**repository** | [**RepositoryResponse**](RepositoryResponse.md) |  |
-**collection_version** | [**CollectionSummaryResponse**](CollectionSummaryResponse.md) |  |
-**repository_version** | **String** |  | [optional] [readonly]
-**namespace_metadata** | [**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md) |  |
-**is_highest** | **Boolean** |  |
-**is_deprecated** | **Boolean** |  |
-**is_signed** | **Boolean** |  |
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repository** | [**RepositoryResponse**](RepositoryResponse.md) |  |  |
+| **collection_version** | [**CollectionSummaryResponse**](CollectionSummaryResponse.md) |  |  |
+| **repository_version** | **String** |  | [optional][readonly] |
+| **namespace_metadata** | [**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md) |  |  |
+| **is_highest** | **Boolean** |  |  |
+| **is_deprecated** | **Boolean** |  |  |
+| **is_signed** | **Boolean** |  |  |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionSearchListResponse.new(repository: null,
-                                 collection_version: null,
-                                 repository_version: null,
-                                 namespace_metadata: null,
-                                 is_highest: null,
-                                 is_deprecated: null,
-                                 is_signed: null)
+instance = PulpAnsibleClient::CollectionVersionSearchListResponse.new(
+  repository: null,
+  collection_version: null,
+  repository_version: null,
+  namespace_metadata: null,
+  is_highest: null,
+  is_deprecated: null,
+  is_signed: null
+)
 ```

data/docs/CollectionVersionSignatureResponse.md CHANGED Viewed

@@ -2,22 +2,23 @@
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**signature** | **String** |  | [optional] [readonly]
-**pubkey_fingerprint** | **String** |  |
-**signing_service** | **String** |  | [optional] [readonly]
-**pulp_created** | **DateTime** |  | [optional] [readonly]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **signature** | **String** |  | [optional][readonly] |
+| **pubkey_fingerprint** | **String** |  |  |
+| **signing_service** | **String** |  | [optional][readonly] |
+| **pulp_created** | **Time** |  | [optional][readonly] |
-## Code Sample
+## Example
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
-instance = PulpAnsibleClient::CollectionVersionSignatureResponse.new(signature: null,
-                                 pubkey_fingerprint: null,
-                                 signing_service: null,
-                                 pulp_created: null)
+instance = PulpAnsibleClient::CollectionVersionSignatureResponse.new(
+  signature: null,
+  pubkey_fingerprint: null,
+  signing_service: null,
+  pulp_created: null
+)
 ```