pulp_ansible_client 0.16.2 → 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +88 -22
- data/docs/AnsibleAnsibleNamespaceMetadata.md +29 -0
- data/docs/AnsibleAnsibleNamespaceMetadataResponse.md +35 -0
- data/docs/AnsibleAnsibleRepository.md +3 -1
- data/docs/AnsibleAnsibleRepositoryResponse.md +5 -1
- data/docs/AnsibleCollectionRemote.md +1 -1
- data/docs/AnsibleCollectionRemoteResponse.md +4 -2
- data/docs/AnsibleCollectionVersion.md +5 -5
- data/docs/AnsibleCollectionVersionMark.md +19 -0
- data/docs/AnsibleCollectionVersionMarkResponse.md +23 -0
- data/docs/AnsibleCollectionVersionResponse.md +3 -3
- data/docs/AnsibleCollectionsApi.md +230 -6
- data/docs/AnsibleGitRemote.md +26 -26
- data/docs/AnsibleGitRemoteResponse.md +26 -26
- data/docs/AnsibleRepositoryMark.md +19 -0
- data/docs/AnsibleRoleRemote.md +1 -1
- data/docs/AnsibleRoleRemoteResponse.md +1 -1
- data/docs/AnsibleRoleResponse.md +3 -3
- data/docs/CollectionNamespaceResponse.md +3 -1
- data/docs/CollectionRefResponse.md +1 -1
- data/docs/CollectionResponse.md +6 -6
- data/docs/CollectionSummaryResponse.md +35 -0
- data/docs/CollectionVersionCopyMove.md +21 -0
- data/docs/CollectionVersionListResponse.md +4 -2
- data/docs/CollectionVersionResponse.md +6 -4
- data/docs/CollectionVersionSearchList.md +27 -0
- data/docs/CollectionVersionSearchListResponse.md +29 -0
- data/docs/ContentCollectionDeprecationsApi.md +2 -6
- data/docs/ContentCollectionMarksApi.md +198 -0
- data/docs/ContentCollectionSignaturesApi.md +2 -6
- data/docs/ContentCollectionVersionsApi.md +6 -10
- data/docs/ContentNamespacesApi.md +220 -0
- data/docs/ContentRolesApi.md +2 -6
- data/docs/DistributionsAnsibleApi.md +230 -6
- data/docs/GalaxyCollectionResponse.md +4 -4
- data/docs/GalaxyCollectionVersionResponse.md +4 -4
- data/docs/GalaxyRoleResponse.md +1 -1
- data/docs/GalaxyRoleVersionResponse.md +1 -1
- data/docs/MyPermissionsResponse.md +17 -0
- data/docs/NamespaceLink.md +19 -0
- data/docs/NamespaceLinkResponse.md +19 -0
- data/docs/NestedRole.md +21 -0
- data/docs/NestedRoleResponse.md +21 -0
- data/docs/ObjectRolesResponse.md +17 -0
- data/docs/PaginatedCollectionVersionSearchListResponseList.md +21 -0
- data/docs/PaginatedansibleAnsibleNamespaceMetadataResponseList.md +23 -0
- data/docs/PaginatedansibleCollectionVersionMarkResponseList.md +23 -0
- data/docs/PatchedansibleAnsibleNamespaceMetadata.md +29 -0
- data/docs/PatchedansibleAnsibleRepository.md +3 -1
- data/docs/PatchedansibleCollectionRemote.md +1 -1
- data/docs/PatchedansibleGitRemote.md +26 -26
- data/docs/PatchedansibleRoleRemote.md +1 -1
- data/docs/ProgressReportResponse.md +27 -0
- data/docs/PulpAnsibleApiV3CollectionsAllApi.md +2 -6
- data/docs/PulpAnsibleApiV3CollectionsApi.md +2 -6
- data/docs/PulpAnsibleApiV3CollectionsVersionsApi.md +2 -6
- data/docs/PulpAnsibleApiV3NamespacesApi.md +158 -0
- data/docs/PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md +6 -6
- data/docs/PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi.md +2 -6
- data/docs/PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexApi.md +2 -6
- data/docs/PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md +2 -6
- data/docs/PulpAnsibleApiV3PluginAnsibleContentNamespacesApi.md +363 -0
- data/docs/PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi.md +168 -0
- data/docs/PulpAnsibleDefaultApiV3CollectionsAllApi.md +2 -6
- data/docs/PulpAnsibleDefaultApiV3CollectionsApi.md +2 -6
- data/docs/PulpAnsibleDefaultApiV3CollectionsVersionsApi.md +2 -6
- data/docs/PulpAnsibleDefaultApiV3NamespacesApi.md +154 -0
- data/docs/PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.md +6 -6
- data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllCollectionsApi.md +2 -6
- data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md +2 -6
- data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md +2 -6
- data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md +353 -0
- data/docs/PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md +164 -0
- data/docs/RemotesCollectionApi.md +238 -6
- data/docs/RemotesGitApi.md +230 -6
- data/docs/RemotesRoleApi.md +230 -6
- data/docs/RepositoriesAnsibleApi.md +450 -6
- data/docs/RepositoriesAnsibleVersionsApi.md +2 -4
- data/docs/Repository.md +25 -0
- data/docs/RepositoryResponse.md +33 -0
- data/docs/Task.md +19 -0
- data/docs/TaskResponse.md +45 -0
- data/docs/UnpaginatedCollectionVersionResponse.md +6 -4
- data/docs/VersionsApi.md +10 -10
- data/lib/pulp_ansible_client/api/ansible_collections_api.rb +270 -8
- data/lib/pulp_ansible_client/api/content_collection_deprecations_api.rb +2 -8
- data/lib/pulp_ansible_client/api/content_collection_marks_api.rb +247 -0
- data/lib/pulp_ansible_client/api/content_collection_signatures_api.rb +2 -8
- data/lib/pulp_ansible_client/api/content_collection_versions_api.rb +8 -14
- data/lib/pulp_ansible_client/api/content_namespaces_api.rb +276 -0
- data/lib/pulp_ansible_client/api/content_roles_api.rb +2 -8
- data/lib/pulp_ansible_client/api/distributions_ansible_api.rb +270 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_all_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_versions_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_namespaces_api.rb +209 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_client_configuration_api.rb +8 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_all_collections_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_content_namespaces_api.rb +531 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_api_v3_plugin_ansible_search_collection_versions_api.rb +229 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_all_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_namespaces_api.rb +197 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_plugin_ansible_client_configuration_api.rb +7 -7
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_plugin_ansible_content_collections_all_collections_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_plugin_ansible_content_collections_index_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_plugin_ansible_content_collections_index_versions_api.rb +2 -8
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_plugin_ansible_content_namespaces_api.rb +501 -0
- data/lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_plugin_ansible_search_collection_versions_api.rb +217 -0
- data/lib/pulp_ansible_client/api/remotes_collection_api.rb +283 -9
- data/lib/pulp_ansible_client/api/remotes_git_api.rb +270 -8
- data/lib/pulp_ansible_client/api/remotes_role_api.rb +270 -8
- data/lib/pulp_ansible_client/api/repositories_ansible_api.rb +542 -8
- data/lib/pulp_ansible_client/api/repositories_ansible_versions_api.rb +2 -5
- data/lib/pulp_ansible_client/api/versions_api.rb +12 -12
- data/lib/pulp_ansible_client/models/ansible_ansible_namespace_metadata.rb +359 -0
- data/lib/pulp_ansible_client/models/ansible_ansible_namespace_metadata_response.rb +402 -0
- data/lib/pulp_ansible_client/models/ansible_ansible_repository.rb +14 -5
- data/lib/pulp_ansible_client/models/ansible_ansible_repository_response.rb +23 -5
- data/lib/pulp_ansible_client/models/ansible_collection_remote.rb +1 -1
- data/lib/pulp_ansible_client/models/ansible_collection_remote_response.rb +14 -5
- data/lib/pulp_ansible_client/models/ansible_collection_version.rb +18 -18
- data/lib/pulp_ansible_client/models/ansible_collection_version_mark.rb +258 -0
- data/lib/pulp_ansible_client/models/ansible_collection_version_mark_response.rb +268 -0
- data/lib/pulp_ansible_client/models/ansible_collection_version_response.rb +10 -10
- data/lib/pulp_ansible_client/models/ansible_git_remote.rb +249 -249
- data/lib/pulp_ansible_client/models/ansible_git_remote_response.rb +144 -144
- data/lib/pulp_ansible_client/models/ansible_repository_mark.rb +260 -0
- data/lib/pulp_ansible_client/models/ansible_role_remote.rb +1 -1
- data/lib/pulp_ansible_client/models/ansible_role_remote_response.rb +1 -1
- data/lib/pulp_ansible_client/models/ansible_role_response.rb +11 -11
- data/lib/pulp_ansible_client/models/collection_namespace_response.rb +13 -4
- data/lib/pulp_ansible_client/models/collection_ref_response.rb +0 -1
- data/lib/pulp_ansible_client/models/collection_response.rb +0 -6
- data/lib/pulp_ansible_client/models/collection_summary_response.rb +359 -0
- data/lib/pulp_ansible_client/models/collection_version_copy_move.rb +242 -0
- data/lib/pulp_ansible_client/models/collection_version_list_response.rb +16 -6
- data/lib/pulp_ansible_client/models/collection_version_response.rb +12 -5
- data/lib/pulp_ansible_client/models/collection_version_search_list.rb +279 -0
- data/lib/pulp_ansible_client/models/collection_version_search_list_response.rb +287 -0
- data/lib/pulp_ansible_client/models/galaxy_collection_response.rb +0 -4
- data/lib/pulp_ansible_client/models/galaxy_collection_version_response.rb +0 -4
- data/lib/pulp_ansible_client/models/galaxy_role_response.rb +0 -1
- data/lib/pulp_ansible_client/models/galaxy_role_version_response.rb +0 -1
- data/lib/pulp_ansible_client/models/my_permissions_response.rb +213 -0
- data/lib/pulp_ansible_client/models/namespace_link.rb +282 -0
- data/lib/pulp_ansible_client/models/namespace_link_response.rb +264 -0
- data/lib/pulp_ansible_client/models/nested_role.rb +253 -0
- data/lib/pulp_ansible_client/models/nested_role_response.rb +234 -0
- data/lib/pulp_ansible_client/models/object_roles_response.rb +213 -0
- data/lib/pulp_ansible_client/models/paginated_collection_version_search_list_response_list.rb +226 -0
- data/lib/pulp_ansible_client/models/paginatedansible_ansible_namespace_metadata_response_list.rb +237 -0
- data/lib/pulp_ansible_client/models/paginatedansible_collection_version_mark_response_list.rb +237 -0
- data/lib/pulp_ansible_client/models/patchedansible_ansible_namespace_metadata.rb +350 -0
- data/lib/pulp_ansible_client/models/patchedansible_ansible_repository.rb +14 -5
- data/lib/pulp_ansible_client/models/patchedansible_collection_remote.rb +1 -1
- data/lib/pulp_ansible_client/models/patchedansible_git_remote.rb +244 -244
- data/lib/pulp_ansible_client/models/patchedansible_role_remote.rb +1 -1
- data/lib/pulp_ansible_client/models/progress_report_response.rb +259 -0
- data/lib/pulp_ansible_client/models/repository.rb +306 -0
- data/lib/pulp_ansible_client/models/repository_response.rb +309 -0
- data/lib/pulp_ansible_client/models/task.rb +266 -0
- data/lib/pulp_ansible_client/models/task_response.rb +366 -0
- data/lib/pulp_ansible_client/models/unpaginated_collection_version_response.rb +12 -5
- data/lib/pulp_ansible_client/version.rb +1 -1
- data/lib/pulp_ansible_client.rb +32 -0
- data/spec/api/ansible_collections_api_spec.rb +51 -3
- data/spec/api/content_collection_deprecations_api_spec.rb +1 -3
- data/spec/api/content_collection_marks_api_spec.rb +83 -0
- data/spec/api/content_collection_signatures_api_spec.rb +1 -3
- data/spec/api/content_collection_versions_api_spec.rb +3 -5
- data/spec/api/content_namespaces_api_spec.rb +93 -0
- data/spec/api/content_roles_api_spec.rb +1 -3
- data/spec/api/distributions_ansible_api_spec.rb +51 -3
- data/spec/api/pulp_ansible_api_v3_collections_all_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_api_v3_collections_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_api_v3_collections_versions_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_api_v3_namespaces_api_spec.rb +77 -0
- data/spec/api/pulp_ansible_api_v3_plugin_ansible_client_configuration_api_spec.rb +3 -3
- data/spec/api/pulp_ansible_api_v3_plugin_ansible_content_collections_all_collections_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_api_v3_plugin_ansible_content_collections_index_versions_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_api_v3_plugin_ansible_content_namespaces_api_spec.rb +131 -0
- data/spec/api/pulp_ansible_api_v3_plugin_ansible_search_collection_versions_api_spec.rb +83 -0
- data/spec/api/pulp_ansible_default_api_v3_collections_all_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_default_api_v3_collections_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_default_api_v3_collections_versions_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_default_api_v3_namespaces_api_spec.rb +75 -0
- data/spec/api/pulp_ansible_default_api_v3_plugin_ansible_client_configuration_api_spec.rb +3 -3
- data/spec/api/pulp_ansible_default_api_v3_plugin_ansible_content_collections_all_collections_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_default_api_v3_plugin_ansible_content_collections_index_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_default_api_v3_plugin_ansible_content_collections_index_versions_api_spec.rb +1 -3
- data/spec/api/pulp_ansible_default_api_v3_plugin_ansible_content_namespaces_api_spec.rb +126 -0
- data/spec/api/pulp_ansible_default_api_v3_plugin_ansible_search_collection_versions_api_spec.rb +81 -0
- data/spec/api/remotes_collection_api_spec.rb +55 -3
- data/spec/api/remotes_git_api_spec.rb +51 -3
- data/spec/api/remotes_role_api_spec.rb +51 -3
- data/spec/api/repositories_ansible_api_spec.rb +99 -3
- data/spec/api/repositories_ansible_versions_api_spec.rb +1 -2
- data/spec/api/versions_api_spec.rb +4 -4
- data/spec/models/ansible_ansible_namespace_metadata_response_spec.rb +95 -0
- data/spec/models/ansible_ansible_namespace_metadata_spec.rb +77 -0
- data/spec/models/ansible_ansible_repository_response_spec.rb +12 -0
- data/spec/models/ansible_ansible_repository_spec.rb +6 -0
- data/spec/models/ansible_collection_remote_response_spec.rb +6 -0
- data/spec/models/ansible_collection_version_mark_response_spec.rb +59 -0
- data/spec/models/ansible_collection_version_mark_spec.rb +47 -0
- data/spec/models/ansible_collection_version_response_spec.rb +2 -2
- data/spec/models/ansible_collection_version_spec.rb +3 -3
- data/spec/models/ansible_git_remote_response_spec.rb +18 -18
- data/spec/models/ansible_git_remote_spec.rb +20 -20
- data/spec/models/ansible_repository_mark_spec.rb +47 -0
- data/spec/models/ansible_role_response_spec.rb +3 -3
- data/spec/models/collection_namespace_response_spec.rb +6 -0
- data/spec/models/collection_summary_response_spec.rb +95 -0
- data/spec/models/collection_version_copy_move_spec.rb +53 -0
- data/spec/models/collection_version_list_response_spec.rb +6 -0
- data/spec/models/collection_version_response_spec.rb +6 -0
- data/spec/models/collection_version_search_list_response_spec.rb +77 -0
- data/spec/models/collection_version_search_list_spec.rb +71 -0
- data/spec/models/my_permissions_response_spec.rb +41 -0
- data/spec/models/namespace_link_response_spec.rb +47 -0
- data/spec/models/namespace_link_spec.rb +47 -0
- data/spec/models/nested_role_response_spec.rb +53 -0
- data/spec/models/nested_role_spec.rb +53 -0
- data/spec/models/object_roles_response_spec.rb +41 -0
- data/spec/models/paginated_collection_version_search_list_response_list_spec.rb +53 -0
- data/spec/models/paginatedansible_ansible_namespace_metadata_response_list_spec.rb +59 -0
- data/spec/models/paginatedansible_collection_version_mark_response_list_spec.rb +59 -0
- data/spec/models/patchedansible_ansible_namespace_metadata_spec.rb +77 -0
- data/spec/models/patchedansible_ansible_repository_spec.rb +6 -0
- data/spec/models/patchedansible_git_remote_spec.rb +20 -20
- data/spec/models/progress_report_response_spec.rb +71 -0
- data/spec/models/repository_response_spec.rb +89 -0
- data/spec/models/repository_spec.rb +65 -0
- data/spec/models/task_response_spec.rb +125 -0
- data/spec/models/task_spec.rb +47 -0
- data/spec/models/unpaginated_collection_version_response_spec.rb +6 -0
- metadata +231 -103
@@ -0,0 +1,154 @@
|
|
1
|
+
# PulpAnsibleClient::PulpAnsibleDefaultApiV3NamespacesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list**](PulpAnsibleDefaultApiV3NamespacesApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/namespaces/ |
|
8
|
+
[**read**](PulpAnsibleDefaultApiV3NamespacesApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/namespaces/{name}/ |
|
9
|
+
|
10
|
+
|
11
|
+
|
12
|
+
## list
|
13
|
+
|
14
|
+
> PaginatedansibleAnsibleNamespaceMetadataResponseList list(opts)
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
Legacy v3 endpoint.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'pulp_ansible_client'
|
25
|
+
# setup authorization
|
26
|
+
PulpAnsibleClient.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: basicAuth
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3NamespacesApi.new
|
33
|
+
opts = {
|
34
|
+
company: 'company_example', # String | Filter results where company matches value
|
35
|
+
company__contains: 'company__contains_example', # String | Filter results where company contains value
|
36
|
+
company__icontains: 'company__icontains_example', # String | Filter results where company contains value
|
37
|
+
company__in: ['company__in_example'], # Array<String> | Filter results where company is in a comma-separated list of values
|
38
|
+
company__startswith: 'company__startswith_example', # String | Filter results where company starts with value
|
39
|
+
limit: 56, # Integer | Number of results to return per page.
|
40
|
+
metadata_sha256: 'metadata_sha256_example', # String | Filter results where metadata_sha256 matches value
|
41
|
+
metadata_sha256__in: ['metadata_sha256__in_example'], # Array<String> | Filter results where metadata_sha256 is in a comma-separated list of values
|
42
|
+
name: 'name_example', # String | Filter results where name matches value
|
43
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
44
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
45
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
46
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
47
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
48
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
49
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
50
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
51
|
+
}
|
52
|
+
|
53
|
+
begin
|
54
|
+
result = api_instance.list(opts)
|
55
|
+
p result
|
56
|
+
rescue PulpAnsibleClient::ApiError => e
|
57
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3NamespacesApi->list: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
|
64
|
+
Name | Type | Description | Notes
|
65
|
+
------------- | ------------- | ------------- | -------------
|
66
|
+
**company** | **String**| Filter results where company matches value | [optional]
|
67
|
+
**company__contains** | **String**| Filter results where company contains value | [optional]
|
68
|
+
**company__icontains** | **String**| Filter results where company contains value | [optional]
|
69
|
+
**company__in** | [**Array<String>**](String.md)| Filter results where company is in a comma-separated list of values | [optional]
|
70
|
+
**company__startswith** | **String**| Filter results where company starts with value | [optional]
|
71
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
72
|
+
**metadata_sha256** | **String**| Filter results where metadata_sha256 matches value | [optional]
|
73
|
+
**metadata_sha256__in** | [**Array<String>**](String.md)| Filter results where metadata_sha256 is in a comma-separated list of values | [optional]
|
74
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
75
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
76
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
77
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
78
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
79
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
80
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
81
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
82
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
83
|
+
|
84
|
+
### Return type
|
85
|
+
|
86
|
+
[**PaginatedansibleAnsibleNamespaceMetadataResponseList**](PaginatedansibleAnsibleNamespaceMetadataResponseList.md)
|
87
|
+
|
88
|
+
### Authorization
|
89
|
+
|
90
|
+
[basicAuth](../README.md#basicAuth)
|
91
|
+
|
92
|
+
### HTTP request headers
|
93
|
+
|
94
|
+
- **Content-Type**: Not defined
|
95
|
+
- **Accept**: application/json
|
96
|
+
|
97
|
+
|
98
|
+
## read
|
99
|
+
|
100
|
+
> AnsibleAnsibleNamespaceMetadataResponse read(name, opts)
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
Legacy v3 endpoint.
|
105
|
+
|
106
|
+
### Example
|
107
|
+
|
108
|
+
```ruby
|
109
|
+
# load the gem
|
110
|
+
require 'pulp_ansible_client'
|
111
|
+
# setup authorization
|
112
|
+
PulpAnsibleClient.configure do |config|
|
113
|
+
# Configure HTTP basic authorization: basicAuth
|
114
|
+
config.username = 'YOUR USERNAME'
|
115
|
+
config.password = 'YOUR PASSWORD'
|
116
|
+
end
|
117
|
+
|
118
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3NamespacesApi.new
|
119
|
+
name = 'name_example' # String |
|
120
|
+
opts = {
|
121
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
122
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
123
|
+
}
|
124
|
+
|
125
|
+
begin
|
126
|
+
result = api_instance.read(name, opts)
|
127
|
+
p result
|
128
|
+
rescue PulpAnsibleClient::ApiError => e
|
129
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3NamespacesApi->read: #{e}"
|
130
|
+
end
|
131
|
+
```
|
132
|
+
|
133
|
+
### Parameters
|
134
|
+
|
135
|
+
|
136
|
+
Name | Type | Description | Notes
|
137
|
+
------------- | ------------- | ------------- | -------------
|
138
|
+
**name** | **String**| |
|
139
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
140
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
141
|
+
|
142
|
+
### Return type
|
143
|
+
|
144
|
+
[**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md)
|
145
|
+
|
146
|
+
### Authorization
|
147
|
+
|
148
|
+
[basicAuth](../README.md#basicAuth)
|
149
|
+
|
150
|
+
### HTTP request headers
|
151
|
+
|
152
|
+
- **Content-Type**: Not defined
|
153
|
+
- **Accept**: application/json
|
154
|
+
|
@@ -4,17 +4,17 @@ All URIs are relative to *https://pulp*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
7
|
+
[**read**](PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/client-configuration/ |
|
8
8
|
|
9
9
|
|
10
10
|
|
11
|
-
##
|
11
|
+
## read
|
12
12
|
|
13
|
-
> ClientConfigurationResponse
|
13
|
+
> ClientConfigurationResponse read
|
14
14
|
|
15
15
|
|
16
16
|
|
17
|
-
|
17
|
+
Return configurations for the ansible-galaxy client.
|
18
18
|
|
19
19
|
### Example
|
20
20
|
|
@@ -31,10 +31,10 @@ end
|
|
31
31
|
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.new
|
32
32
|
|
33
33
|
begin
|
34
|
-
result = api_instance.
|
34
|
+
result = api_instance.read
|
35
35
|
p result
|
36
36
|
rescue PulpAnsibleClient::ApiError => e
|
37
|
-
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi->
|
37
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi->read: #{e}"
|
38
38
|
end
|
39
39
|
```
|
40
40
|
|
@@ -34,9 +34,7 @@ opts = {
|
|
34
34
|
deprecated: true, # Boolean |
|
35
35
|
name: 'name_example', # String |
|
36
36
|
namespace: 'namespace_example', # String |
|
37
|
-
ordering: ['ordering_example'], # Array<String> | Ordering
|
38
|
-
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
39
|
-
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
37
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
40
38
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
41
39
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
42
40
|
}
|
@@ -58,9 +56,7 @@ Name | Type | Description | Notes
|
|
58
56
|
**deprecated** | **Boolean**| | [optional]
|
59
57
|
**name** | **String**| | [optional]
|
60
58
|
**namespace** | **String**| | [optional]
|
61
|
-
**ordering** | [**Array<String>**](String.md)| Ordering
|
62
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
63
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
59
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
64
60
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
65
61
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
66
62
|
|
@@ -95,9 +95,7 @@ opts = {
|
|
95
95
|
name: 'name_example', # String |
|
96
96
|
namespace: 'namespace_example', # String |
|
97
97
|
offset: 56, # Integer | The initial index from which to return the results.
|
98
|
-
ordering: ['ordering_example'], # Array<String> | Ordering
|
99
|
-
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
100
|
-
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
98
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
101
99
|
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
102
100
|
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
103
101
|
}
|
@@ -121,9 +119,7 @@ Name | Type | Description | Notes
|
|
121
119
|
**name** | **String**| | [optional]
|
122
120
|
**namespace** | **String**| | [optional]
|
123
121
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
124
|
-
**ordering** | [**Array<String>**](String.md)| Ordering
|
125
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
126
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
122
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
127
123
|
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
128
124
|
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
129
125
|
|
@@ -98,9 +98,7 @@ opts = {
|
|
98
98
|
name2: 'name_example', # String |
|
99
99
|
namespace2: 'namespace_example', # String |
|
100
100
|
offset: 56, # Integer | The initial index from which to return the results.
|
101
|
-
ordering: ['ordering_example'], # Array<String> | Ordering
|
102
|
-
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
|
103
|
-
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
|
101
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
104
102
|
q: 'q_example', # String |
|
105
103
|
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
|
106
104
|
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
|
@@ -132,9 +130,7 @@ Name | Type | Description | Notes
|
|
132
130
|
**name2** | **String**| | [optional]
|
133
131
|
**namespace2** | **String**| | [optional]
|
134
132
|
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
135
|
-
**ordering** | [**Array<String>**](String.md)| Ordering
|
136
|
-
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
137
|
-
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
|
133
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
138
134
|
**q** | **String**| | [optional]
|
139
135
|
**repository_version** | **String**| Repository Version referenced by HREF | [optional]
|
140
136
|
**repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
|
@@ -0,0 +1,353 @@
|
|
1
|
+
# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pulp*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**create**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#create) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/ |
|
8
|
+
[**delete**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#delete) | **DELETE** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ |
|
9
|
+
[**list**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/ |
|
10
|
+
[**partial_update**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#partial_update) | **PATCH** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ |
|
11
|
+
[**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ |
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## create
|
16
|
+
|
17
|
+
> AsyncOperationResponse create(distro_base_path, name, opts)
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
Custom exception handler mixin class.
|
22
|
+
|
23
|
+
### Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'pulp_ansible_client'
|
28
|
+
# setup authorization
|
29
|
+
PulpAnsibleClient.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: basicAuth
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
|
36
|
+
distro_base_path = 'distro_base_path_example' # String |
|
37
|
+
name = 'name_example' # String | Required named, only accepts lowercase, numbers and underscores.
|
38
|
+
opts = {
|
39
|
+
company: 'company_example', # String | Optional namespace company owner.
|
40
|
+
email: 'email_example', # String | Optional namespace contact email.
|
41
|
+
description: 'description_example', # String | Optional short description.
|
42
|
+
resources: 'resources_example', # String | Optional resource page in markdown format.
|
43
|
+
links: PulpAnsibleClient::NamespaceLink.new, # Array<NamespaceLink> | Labeled related links.
|
44
|
+
avatar: File.new('/path/to/file') # File | Optional avatar image for Namespace
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
result = api_instance.create(distro_base_path, name, opts)
|
49
|
+
p result
|
50
|
+
rescue PulpAnsibleClient::ApiError => e
|
51
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->create: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**distro_base_path** | **String**| |
|
61
|
+
**name** | **String**| Required named, only accepts lowercase, numbers and underscores. |
|
62
|
+
**company** | **String**| Optional namespace company owner. | [optional]
|
63
|
+
**email** | **String**| Optional namespace contact email. | [optional]
|
64
|
+
**description** | **String**| Optional short description. | [optional]
|
65
|
+
**resources** | **String**| Optional resource page in markdown format. | [optional]
|
66
|
+
**links** | [**Array<NamespaceLink>**](NamespaceLink.md)| Labeled related links. | [optional]
|
67
|
+
**avatar** | **File**| Optional avatar image for Namespace | [optional]
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[basicAuth](../README.md#basicAuth)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## delete
|
84
|
+
|
85
|
+
> AsyncOperationResponse delete(distro_base_path, name)
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
Try to remove the Namespace if no Collections under Namespace are present.
|
90
|
+
|
91
|
+
### Example
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
# load the gem
|
95
|
+
require 'pulp_ansible_client'
|
96
|
+
# setup authorization
|
97
|
+
PulpAnsibleClient.configure do |config|
|
98
|
+
# Configure HTTP basic authorization: basicAuth
|
99
|
+
config.username = 'YOUR USERNAME'
|
100
|
+
config.password = 'YOUR PASSWORD'
|
101
|
+
end
|
102
|
+
|
103
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
|
104
|
+
distro_base_path = 'distro_base_path_example' # String |
|
105
|
+
name = 'name_example' # String |
|
106
|
+
|
107
|
+
begin
|
108
|
+
result = api_instance.delete(distro_base_path, name)
|
109
|
+
p result
|
110
|
+
rescue PulpAnsibleClient::ApiError => e
|
111
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->delete: #{e}"
|
112
|
+
end
|
113
|
+
```
|
114
|
+
|
115
|
+
### Parameters
|
116
|
+
|
117
|
+
|
118
|
+
Name | Type | Description | Notes
|
119
|
+
------------- | ------------- | ------------- | -------------
|
120
|
+
**distro_base_path** | **String**| |
|
121
|
+
**name** | **String**| |
|
122
|
+
|
123
|
+
### Return type
|
124
|
+
|
125
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
126
|
+
|
127
|
+
### Authorization
|
128
|
+
|
129
|
+
[basicAuth](../README.md#basicAuth)
|
130
|
+
|
131
|
+
### HTTP request headers
|
132
|
+
|
133
|
+
- **Content-Type**: Not defined
|
134
|
+
- **Accept**: application/json
|
135
|
+
|
136
|
+
|
137
|
+
## list
|
138
|
+
|
139
|
+
> PaginatedansibleAnsibleNamespaceMetadataResponseList list(distro_base_path, opts)
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
Custom exception handler mixin class.
|
144
|
+
|
145
|
+
### Example
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
# load the gem
|
149
|
+
require 'pulp_ansible_client'
|
150
|
+
# setup authorization
|
151
|
+
PulpAnsibleClient.configure do |config|
|
152
|
+
# Configure HTTP basic authorization: basicAuth
|
153
|
+
config.username = 'YOUR USERNAME'
|
154
|
+
config.password = 'YOUR PASSWORD'
|
155
|
+
end
|
156
|
+
|
157
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
|
158
|
+
distro_base_path = 'distro_base_path_example' # String |
|
159
|
+
opts = {
|
160
|
+
company: 'company_example', # String | Filter results where company matches value
|
161
|
+
company__contains: 'company__contains_example', # String | Filter results where company contains value
|
162
|
+
company__icontains: 'company__icontains_example', # String | Filter results where company contains value
|
163
|
+
company__in: ['company__in_example'], # Array<String> | Filter results where company is in a comma-separated list of values
|
164
|
+
company__startswith: 'company__startswith_example', # String | Filter results where company starts with value
|
165
|
+
limit: 56, # Integer | Number of results to return per page.
|
166
|
+
metadata_sha256: 'metadata_sha256_example', # String | Filter results where metadata_sha256 matches value
|
167
|
+
metadata_sha256__in: ['metadata_sha256__in_example'], # Array<String> | Filter results where metadata_sha256 is in a comma-separated list of values
|
168
|
+
name: 'name_example', # String | Filter results where name matches value
|
169
|
+
name__contains: 'name__contains_example', # String | Filter results where name contains value
|
170
|
+
name__icontains: 'name__icontains_example', # String | Filter results where name contains value
|
171
|
+
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
|
172
|
+
name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
|
173
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
174
|
+
ordering: ['ordering_example'], # Array<String> | Ordering
|
175
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
176
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
177
|
+
}
|
178
|
+
|
179
|
+
begin
|
180
|
+
result = api_instance.list(distro_base_path, opts)
|
181
|
+
p result
|
182
|
+
rescue PulpAnsibleClient::ApiError => e
|
183
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->list: #{e}"
|
184
|
+
end
|
185
|
+
```
|
186
|
+
|
187
|
+
### Parameters
|
188
|
+
|
189
|
+
|
190
|
+
Name | Type | Description | Notes
|
191
|
+
------------- | ------------- | ------------- | -------------
|
192
|
+
**distro_base_path** | **String**| |
|
193
|
+
**company** | **String**| Filter results where company matches value | [optional]
|
194
|
+
**company__contains** | **String**| Filter results where company contains value | [optional]
|
195
|
+
**company__icontains** | **String**| Filter results where company contains value | [optional]
|
196
|
+
**company__in** | [**Array<String>**](String.md)| Filter results where company is in a comma-separated list of values | [optional]
|
197
|
+
**company__startswith** | **String**| Filter results where company starts with value | [optional]
|
198
|
+
**limit** | **Integer**| Number of results to return per page. | [optional]
|
199
|
+
**metadata_sha256** | **String**| Filter results where metadata_sha256 matches value | [optional]
|
200
|
+
**metadata_sha256__in** | [**Array<String>**](String.md)| Filter results where metadata_sha256 is in a comma-separated list of values | [optional]
|
201
|
+
**name** | **String**| Filter results where name matches value | [optional]
|
202
|
+
**name__contains** | **String**| Filter results where name contains value | [optional]
|
203
|
+
**name__icontains** | **String**| Filter results where name contains value | [optional]
|
204
|
+
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
|
205
|
+
**name__startswith** | **String**| Filter results where name starts with value | [optional]
|
206
|
+
**offset** | **Integer**| The initial index from which to return the results. | [optional]
|
207
|
+
**ordering** | [**Array<String>**](String.md)| Ordering | [optional]
|
208
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
209
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
210
|
+
|
211
|
+
### Return type
|
212
|
+
|
213
|
+
[**PaginatedansibleAnsibleNamespaceMetadataResponseList**](PaginatedansibleAnsibleNamespaceMetadataResponseList.md)
|
214
|
+
|
215
|
+
### Authorization
|
216
|
+
|
217
|
+
[basicAuth](../README.md#basicAuth)
|
218
|
+
|
219
|
+
### HTTP request headers
|
220
|
+
|
221
|
+
- **Content-Type**: Not defined
|
222
|
+
- **Accept**: application/json
|
223
|
+
|
224
|
+
|
225
|
+
## partial_update
|
226
|
+
|
227
|
+
> AsyncOperationResponse partial_update(distro_base_path, name, opts)
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
Custom exception handler mixin class.
|
232
|
+
|
233
|
+
### Example
|
234
|
+
|
235
|
+
```ruby
|
236
|
+
# load the gem
|
237
|
+
require 'pulp_ansible_client'
|
238
|
+
# setup authorization
|
239
|
+
PulpAnsibleClient.configure do |config|
|
240
|
+
# Configure HTTP basic authorization: basicAuth
|
241
|
+
config.username = 'YOUR USERNAME'
|
242
|
+
config.password = 'YOUR PASSWORD'
|
243
|
+
end
|
244
|
+
|
245
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
|
246
|
+
distro_base_path = 'distro_base_path_example' # String |
|
247
|
+
name = 'name_example' # String |
|
248
|
+
opts = {
|
249
|
+
name: 'name_example', # String | Required named, only accepts lowercase, numbers and underscores.
|
250
|
+
company: 'company_example', # String | Optional namespace company owner.
|
251
|
+
email: 'email_example', # String | Optional namespace contact email.
|
252
|
+
description: 'description_example', # String | Optional short description.
|
253
|
+
resources: 'resources_example', # String | Optional resource page in markdown format.
|
254
|
+
links: PulpAnsibleClient::NamespaceLink.new, # Array<NamespaceLink> | Labeled related links.
|
255
|
+
avatar: File.new('/path/to/file') # File | Optional avatar image for Namespace
|
256
|
+
}
|
257
|
+
|
258
|
+
begin
|
259
|
+
result = api_instance.partial_update(distro_base_path, name, opts)
|
260
|
+
p result
|
261
|
+
rescue PulpAnsibleClient::ApiError => e
|
262
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->partial_update: #{e}"
|
263
|
+
end
|
264
|
+
```
|
265
|
+
|
266
|
+
### Parameters
|
267
|
+
|
268
|
+
|
269
|
+
Name | Type | Description | Notes
|
270
|
+
------------- | ------------- | ------------- | -------------
|
271
|
+
**distro_base_path** | **String**| |
|
272
|
+
**name** | **String**| |
|
273
|
+
**name** | **String**| Required named, only accepts lowercase, numbers and underscores. | [optional]
|
274
|
+
**company** | **String**| Optional namespace company owner. | [optional]
|
275
|
+
**email** | **String**| Optional namespace contact email. | [optional]
|
276
|
+
**description** | **String**| Optional short description. | [optional]
|
277
|
+
**resources** | **String**| Optional resource page in markdown format. | [optional]
|
278
|
+
**links** | [**Array<NamespaceLink>**](NamespaceLink.md)| Labeled related links. | [optional]
|
279
|
+
**avatar** | **File**| Optional avatar image for Namespace | [optional]
|
280
|
+
|
281
|
+
### Return type
|
282
|
+
|
283
|
+
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
284
|
+
|
285
|
+
### Authorization
|
286
|
+
|
287
|
+
[basicAuth](../README.md#basicAuth)
|
288
|
+
|
289
|
+
### HTTP request headers
|
290
|
+
|
291
|
+
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
292
|
+
- **Accept**: application/json
|
293
|
+
|
294
|
+
|
295
|
+
## read
|
296
|
+
|
297
|
+
> AnsibleAnsibleNamespaceMetadataResponse read(distro_base_path, name, opts)
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
Custom exception handler mixin class.
|
302
|
+
|
303
|
+
### Example
|
304
|
+
|
305
|
+
```ruby
|
306
|
+
# load the gem
|
307
|
+
require 'pulp_ansible_client'
|
308
|
+
# setup authorization
|
309
|
+
PulpAnsibleClient.configure do |config|
|
310
|
+
# Configure HTTP basic authorization: basicAuth
|
311
|
+
config.username = 'YOUR USERNAME'
|
312
|
+
config.password = 'YOUR PASSWORD'
|
313
|
+
end
|
314
|
+
|
315
|
+
api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
|
316
|
+
distro_base_path = 'distro_base_path_example' # String |
|
317
|
+
name = 'name_example' # String |
|
318
|
+
opts = {
|
319
|
+
fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
|
320
|
+
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
|
321
|
+
}
|
322
|
+
|
323
|
+
begin
|
324
|
+
result = api_instance.read(distro_base_path, name, opts)
|
325
|
+
p result
|
326
|
+
rescue PulpAnsibleClient::ApiError => e
|
327
|
+
puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->read: #{e}"
|
328
|
+
end
|
329
|
+
```
|
330
|
+
|
331
|
+
### Parameters
|
332
|
+
|
333
|
+
|
334
|
+
Name | Type | Description | Notes
|
335
|
+
------------- | ------------- | ------------- | -------------
|
336
|
+
**distro_base_path** | **String**| |
|
337
|
+
**name** | **String**| |
|
338
|
+
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
|
339
|
+
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
|
340
|
+
|
341
|
+
### Return type
|
342
|
+
|
343
|
+
[**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md)
|
344
|
+
|
345
|
+
### Authorization
|
346
|
+
|
347
|
+
[basicAuth](../README.md#basicAuth)
|
348
|
+
|
349
|
+
### HTTP request headers
|
350
|
+
|
351
|
+
- **Content-Type**: Not defined
|
352
|
+
- **Accept**: application/json
|
353
|
+
|