crc-pulp-npm-client 20251023.2__py3-none-any.whl → 20251023.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of crc-pulp-npm-client might be problematic. Click here for more details.
- crc_pulp_npm_client-20251023.3.dist-info/METADATA +25 -0
- {crc_pulp_npm_client-20251023.2.dist-info → crc_pulp_npm_client-20251023.3.dist-info}/RECORD +6 -6
- pulpcore/client/pulp_npm/__init__.py +1 -1
- pulpcore/client/pulp_npm/configuration.py +3 -3
- crc_pulp_npm_client-20251023.2.dist-info/METADATA +0 -4561
- {crc_pulp_npm_client-20251023.2.dist-info → crc_pulp_npm_client-20251023.3.dist-info}/WHEEL +0 -0
- {crc_pulp_npm_client-20251023.2.dist-info → crc_pulp_npm_client-20251023.3.dist-info}/top_level.txt +0 -0
|
@@ -1,4561 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: crc-pulp_npm-client
|
|
3
|
-
Version: 20251023.2
|
|
4
|
-
Summary: Pulp 3 API
|
|
5
|
-
Home-page:
|
|
6
|
-
Author: Pulp Team
|
|
7
|
-
Author-email: pulp-list@redhat.com
|
|
8
|
-
License: GPLv2+
|
|
9
|
-
Keywords: pulp,pulpcore,client,Pulp 3 API
|
|
10
|
-
Description-Content-Type: text/markdown
|
|
11
|
-
Requires-Dist: urllib3<3.0.0,>=1.25.3
|
|
12
|
-
Requires-Dist: python-dateutil<2.10.0,>=2.8.1
|
|
13
|
-
Requires-Dist: pydantic>=2
|
|
14
|
-
Requires-Dist: typing-extensions>=4.7.1
|
|
15
|
-
Dynamic: author
|
|
16
|
-
Dynamic: author-email
|
|
17
|
-
Dynamic: description
|
|
18
|
-
Dynamic: description-content-type
|
|
19
|
-
Dynamic: keywords
|
|
20
|
-
Dynamic: license
|
|
21
|
-
Dynamic: requires-dist
|
|
22
|
-
Dynamic: summary
|
|
23
|
-
|
|
24
|
-
# AsyncOperationResponse
|
|
25
|
-
|
|
26
|
-
Serializer for asynchronous operations.
|
|
27
|
-
|
|
28
|
-
## Properties
|
|
29
|
-
|
|
30
|
-
Name | Type | Description | Notes
|
|
31
|
-
------------ | ------------- | ------------- | -------------
|
|
32
|
-
**task** | **str** | The href of the task. |
|
|
33
|
-
|
|
34
|
-
## Example
|
|
35
|
-
|
|
36
|
-
```python
|
|
37
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
38
|
-
|
|
39
|
-
# TODO update the JSON string below
|
|
40
|
-
json = "{}"
|
|
41
|
-
# create an instance of AsyncOperationResponse from a JSON string
|
|
42
|
-
async_operation_response_instance = AsyncOperationResponse.from_json(json)
|
|
43
|
-
# print the JSON string representation of the object
|
|
44
|
-
print(AsyncOperationResponse.to_json())
|
|
45
|
-
|
|
46
|
-
# convert the object into a dict
|
|
47
|
-
async_operation_response_dict = async_operation_response_instance.to_dict()
|
|
48
|
-
# create an instance of AsyncOperationResponse from a dict
|
|
49
|
-
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)
|
|
50
|
-
```
|
|
51
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
# pulpcore.client.pulp_npm.ContentPackagesApi
|
|
55
|
-
|
|
56
|
-
All URIs are relative to *https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
57
|
-
|
|
58
|
-
Method | HTTP request | Description
|
|
59
|
-
------------- | ------------- | -------------
|
|
60
|
-
[**create**](ContentPackagesApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/content/npm/packages/ | Create a package
|
|
61
|
-
[**list**](ContentPackagesApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/content/npm/packages/ | List packages
|
|
62
|
-
[**read**](ContentPackagesApi.md#read) | **GET** {npm_package_href} | Inspect a package
|
|
63
|
-
[**set_label**](ContentPackagesApi.md#set_label) | **POST** {npm_package_href}set_label/ | Set a label
|
|
64
|
-
[**unset_label**](ContentPackagesApi.md#unset_label) | **POST** {npm_package_href}unset_label/ | Unset a label
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
# **create**
|
|
68
|
-
> NpmPackageResponse create(pulp_domain, relative_path, name, version, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url)
|
|
69
|
-
|
|
70
|
-
Create a package
|
|
71
|
-
|
|
72
|
-
Perform bookkeeping when saving Content. \"Artifacts\" need to be popped off and saved independently, as they are not actually part of the Content model.
|
|
73
|
-
|
|
74
|
-
### Example
|
|
75
|
-
|
|
76
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
77
|
-
* Basic Authentication (basicAuth):
|
|
78
|
-
* Api Key Authentication (cookieAuth):
|
|
79
|
-
|
|
80
|
-
```python
|
|
81
|
-
import pulpcore.client.pulp_npm
|
|
82
|
-
from pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse
|
|
83
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
84
|
-
from pprint import pprint
|
|
85
|
-
|
|
86
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
87
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
88
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
89
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
90
|
-
)
|
|
91
|
-
|
|
92
|
-
# The client must configure the authentication and authorization parameters
|
|
93
|
-
# in accordance with the API server security policy.
|
|
94
|
-
# Examples for each auth method are provided below, use the example that
|
|
95
|
-
# satisfies your auth use case.
|
|
96
|
-
|
|
97
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
98
|
-
|
|
99
|
-
# Configure HTTP basic authorization: basicAuth
|
|
100
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
101
|
-
username = os.environ["USERNAME"],
|
|
102
|
-
password = os.environ["PASSWORD"]
|
|
103
|
-
)
|
|
104
|
-
|
|
105
|
-
# Configure API key authorization: cookieAuth
|
|
106
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
107
|
-
|
|
108
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
109
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
110
|
-
|
|
111
|
-
# Enter a context with an instance of the API client
|
|
112
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
113
|
-
# Create an instance of the API class
|
|
114
|
-
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
|
|
115
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
116
|
-
relative_path = 'relative_path_example' # str |
|
|
117
|
-
name = 'name_example' # str |
|
|
118
|
-
version = 'version_example' # str |
|
|
119
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
120
|
-
repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
|
|
121
|
-
pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
|
|
122
|
-
artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
|
|
123
|
-
file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
|
|
124
|
-
upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
|
|
125
|
-
file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
|
|
126
|
-
|
|
127
|
-
try:
|
|
128
|
-
# Create a package
|
|
129
|
-
api_response = api_instance.create(pulp_domain, relative_path, name, version, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url)
|
|
130
|
-
print("The response of ContentPackagesApi->create:\n")
|
|
131
|
-
pprint(api_response)
|
|
132
|
-
except Exception as e:
|
|
133
|
-
print("Exception when calling ContentPackagesApi->create: %s\n" % e)
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
### Parameters
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
Name | Type | Description | Notes
|
|
142
|
-
------------- | ------------- | ------------- | -------------
|
|
143
|
-
**pulp_domain** | **str**| |
|
|
144
|
-
**relative_path** | **str**| |
|
|
145
|
-
**name** | **str**| |
|
|
146
|
-
**version** | **str**| |
|
|
147
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
148
|
-
**repository** | **str**| A URI of a repository the new content unit should be associated with. | [optional]
|
|
149
|
-
**pulp_labels** | [**Dict[str, Optional[str]]**](Dict.md)| A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional]
|
|
150
|
-
**artifact** | **str**| Artifact file representing the physical content | [optional]
|
|
151
|
-
**file** | **bytearray**| An uploaded file that may be turned into the content unit. | [optional]
|
|
152
|
-
**upload** | **str**| An uncommitted upload that may be turned into the content unit. | [optional]
|
|
153
|
-
**file_url** | **str**| A url that Pulp can download and turn into the content unit. | [optional]
|
|
154
|
-
|
|
155
|
-
### Return type
|
|
156
|
-
|
|
157
|
-
[**NpmPackageResponse**](NpmPackageResponse.md)
|
|
158
|
-
|
|
159
|
-
### Authorization
|
|
160
|
-
|
|
161
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
162
|
-
|
|
163
|
-
### HTTP request headers
|
|
164
|
-
|
|
165
|
-
- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
|
|
166
|
-
- **Accept**: application/json
|
|
167
|
-
|
|
168
|
-
### HTTP response details
|
|
169
|
-
|
|
170
|
-
| Status code | Description | Response headers |
|
|
171
|
-
|-------------|-------------|------------------|
|
|
172
|
-
**201** | | - |
|
|
173
|
-
|
|
174
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
175
|
-
|
|
176
|
-
# **list**
|
|
177
|
-
> PaginatednpmPackageResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
|
|
178
|
-
|
|
179
|
-
List packages
|
|
180
|
-
|
|
181
|
-
A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
|
|
182
|
-
|
|
183
|
-
### Example
|
|
184
|
-
|
|
185
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
186
|
-
* Basic Authentication (basicAuth):
|
|
187
|
-
* Api Key Authentication (cookieAuth):
|
|
188
|
-
|
|
189
|
-
```python
|
|
190
|
-
import pulpcore.client.pulp_npm
|
|
191
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_package_response_list import PaginatednpmPackageResponseList
|
|
192
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
193
|
-
from pprint import pprint
|
|
194
|
-
|
|
195
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
196
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
197
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
198
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
199
|
-
)
|
|
200
|
-
|
|
201
|
-
# The client must configure the authentication and authorization parameters
|
|
202
|
-
# in accordance with the API server security policy.
|
|
203
|
-
# Examples for each auth method are provided below, use the example that
|
|
204
|
-
# satisfies your auth use case.
|
|
205
|
-
|
|
206
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
207
|
-
|
|
208
|
-
# Configure HTTP basic authorization: basicAuth
|
|
209
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
210
|
-
username = os.environ["USERNAME"],
|
|
211
|
-
password = os.environ["PASSWORD"]
|
|
212
|
-
)
|
|
213
|
-
|
|
214
|
-
# Configure API key authorization: cookieAuth
|
|
215
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
216
|
-
|
|
217
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
218
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
219
|
-
|
|
220
|
-
# Enter a context with an instance of the API client
|
|
221
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
222
|
-
# Create an instance of the API class
|
|
223
|
-
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
|
|
224
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
225
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
226
|
-
limit = 56 # int | Number of results to return per page. (optional)
|
|
227
|
-
name = 'name_example' # str | Filter results where name matches value (optional)
|
|
228
|
-
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
|
|
229
|
-
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
230
|
-
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
|
|
231
|
-
orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
|
|
232
|
-
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
233
|
-
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
234
|
-
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
235
|
-
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
|
|
236
|
-
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
237
|
-
repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
|
|
238
|
-
repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
|
|
239
|
-
repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
|
|
240
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
241
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
242
|
-
|
|
243
|
-
try:
|
|
244
|
-
# List packages
|
|
245
|
-
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, fields=fields, exclude_fields=exclude_fields)
|
|
246
|
-
print("The response of ContentPackagesApi->list:\n")
|
|
247
|
-
pprint(api_response)
|
|
248
|
-
except Exception as e:
|
|
249
|
-
print("Exception when calling ContentPackagesApi->list: %s\n" % e)
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
### Parameters
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
Name | Type | Description | Notes
|
|
258
|
-
------------- | ------------- | ------------- | -------------
|
|
259
|
-
**pulp_domain** | **str**| |
|
|
260
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
261
|
-
**limit** | **int**| Number of results to return per page. | [optional]
|
|
262
|
-
**name** | **str**| Filter results where name matches value | [optional]
|
|
263
|
-
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
|
|
264
|
-
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
265
|
-
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
|
266
|
-
**orphaned_for** | **float**| Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional]
|
|
267
|
-
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
268
|
-
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
269
|
-
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
270
|
-
**pulp_label_select** | **str**| Filter labels by search string | [optional]
|
|
271
|
-
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
272
|
-
**repository_version** | **str**| Repository Version referenced by HREF/PRN | [optional]
|
|
273
|
-
**repository_version_added** | **str**| Repository Version referenced by HREF/PRN | [optional]
|
|
274
|
-
**repository_version_removed** | **str**| Repository Version referenced by HREF/PRN | [optional]
|
|
275
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
276
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
277
|
-
|
|
278
|
-
### Return type
|
|
279
|
-
|
|
280
|
-
[**PaginatednpmPackageResponseList**](PaginatednpmPackageResponseList.md)
|
|
281
|
-
|
|
282
|
-
### Authorization
|
|
283
|
-
|
|
284
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
285
|
-
|
|
286
|
-
### HTTP request headers
|
|
287
|
-
|
|
288
|
-
- **Content-Type**: Not defined
|
|
289
|
-
- **Accept**: application/json
|
|
290
|
-
|
|
291
|
-
### HTTP response details
|
|
292
|
-
|
|
293
|
-
| Status code | Description | Response headers |
|
|
294
|
-
|-------------|-------------|------------------|
|
|
295
|
-
**200** | | - |
|
|
296
|
-
|
|
297
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
298
|
-
|
|
299
|
-
# **read**
|
|
300
|
-
> NpmPackageResponse read(npm_package_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
301
|
-
|
|
302
|
-
Inspect a package
|
|
303
|
-
|
|
304
|
-
A ViewSet for Package. Define endpoint name which will appear in the API endpoint for this content type. For example:: http://pulp.example.com/pulp/api/v3/content/npm/units/ Also specify queryset and serializer for Package.
|
|
305
|
-
|
|
306
|
-
### Example
|
|
307
|
-
|
|
308
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
309
|
-
* Basic Authentication (basicAuth):
|
|
310
|
-
* Api Key Authentication (cookieAuth):
|
|
311
|
-
|
|
312
|
-
```python
|
|
313
|
-
import pulpcore.client.pulp_npm
|
|
314
|
-
from pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse
|
|
315
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
316
|
-
from pprint import pprint
|
|
317
|
-
|
|
318
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
319
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
320
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
321
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
322
|
-
)
|
|
323
|
-
|
|
324
|
-
# The client must configure the authentication and authorization parameters
|
|
325
|
-
# in accordance with the API server security policy.
|
|
326
|
-
# Examples for each auth method are provided below, use the example that
|
|
327
|
-
# satisfies your auth use case.
|
|
328
|
-
|
|
329
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
330
|
-
|
|
331
|
-
# Configure HTTP basic authorization: basicAuth
|
|
332
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
333
|
-
username = os.environ["USERNAME"],
|
|
334
|
-
password = os.environ["PASSWORD"]
|
|
335
|
-
)
|
|
336
|
-
|
|
337
|
-
# Configure API key authorization: cookieAuth
|
|
338
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
339
|
-
|
|
340
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
341
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
342
|
-
|
|
343
|
-
# Enter a context with an instance of the API client
|
|
344
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
345
|
-
# Create an instance of the API class
|
|
346
|
-
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
|
|
347
|
-
npm_package_href = 'npm_package_href_example' # str |
|
|
348
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
349
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
350
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
351
|
-
|
|
352
|
-
try:
|
|
353
|
-
# Inspect a package
|
|
354
|
-
api_response = api_instance.read(npm_package_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
355
|
-
print("The response of ContentPackagesApi->read:\n")
|
|
356
|
-
pprint(api_response)
|
|
357
|
-
except Exception as e:
|
|
358
|
-
print("Exception when calling ContentPackagesApi->read: %s\n" % e)
|
|
359
|
-
```
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
### Parameters
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
Name | Type | Description | Notes
|
|
367
|
-
------------- | ------------- | ------------- | -------------
|
|
368
|
-
**npm_package_href** | **str**| |
|
|
369
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
370
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
371
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
372
|
-
|
|
373
|
-
### Return type
|
|
374
|
-
|
|
375
|
-
[**NpmPackageResponse**](NpmPackageResponse.md)
|
|
376
|
-
|
|
377
|
-
### Authorization
|
|
378
|
-
|
|
379
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
380
|
-
|
|
381
|
-
### HTTP request headers
|
|
382
|
-
|
|
383
|
-
- **Content-Type**: Not defined
|
|
384
|
-
- **Accept**: application/json
|
|
385
|
-
|
|
386
|
-
### HTTP response details
|
|
387
|
-
|
|
388
|
-
| Status code | Description | Response headers |
|
|
389
|
-
|-------------|-------------|------------------|
|
|
390
|
-
**200** | | - |
|
|
391
|
-
|
|
392
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
393
|
-
|
|
394
|
-
# **set_label**
|
|
395
|
-
> SetLabelResponse set_label(npm_package_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
396
|
-
|
|
397
|
-
Set a label
|
|
398
|
-
|
|
399
|
-
Set a single pulp_label on the object to a specific value or null.
|
|
400
|
-
|
|
401
|
-
### Example
|
|
402
|
-
|
|
403
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
404
|
-
* Basic Authentication (basicAuth):
|
|
405
|
-
* Api Key Authentication (cookieAuth):
|
|
406
|
-
|
|
407
|
-
```python
|
|
408
|
-
import pulpcore.client.pulp_npm
|
|
409
|
-
from pulpcore.client.pulp_npm.models.set_label import SetLabel
|
|
410
|
-
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
|
|
411
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
412
|
-
from pprint import pprint
|
|
413
|
-
|
|
414
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
415
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
416
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
417
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
418
|
-
)
|
|
419
|
-
|
|
420
|
-
# The client must configure the authentication and authorization parameters
|
|
421
|
-
# in accordance with the API server security policy.
|
|
422
|
-
# Examples for each auth method are provided below, use the example that
|
|
423
|
-
# satisfies your auth use case.
|
|
424
|
-
|
|
425
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
426
|
-
|
|
427
|
-
# Configure HTTP basic authorization: basicAuth
|
|
428
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
429
|
-
username = os.environ["USERNAME"],
|
|
430
|
-
password = os.environ["PASSWORD"]
|
|
431
|
-
)
|
|
432
|
-
|
|
433
|
-
# Configure API key authorization: cookieAuth
|
|
434
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
435
|
-
|
|
436
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
437
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
438
|
-
|
|
439
|
-
# Enter a context with an instance of the API client
|
|
440
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
441
|
-
# Create an instance of the API class
|
|
442
|
-
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
|
|
443
|
-
npm_package_href = 'npm_package_href_example' # str |
|
|
444
|
-
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
|
|
445
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
446
|
-
|
|
447
|
-
try:
|
|
448
|
-
# Set a label
|
|
449
|
-
api_response = api_instance.set_label(npm_package_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
450
|
-
print("The response of ContentPackagesApi->set_label:\n")
|
|
451
|
-
pprint(api_response)
|
|
452
|
-
except Exception as e:
|
|
453
|
-
print("Exception when calling ContentPackagesApi->set_label: %s\n" % e)
|
|
454
|
-
```
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
### Parameters
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
Name | Type | Description | Notes
|
|
462
|
-
------------- | ------------- | ------------- | -------------
|
|
463
|
-
**npm_package_href** | **str**| |
|
|
464
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
|
465
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
466
|
-
|
|
467
|
-
### Return type
|
|
468
|
-
|
|
469
|
-
[**SetLabelResponse**](SetLabelResponse.md)
|
|
470
|
-
|
|
471
|
-
### Authorization
|
|
472
|
-
|
|
473
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
474
|
-
|
|
475
|
-
### HTTP request headers
|
|
476
|
-
|
|
477
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
478
|
-
- **Accept**: application/json
|
|
479
|
-
|
|
480
|
-
### HTTP response details
|
|
481
|
-
|
|
482
|
-
| Status code | Description | Response headers |
|
|
483
|
-
|-------------|-------------|------------------|
|
|
484
|
-
**201** | | - |
|
|
485
|
-
|
|
486
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
487
|
-
|
|
488
|
-
# **unset_label**
|
|
489
|
-
> UnsetLabelResponse unset_label(npm_package_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
490
|
-
|
|
491
|
-
Unset a label
|
|
492
|
-
|
|
493
|
-
Unset a single pulp_label on the object.
|
|
494
|
-
|
|
495
|
-
### Example
|
|
496
|
-
|
|
497
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
498
|
-
* Basic Authentication (basicAuth):
|
|
499
|
-
* Api Key Authentication (cookieAuth):
|
|
500
|
-
|
|
501
|
-
```python
|
|
502
|
-
import pulpcore.client.pulp_npm
|
|
503
|
-
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
|
|
504
|
-
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
|
|
505
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
506
|
-
from pprint import pprint
|
|
507
|
-
|
|
508
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
509
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
510
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
511
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
512
|
-
)
|
|
513
|
-
|
|
514
|
-
# The client must configure the authentication and authorization parameters
|
|
515
|
-
# in accordance with the API server security policy.
|
|
516
|
-
# Examples for each auth method are provided below, use the example that
|
|
517
|
-
# satisfies your auth use case.
|
|
518
|
-
|
|
519
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
520
|
-
|
|
521
|
-
# Configure HTTP basic authorization: basicAuth
|
|
522
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
523
|
-
username = os.environ["USERNAME"],
|
|
524
|
-
password = os.environ["PASSWORD"]
|
|
525
|
-
)
|
|
526
|
-
|
|
527
|
-
# Configure API key authorization: cookieAuth
|
|
528
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
529
|
-
|
|
530
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
531
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
532
|
-
|
|
533
|
-
# Enter a context with an instance of the API client
|
|
534
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
535
|
-
# Create an instance of the API class
|
|
536
|
-
api_instance = pulpcore.client.pulp_npm.ContentPackagesApi(api_client)
|
|
537
|
-
npm_package_href = 'npm_package_href_example' # str |
|
|
538
|
-
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
|
|
539
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
540
|
-
|
|
541
|
-
try:
|
|
542
|
-
# Unset a label
|
|
543
|
-
api_response = api_instance.unset_label(npm_package_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
544
|
-
print("The response of ContentPackagesApi->unset_label:\n")
|
|
545
|
-
pprint(api_response)
|
|
546
|
-
except Exception as e:
|
|
547
|
-
print("Exception when calling ContentPackagesApi->unset_label: %s\n" % e)
|
|
548
|
-
```
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
### Parameters
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
Name | Type | Description | Notes
|
|
556
|
-
------------- | ------------- | ------------- | -------------
|
|
557
|
-
**npm_package_href** | **str**| |
|
|
558
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
|
559
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
560
|
-
|
|
561
|
-
### Return type
|
|
562
|
-
|
|
563
|
-
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
|
564
|
-
|
|
565
|
-
### Authorization
|
|
566
|
-
|
|
567
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
568
|
-
|
|
569
|
-
### HTTP request headers
|
|
570
|
-
|
|
571
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
572
|
-
- **Accept**: application/json
|
|
573
|
-
|
|
574
|
-
### HTTP response details
|
|
575
|
-
|
|
576
|
-
| Status code | Description | Response headers |
|
|
577
|
-
|-------------|-------------|------------------|
|
|
578
|
-
**201** | | - |
|
|
579
|
-
|
|
580
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
581
|
-
|
|
582
|
-
# ContentSummaryResponse
|
|
583
|
-
|
|
584
|
-
Serializer for the RepositoryVersion content summary
|
|
585
|
-
|
|
586
|
-
## Properties
|
|
587
|
-
|
|
588
|
-
Name | Type | Description | Notes
|
|
589
|
-
------------ | ------------- | ------------- | -------------
|
|
590
|
-
**added** | **Dict[str, object]** | |
|
|
591
|
-
**removed** | **Dict[str, object]** | |
|
|
592
|
-
**present** | **Dict[str, object]** | |
|
|
593
|
-
|
|
594
|
-
## Example
|
|
595
|
-
|
|
596
|
-
```python
|
|
597
|
-
from pulpcore.client.pulp_npm.models.content_summary_response import ContentSummaryResponse
|
|
598
|
-
|
|
599
|
-
# TODO update the JSON string below
|
|
600
|
-
json = "{}"
|
|
601
|
-
# create an instance of ContentSummaryResponse from a JSON string
|
|
602
|
-
content_summary_response_instance = ContentSummaryResponse.from_json(json)
|
|
603
|
-
# print the JSON string representation of the object
|
|
604
|
-
print(ContentSummaryResponse.to_json())
|
|
605
|
-
|
|
606
|
-
# convert the object into a dict
|
|
607
|
-
content_summary_response_dict = content_summary_response_instance.to_dict()
|
|
608
|
-
# create an instance of ContentSummaryResponse from a dict
|
|
609
|
-
content_summary_response_from_dict = ContentSummaryResponse.from_dict(content_summary_response_dict)
|
|
610
|
-
```
|
|
611
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
# pulpcore.client.pulp_npm.DistributionsNpmApi
|
|
615
|
-
|
|
616
|
-
All URIs are relative to *https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
617
|
-
|
|
618
|
-
Method | HTTP request | Description
|
|
619
|
-
------------- | ------------- | -------------
|
|
620
|
-
[**create**](DistributionsNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/distributions/npm/npm/ | Create a npm distribution
|
|
621
|
-
[**delete**](DistributionsNpmApi.md#delete) | **DELETE** {npm_npm_distribution_href} | Delete a npm distribution
|
|
622
|
-
[**list**](DistributionsNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/distributions/npm/npm/ | List npm distributions
|
|
623
|
-
[**partial_update**](DistributionsNpmApi.md#partial_update) | **PATCH** {npm_npm_distribution_href} | Update a npm distribution
|
|
624
|
-
[**read**](DistributionsNpmApi.md#read) | **GET** {npm_npm_distribution_href} | Inspect a npm distribution
|
|
625
|
-
[**set_label**](DistributionsNpmApi.md#set_label) | **POST** {npm_npm_distribution_href}set_label/ | Set a label
|
|
626
|
-
[**unset_label**](DistributionsNpmApi.md#unset_label) | **POST** {npm_npm_distribution_href}unset_label/ | Unset a label
|
|
627
|
-
[**update**](DistributionsNpmApi.md#update) | **PUT** {npm_npm_distribution_href} | Update a npm distribution
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
# **create**
|
|
631
|
-
> AsyncOperationResponse create(pulp_domain, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
|
|
632
|
-
|
|
633
|
-
Create a npm distribution
|
|
634
|
-
|
|
635
|
-
Trigger an asynchronous create task
|
|
636
|
-
|
|
637
|
-
### Example
|
|
638
|
-
|
|
639
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
640
|
-
* Basic Authentication (basicAuth):
|
|
641
|
-
* Api Key Authentication (cookieAuth):
|
|
642
|
-
|
|
643
|
-
```python
|
|
644
|
-
import pulpcore.client.pulp_npm
|
|
645
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
646
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution
|
|
647
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
648
|
-
from pprint import pprint
|
|
649
|
-
|
|
650
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
651
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
652
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
653
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
654
|
-
)
|
|
655
|
-
|
|
656
|
-
# The client must configure the authentication and authorization parameters
|
|
657
|
-
# in accordance with the API server security policy.
|
|
658
|
-
# Examples for each auth method are provided below, use the example that
|
|
659
|
-
# satisfies your auth use case.
|
|
660
|
-
|
|
661
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
662
|
-
|
|
663
|
-
# Configure HTTP basic authorization: basicAuth
|
|
664
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
665
|
-
username = os.environ["USERNAME"],
|
|
666
|
-
password = os.environ["PASSWORD"]
|
|
667
|
-
)
|
|
668
|
-
|
|
669
|
-
# Configure API key authorization: cookieAuth
|
|
670
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
671
|
-
|
|
672
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
673
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
674
|
-
|
|
675
|
-
# Enter a context with an instance of the API client
|
|
676
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
677
|
-
# Create an instance of the API class
|
|
678
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
679
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
680
|
-
npm_npm_distribution = pulpcore.client.pulp_npm.NpmNpmDistribution() # NpmNpmDistribution |
|
|
681
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
682
|
-
|
|
683
|
-
try:
|
|
684
|
-
# Create a npm distribution
|
|
685
|
-
api_response = api_instance.create(pulp_domain, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
|
|
686
|
-
print("The response of DistributionsNpmApi->create:\n")
|
|
687
|
-
pprint(api_response)
|
|
688
|
-
except Exception as e:
|
|
689
|
-
print("Exception when calling DistributionsNpmApi->create: %s\n" % e)
|
|
690
|
-
```
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
### Parameters
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
Name | Type | Description | Notes
|
|
698
|
-
------------- | ------------- | ------------- | -------------
|
|
699
|
-
**pulp_domain** | **str**| |
|
|
700
|
-
**npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
|
|
701
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
702
|
-
|
|
703
|
-
### Return type
|
|
704
|
-
|
|
705
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
706
|
-
|
|
707
|
-
### Authorization
|
|
708
|
-
|
|
709
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
710
|
-
|
|
711
|
-
### HTTP request headers
|
|
712
|
-
|
|
713
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
714
|
-
- **Accept**: application/json
|
|
715
|
-
|
|
716
|
-
### HTTP response details
|
|
717
|
-
|
|
718
|
-
| Status code | Description | Response headers |
|
|
719
|
-
|-------------|-------------|------------------|
|
|
720
|
-
**202** | | - |
|
|
721
|
-
|
|
722
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
723
|
-
|
|
724
|
-
# **delete**
|
|
725
|
-
> AsyncOperationResponse delete(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics)
|
|
726
|
-
|
|
727
|
-
Delete a npm distribution
|
|
728
|
-
|
|
729
|
-
Trigger an asynchronous delete task
|
|
730
|
-
|
|
731
|
-
### Example
|
|
732
|
-
|
|
733
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
734
|
-
* Basic Authentication (basicAuth):
|
|
735
|
-
* Api Key Authentication (cookieAuth):
|
|
736
|
-
|
|
737
|
-
```python
|
|
738
|
-
import pulpcore.client.pulp_npm
|
|
739
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
740
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
741
|
-
from pprint import pprint
|
|
742
|
-
|
|
743
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
744
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
745
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
746
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
747
|
-
)
|
|
748
|
-
|
|
749
|
-
# The client must configure the authentication and authorization parameters
|
|
750
|
-
# in accordance with the API server security policy.
|
|
751
|
-
# Examples for each auth method are provided below, use the example that
|
|
752
|
-
# satisfies your auth use case.
|
|
753
|
-
|
|
754
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
755
|
-
|
|
756
|
-
# Configure HTTP basic authorization: basicAuth
|
|
757
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
758
|
-
username = os.environ["USERNAME"],
|
|
759
|
-
password = os.environ["PASSWORD"]
|
|
760
|
-
)
|
|
761
|
-
|
|
762
|
-
# Configure API key authorization: cookieAuth
|
|
763
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
764
|
-
|
|
765
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
766
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
767
|
-
|
|
768
|
-
# Enter a context with an instance of the API client
|
|
769
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
770
|
-
# Create an instance of the API class
|
|
771
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
772
|
-
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
|
|
773
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
774
|
-
|
|
775
|
-
try:
|
|
776
|
-
# Delete a npm distribution
|
|
777
|
-
api_response = api_instance.delete(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics)
|
|
778
|
-
print("The response of DistributionsNpmApi->delete:\n")
|
|
779
|
-
pprint(api_response)
|
|
780
|
-
except Exception as e:
|
|
781
|
-
print("Exception when calling DistributionsNpmApi->delete: %s\n" % e)
|
|
782
|
-
```
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
### Parameters
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
Name | Type | Description | Notes
|
|
790
|
-
------------- | ------------- | ------------- | -------------
|
|
791
|
-
**npm_npm_distribution_href** | **str**| |
|
|
792
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
793
|
-
|
|
794
|
-
### Return type
|
|
795
|
-
|
|
796
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
797
|
-
|
|
798
|
-
### Authorization
|
|
799
|
-
|
|
800
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
801
|
-
|
|
802
|
-
### HTTP request headers
|
|
803
|
-
|
|
804
|
-
- **Content-Type**: Not defined
|
|
805
|
-
- **Accept**: application/json
|
|
806
|
-
|
|
807
|
-
### HTTP response details
|
|
808
|
-
|
|
809
|
-
| Status code | Description | Response headers |
|
|
810
|
-
|-------------|-------------|------------------|
|
|
811
|
-
**202** | | - |
|
|
812
|
-
|
|
813
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
814
|
-
|
|
815
|
-
# **list**
|
|
816
|
-
> PaginatednpmNpmDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
|
|
817
|
-
|
|
818
|
-
List npm distributions
|
|
819
|
-
|
|
820
|
-
ViewSet for NPM Distributions.
|
|
821
|
-
|
|
822
|
-
### Example
|
|
823
|
-
|
|
824
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
825
|
-
* Basic Authentication (basicAuth):
|
|
826
|
-
* Api Key Authentication (cookieAuth):
|
|
827
|
-
|
|
828
|
-
```python
|
|
829
|
-
import pulpcore.client.pulp_npm
|
|
830
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_npm_distribution_response_list import PaginatednpmNpmDistributionResponseList
|
|
831
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
832
|
-
from pprint import pprint
|
|
833
|
-
|
|
834
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
835
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
836
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
837
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
838
|
-
)
|
|
839
|
-
|
|
840
|
-
# The client must configure the authentication and authorization parameters
|
|
841
|
-
# in accordance with the API server security policy.
|
|
842
|
-
# Examples for each auth method are provided below, use the example that
|
|
843
|
-
# satisfies your auth use case.
|
|
844
|
-
|
|
845
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
846
|
-
|
|
847
|
-
# Configure HTTP basic authorization: basicAuth
|
|
848
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
849
|
-
username = os.environ["USERNAME"],
|
|
850
|
-
password = os.environ["PASSWORD"]
|
|
851
|
-
)
|
|
852
|
-
|
|
853
|
-
# Configure API key authorization: cookieAuth
|
|
854
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
855
|
-
|
|
856
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
857
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
858
|
-
|
|
859
|
-
# Enter a context with an instance of the API client
|
|
860
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
861
|
-
# Create an instance of the API class
|
|
862
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
863
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
864
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
865
|
-
base_path = 'base_path_example' # str | Filter results where base_path matches value (optional)
|
|
866
|
-
base_path__contains = 'base_path__contains_example' # str | Filter results where base_path contains value (optional)
|
|
867
|
-
base_path__icontains = 'base_path__icontains_example' # str | Filter results where base_path contains value (optional)
|
|
868
|
-
base_path__in = ['base_path__in_example'] # List[str] | Filter results where base_path is in a comma-separated list of values (optional)
|
|
869
|
-
checkpoint = True # bool | Filter results where checkpoint matches value (optional)
|
|
870
|
-
limit = 56 # int | Number of results to return per page. (optional)
|
|
871
|
-
name = 'name_example' # str | Filter results where name matches value (optional)
|
|
872
|
-
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
|
|
873
|
-
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
|
|
874
|
-
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
|
|
875
|
-
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
|
|
876
|
-
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
|
|
877
|
-
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
|
|
878
|
-
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
|
|
879
|
-
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
|
|
880
|
-
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
881
|
-
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
|
|
882
|
-
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
883
|
-
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
884
|
-
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
885
|
-
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
|
|
886
|
-
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
887
|
-
repository = 'repository_example' # str | Filter results where repository matches value (optional)
|
|
888
|
-
repository__in = ['repository__in_example'] # List[str] | Filter results where repository is in a comma-separated list of values (optional)
|
|
889
|
-
with_content = 'with_content_example' # str | Filter distributions based on the content served by them (optional)
|
|
890
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
891
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
892
|
-
|
|
893
|
-
try:
|
|
894
|
-
# List npm distributions
|
|
895
|
-
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
|
|
896
|
-
print("The response of DistributionsNpmApi->list:\n")
|
|
897
|
-
pprint(api_response)
|
|
898
|
-
except Exception as e:
|
|
899
|
-
print("Exception when calling DistributionsNpmApi->list: %s\n" % e)
|
|
900
|
-
```
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
### Parameters
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
Name | Type | Description | Notes
|
|
908
|
-
------------- | ------------- | ------------- | -------------
|
|
909
|
-
**pulp_domain** | **str**| |
|
|
910
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
911
|
-
**base_path** | **str**| Filter results where base_path matches value | [optional]
|
|
912
|
-
**base_path__contains** | **str**| Filter results where base_path contains value | [optional]
|
|
913
|
-
**base_path__icontains** | **str**| Filter results where base_path contains value | [optional]
|
|
914
|
-
**base_path__in** | [**List[str]**](str.md)| Filter results where base_path is in a comma-separated list of values | [optional]
|
|
915
|
-
**checkpoint** | **bool**| Filter results where checkpoint matches value | [optional]
|
|
916
|
-
**limit** | **int**| Number of results to return per page. | [optional]
|
|
917
|
-
**name** | **str**| Filter results where name matches value | [optional]
|
|
918
|
-
**name__contains** | **str**| Filter results where name contains value | [optional]
|
|
919
|
-
**name__icontains** | **str**| Filter results where name contains value | [optional]
|
|
920
|
-
**name__iexact** | **str**| Filter results where name matches value | [optional]
|
|
921
|
-
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
|
|
922
|
-
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
|
|
923
|
-
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
|
|
924
|
-
**name__regex** | **str**| Filter results where name matches regex value | [optional]
|
|
925
|
-
**name__startswith** | **str**| Filter results where name starts with value | [optional]
|
|
926
|
-
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
927
|
-
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
|
928
|
-
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
929
|
-
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
930
|
-
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
931
|
-
**pulp_label_select** | **str**| Filter labels by search string | [optional]
|
|
932
|
-
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
933
|
-
**repository** | **str**| Filter results where repository matches value | [optional]
|
|
934
|
-
**repository__in** | [**List[str]**](str.md)| Filter results where repository is in a comma-separated list of values | [optional]
|
|
935
|
-
**with_content** | **str**| Filter distributions based on the content served by them | [optional]
|
|
936
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
937
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
938
|
-
|
|
939
|
-
### Return type
|
|
940
|
-
|
|
941
|
-
[**PaginatednpmNpmDistributionResponseList**](PaginatednpmNpmDistributionResponseList.md)
|
|
942
|
-
|
|
943
|
-
### Authorization
|
|
944
|
-
|
|
945
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
946
|
-
|
|
947
|
-
### HTTP request headers
|
|
948
|
-
|
|
949
|
-
- **Content-Type**: Not defined
|
|
950
|
-
- **Accept**: application/json
|
|
951
|
-
|
|
952
|
-
### HTTP response details
|
|
953
|
-
|
|
954
|
-
| Status code | Description | Response headers |
|
|
955
|
-
|-------------|-------------|------------------|
|
|
956
|
-
**200** | | - |
|
|
957
|
-
|
|
958
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
959
|
-
|
|
960
|
-
# **partial_update**
|
|
961
|
-
> NpmNpmDistributionResponse partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
|
|
962
|
-
|
|
963
|
-
Update a npm distribution
|
|
964
|
-
|
|
965
|
-
Update the entity partially and trigger an asynchronous task if necessary
|
|
966
|
-
|
|
967
|
-
### Example
|
|
968
|
-
|
|
969
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
970
|
-
* Basic Authentication (basicAuth):
|
|
971
|
-
* Api Key Authentication (cookieAuth):
|
|
972
|
-
|
|
973
|
-
```python
|
|
974
|
-
import pulpcore.client.pulp_npm
|
|
975
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
|
|
976
|
-
from pulpcore.client.pulp_npm.models.patchednpm_npm_distribution import PatchednpmNpmDistribution
|
|
977
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
978
|
-
from pprint import pprint
|
|
979
|
-
|
|
980
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
981
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
982
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
983
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
984
|
-
)
|
|
985
|
-
|
|
986
|
-
# The client must configure the authentication and authorization parameters
|
|
987
|
-
# in accordance with the API server security policy.
|
|
988
|
-
# Examples for each auth method are provided below, use the example that
|
|
989
|
-
# satisfies your auth use case.
|
|
990
|
-
|
|
991
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
992
|
-
|
|
993
|
-
# Configure HTTP basic authorization: basicAuth
|
|
994
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
995
|
-
username = os.environ["USERNAME"],
|
|
996
|
-
password = os.environ["PASSWORD"]
|
|
997
|
-
)
|
|
998
|
-
|
|
999
|
-
# Configure API key authorization: cookieAuth
|
|
1000
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1001
|
-
|
|
1002
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1003
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1004
|
-
|
|
1005
|
-
# Enter a context with an instance of the API client
|
|
1006
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
1007
|
-
# Create an instance of the API class
|
|
1008
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
1009
|
-
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
|
|
1010
|
-
patchednpm_npm_distribution = pulpcore.client.pulp_npm.PatchednpmNpmDistribution() # PatchednpmNpmDistribution |
|
|
1011
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1012
|
-
|
|
1013
|
-
try:
|
|
1014
|
-
# Update a npm distribution
|
|
1015
|
-
api_response = api_instance.partial_update(npm_npm_distribution_href, patchednpm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
|
|
1016
|
-
print("The response of DistributionsNpmApi->partial_update:\n")
|
|
1017
|
-
pprint(api_response)
|
|
1018
|
-
except Exception as e:
|
|
1019
|
-
print("Exception when calling DistributionsNpmApi->partial_update: %s\n" % e)
|
|
1020
|
-
```
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
### Parameters
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
Name | Type | Description | Notes
|
|
1028
|
-
------------- | ------------- | ------------- | -------------
|
|
1029
|
-
**npm_npm_distribution_href** | **str**| |
|
|
1030
|
-
**patchednpm_npm_distribution** | [**PatchednpmNpmDistribution**](PatchednpmNpmDistribution.md)| |
|
|
1031
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1032
|
-
|
|
1033
|
-
### Return type
|
|
1034
|
-
|
|
1035
|
-
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
|
|
1036
|
-
|
|
1037
|
-
### Authorization
|
|
1038
|
-
|
|
1039
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1040
|
-
|
|
1041
|
-
### HTTP request headers
|
|
1042
|
-
|
|
1043
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1044
|
-
- **Accept**: application/json
|
|
1045
|
-
|
|
1046
|
-
### HTTP response details
|
|
1047
|
-
|
|
1048
|
-
| Status code | Description | Response headers |
|
|
1049
|
-
|-------------|-------------|------------------|
|
|
1050
|
-
**200** | | - |
|
|
1051
|
-
**202** | | - |
|
|
1052
|
-
|
|
1053
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1054
|
-
|
|
1055
|
-
# **read**
|
|
1056
|
-
> NpmNpmDistributionResponse read(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
1057
|
-
|
|
1058
|
-
Inspect a npm distribution
|
|
1059
|
-
|
|
1060
|
-
ViewSet for NPM Distributions.
|
|
1061
|
-
|
|
1062
|
-
### Example
|
|
1063
|
-
|
|
1064
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
1065
|
-
* Basic Authentication (basicAuth):
|
|
1066
|
-
* Api Key Authentication (cookieAuth):
|
|
1067
|
-
|
|
1068
|
-
```python
|
|
1069
|
-
import pulpcore.client.pulp_npm
|
|
1070
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
|
|
1071
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
1072
|
-
from pprint import pprint
|
|
1073
|
-
|
|
1074
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1075
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
1076
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1077
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1078
|
-
)
|
|
1079
|
-
|
|
1080
|
-
# The client must configure the authentication and authorization parameters
|
|
1081
|
-
# in accordance with the API server security policy.
|
|
1082
|
-
# Examples for each auth method are provided below, use the example that
|
|
1083
|
-
# satisfies your auth use case.
|
|
1084
|
-
|
|
1085
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1086
|
-
|
|
1087
|
-
# Configure HTTP basic authorization: basicAuth
|
|
1088
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1089
|
-
username = os.environ["USERNAME"],
|
|
1090
|
-
password = os.environ["PASSWORD"]
|
|
1091
|
-
)
|
|
1092
|
-
|
|
1093
|
-
# Configure API key authorization: cookieAuth
|
|
1094
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1095
|
-
|
|
1096
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1097
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1098
|
-
|
|
1099
|
-
# Enter a context with an instance of the API client
|
|
1100
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
1101
|
-
# Create an instance of the API class
|
|
1102
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
1103
|
-
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
|
|
1104
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1105
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
1106
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
1107
|
-
|
|
1108
|
-
try:
|
|
1109
|
-
# Inspect a npm distribution
|
|
1110
|
-
api_response = api_instance.read(npm_npm_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
1111
|
-
print("The response of DistributionsNpmApi->read:\n")
|
|
1112
|
-
pprint(api_response)
|
|
1113
|
-
except Exception as e:
|
|
1114
|
-
print("Exception when calling DistributionsNpmApi->read: %s\n" % e)
|
|
1115
|
-
```
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
### Parameters
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
Name | Type | Description | Notes
|
|
1123
|
-
------------- | ------------- | ------------- | -------------
|
|
1124
|
-
**npm_npm_distribution_href** | **str**| |
|
|
1125
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1126
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
1127
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
1128
|
-
|
|
1129
|
-
### Return type
|
|
1130
|
-
|
|
1131
|
-
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
|
|
1132
|
-
|
|
1133
|
-
### Authorization
|
|
1134
|
-
|
|
1135
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1136
|
-
|
|
1137
|
-
### HTTP request headers
|
|
1138
|
-
|
|
1139
|
-
- **Content-Type**: Not defined
|
|
1140
|
-
- **Accept**: application/json
|
|
1141
|
-
|
|
1142
|
-
### HTTP response details
|
|
1143
|
-
|
|
1144
|
-
| Status code | Description | Response headers |
|
|
1145
|
-
|-------------|-------------|------------------|
|
|
1146
|
-
**200** | | - |
|
|
1147
|
-
|
|
1148
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1149
|
-
|
|
1150
|
-
# **set_label**
|
|
1151
|
-
> SetLabelResponse set_label(npm_npm_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
1152
|
-
|
|
1153
|
-
Set a label
|
|
1154
|
-
|
|
1155
|
-
Set a single pulp_label on the object to a specific value or null.
|
|
1156
|
-
|
|
1157
|
-
### Example
|
|
1158
|
-
|
|
1159
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
1160
|
-
* Basic Authentication (basicAuth):
|
|
1161
|
-
* Api Key Authentication (cookieAuth):
|
|
1162
|
-
|
|
1163
|
-
```python
|
|
1164
|
-
import pulpcore.client.pulp_npm
|
|
1165
|
-
from pulpcore.client.pulp_npm.models.set_label import SetLabel
|
|
1166
|
-
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
|
|
1167
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
1168
|
-
from pprint import pprint
|
|
1169
|
-
|
|
1170
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1171
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
1172
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1173
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1174
|
-
)
|
|
1175
|
-
|
|
1176
|
-
# The client must configure the authentication and authorization parameters
|
|
1177
|
-
# in accordance with the API server security policy.
|
|
1178
|
-
# Examples for each auth method are provided below, use the example that
|
|
1179
|
-
# satisfies your auth use case.
|
|
1180
|
-
|
|
1181
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1182
|
-
|
|
1183
|
-
# Configure HTTP basic authorization: basicAuth
|
|
1184
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1185
|
-
username = os.environ["USERNAME"],
|
|
1186
|
-
password = os.environ["PASSWORD"]
|
|
1187
|
-
)
|
|
1188
|
-
|
|
1189
|
-
# Configure API key authorization: cookieAuth
|
|
1190
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1191
|
-
|
|
1192
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1193
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1194
|
-
|
|
1195
|
-
# Enter a context with an instance of the API client
|
|
1196
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
1197
|
-
# Create an instance of the API class
|
|
1198
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
1199
|
-
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
|
|
1200
|
-
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
|
|
1201
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1202
|
-
|
|
1203
|
-
try:
|
|
1204
|
-
# Set a label
|
|
1205
|
-
api_response = api_instance.set_label(npm_npm_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
1206
|
-
print("The response of DistributionsNpmApi->set_label:\n")
|
|
1207
|
-
pprint(api_response)
|
|
1208
|
-
except Exception as e:
|
|
1209
|
-
print("Exception when calling DistributionsNpmApi->set_label: %s\n" % e)
|
|
1210
|
-
```
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
### Parameters
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
Name | Type | Description | Notes
|
|
1218
|
-
------------- | ------------- | ------------- | -------------
|
|
1219
|
-
**npm_npm_distribution_href** | **str**| |
|
|
1220
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
|
1221
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1222
|
-
|
|
1223
|
-
### Return type
|
|
1224
|
-
|
|
1225
|
-
[**SetLabelResponse**](SetLabelResponse.md)
|
|
1226
|
-
|
|
1227
|
-
### Authorization
|
|
1228
|
-
|
|
1229
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1230
|
-
|
|
1231
|
-
### HTTP request headers
|
|
1232
|
-
|
|
1233
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1234
|
-
- **Accept**: application/json
|
|
1235
|
-
|
|
1236
|
-
### HTTP response details
|
|
1237
|
-
|
|
1238
|
-
| Status code | Description | Response headers |
|
|
1239
|
-
|-------------|-------------|------------------|
|
|
1240
|
-
**200** | | - |
|
|
1241
|
-
|
|
1242
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1243
|
-
|
|
1244
|
-
# **unset_label**
|
|
1245
|
-
> UnsetLabelResponse unset_label(npm_npm_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
1246
|
-
|
|
1247
|
-
Unset a label
|
|
1248
|
-
|
|
1249
|
-
Unset a single pulp_label on the object.
|
|
1250
|
-
|
|
1251
|
-
### Example
|
|
1252
|
-
|
|
1253
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
1254
|
-
* Basic Authentication (basicAuth):
|
|
1255
|
-
* Api Key Authentication (cookieAuth):
|
|
1256
|
-
|
|
1257
|
-
```python
|
|
1258
|
-
import pulpcore.client.pulp_npm
|
|
1259
|
-
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
|
|
1260
|
-
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
|
|
1261
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
1262
|
-
from pprint import pprint
|
|
1263
|
-
|
|
1264
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1265
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
1266
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1267
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1268
|
-
)
|
|
1269
|
-
|
|
1270
|
-
# The client must configure the authentication and authorization parameters
|
|
1271
|
-
# in accordance with the API server security policy.
|
|
1272
|
-
# Examples for each auth method are provided below, use the example that
|
|
1273
|
-
# satisfies your auth use case.
|
|
1274
|
-
|
|
1275
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1276
|
-
|
|
1277
|
-
# Configure HTTP basic authorization: basicAuth
|
|
1278
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1279
|
-
username = os.environ["USERNAME"],
|
|
1280
|
-
password = os.environ["PASSWORD"]
|
|
1281
|
-
)
|
|
1282
|
-
|
|
1283
|
-
# Configure API key authorization: cookieAuth
|
|
1284
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1285
|
-
|
|
1286
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1287
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1288
|
-
|
|
1289
|
-
# Enter a context with an instance of the API client
|
|
1290
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
1291
|
-
# Create an instance of the API class
|
|
1292
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
1293
|
-
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
|
|
1294
|
-
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
|
|
1295
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1296
|
-
|
|
1297
|
-
try:
|
|
1298
|
-
# Unset a label
|
|
1299
|
-
api_response = api_instance.unset_label(npm_npm_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
1300
|
-
print("The response of DistributionsNpmApi->unset_label:\n")
|
|
1301
|
-
pprint(api_response)
|
|
1302
|
-
except Exception as e:
|
|
1303
|
-
print("Exception when calling DistributionsNpmApi->unset_label: %s\n" % e)
|
|
1304
|
-
```
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
### Parameters
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
Name | Type | Description | Notes
|
|
1312
|
-
------------- | ------------- | ------------- | -------------
|
|
1313
|
-
**npm_npm_distribution_href** | **str**| |
|
|
1314
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
|
1315
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1316
|
-
|
|
1317
|
-
### Return type
|
|
1318
|
-
|
|
1319
|
-
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
|
1320
|
-
|
|
1321
|
-
### Authorization
|
|
1322
|
-
|
|
1323
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1324
|
-
|
|
1325
|
-
### HTTP request headers
|
|
1326
|
-
|
|
1327
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1328
|
-
- **Accept**: application/json
|
|
1329
|
-
|
|
1330
|
-
### HTTP response details
|
|
1331
|
-
|
|
1332
|
-
| Status code | Description | Response headers |
|
|
1333
|
-
|-------------|-------------|------------------|
|
|
1334
|
-
**200** | | - |
|
|
1335
|
-
|
|
1336
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1337
|
-
|
|
1338
|
-
# **update**
|
|
1339
|
-
> NpmNpmDistributionResponse update(npm_npm_distribution_href, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
|
|
1340
|
-
|
|
1341
|
-
Update a npm distribution
|
|
1342
|
-
|
|
1343
|
-
Update the entity and trigger an asynchronous task if necessary
|
|
1344
|
-
|
|
1345
|
-
### Example
|
|
1346
|
-
|
|
1347
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
1348
|
-
* Basic Authentication (basicAuth):
|
|
1349
|
-
* Api Key Authentication (cookieAuth):
|
|
1350
|
-
|
|
1351
|
-
```python
|
|
1352
|
-
import pulpcore.client.pulp_npm
|
|
1353
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution
|
|
1354
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
|
|
1355
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
1356
|
-
from pprint import pprint
|
|
1357
|
-
|
|
1358
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
1359
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
1360
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1361
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
1362
|
-
)
|
|
1363
|
-
|
|
1364
|
-
# The client must configure the authentication and authorization parameters
|
|
1365
|
-
# in accordance with the API server security policy.
|
|
1366
|
-
# Examples for each auth method are provided below, use the example that
|
|
1367
|
-
# satisfies your auth use case.
|
|
1368
|
-
|
|
1369
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
1370
|
-
|
|
1371
|
-
# Configure HTTP basic authorization: basicAuth
|
|
1372
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
1373
|
-
username = os.environ["USERNAME"],
|
|
1374
|
-
password = os.environ["PASSWORD"]
|
|
1375
|
-
)
|
|
1376
|
-
|
|
1377
|
-
# Configure API key authorization: cookieAuth
|
|
1378
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
1379
|
-
|
|
1380
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1381
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
1382
|
-
|
|
1383
|
-
# Enter a context with an instance of the API client
|
|
1384
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
1385
|
-
# Create an instance of the API class
|
|
1386
|
-
api_instance = pulpcore.client.pulp_npm.DistributionsNpmApi(api_client)
|
|
1387
|
-
npm_npm_distribution_href = 'npm_npm_distribution_href_example' # str |
|
|
1388
|
-
npm_npm_distribution = pulpcore.client.pulp_npm.NpmNpmDistribution() # NpmNpmDistribution |
|
|
1389
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
1390
|
-
|
|
1391
|
-
try:
|
|
1392
|
-
# Update a npm distribution
|
|
1393
|
-
api_response = api_instance.update(npm_npm_distribution_href, npm_npm_distribution, x_task_diagnostics=x_task_diagnostics)
|
|
1394
|
-
print("The response of DistributionsNpmApi->update:\n")
|
|
1395
|
-
pprint(api_response)
|
|
1396
|
-
except Exception as e:
|
|
1397
|
-
print("Exception when calling DistributionsNpmApi->update: %s\n" % e)
|
|
1398
|
-
```
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
### Parameters
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
Name | Type | Description | Notes
|
|
1406
|
-
------------- | ------------- | ------------- | -------------
|
|
1407
|
-
**npm_npm_distribution_href** | **str**| |
|
|
1408
|
-
**npm_npm_distribution** | [**NpmNpmDistribution**](NpmNpmDistribution.md)| |
|
|
1409
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
1410
|
-
|
|
1411
|
-
### Return type
|
|
1412
|
-
|
|
1413
|
-
[**NpmNpmDistributionResponse**](NpmNpmDistributionResponse.md)
|
|
1414
|
-
|
|
1415
|
-
### Authorization
|
|
1416
|
-
|
|
1417
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
1418
|
-
|
|
1419
|
-
### HTTP request headers
|
|
1420
|
-
|
|
1421
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
1422
|
-
- **Accept**: application/json
|
|
1423
|
-
|
|
1424
|
-
### HTTP response details
|
|
1425
|
-
|
|
1426
|
-
| Status code | Description | Response headers |
|
|
1427
|
-
|-------------|-------------|------------------|
|
|
1428
|
-
**200** | | - |
|
|
1429
|
-
**202** | | - |
|
|
1430
|
-
|
|
1431
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1432
|
-
|
|
1433
|
-
# NpmNpmDistribution
|
|
1434
|
-
|
|
1435
|
-
Serializer for NPM Distributions.
|
|
1436
|
-
|
|
1437
|
-
## Properties
|
|
1438
|
-
|
|
1439
|
-
Name | Type | Description | Notes
|
|
1440
|
-
------------ | ------------- | ------------- | -------------
|
|
1441
|
-
**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
|
1442
|
-
**content_guard** | **str** | An optional content-guard. | [optional]
|
|
1443
|
-
**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]
|
|
1444
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1445
|
-
**name** | **str** | A unique name. Ex, `rawhide` and `stable`. |
|
|
1446
|
-
**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
|
1447
|
-
**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
|
1448
|
-
|
|
1449
|
-
## Example
|
|
1450
|
-
|
|
1451
|
-
```python
|
|
1452
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution import NpmNpmDistribution
|
|
1453
|
-
|
|
1454
|
-
# TODO update the JSON string below
|
|
1455
|
-
json = "{}"
|
|
1456
|
-
# create an instance of NpmNpmDistribution from a JSON string
|
|
1457
|
-
npm_npm_distribution_instance = NpmNpmDistribution.from_json(json)
|
|
1458
|
-
# print the JSON string representation of the object
|
|
1459
|
-
print(NpmNpmDistribution.to_json())
|
|
1460
|
-
|
|
1461
|
-
# convert the object into a dict
|
|
1462
|
-
npm_npm_distribution_dict = npm_npm_distribution_instance.to_dict()
|
|
1463
|
-
# create an instance of NpmNpmDistribution from a dict
|
|
1464
|
-
npm_npm_distribution_from_dict = NpmNpmDistribution.from_dict(npm_npm_distribution_dict)
|
|
1465
|
-
```
|
|
1466
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
# NpmNpmDistributionResponse
|
|
1470
|
-
|
|
1471
|
-
Serializer for NPM Distributions.
|
|
1472
|
-
|
|
1473
|
-
## Properties
|
|
1474
|
-
|
|
1475
|
-
Name | Type | Description | Notes
|
|
1476
|
-
------------ | ------------- | ------------- | -------------
|
|
1477
|
-
**pulp_href** | **str** | | [optional] [readonly]
|
|
1478
|
-
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1479
|
-
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1480
|
-
**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]
|
|
1481
|
-
**base_path** | **str** | The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") |
|
|
1482
|
-
**base_url** | **str** | The URL for accessing the publication as defined by this distribution. | [optional] [readonly]
|
|
1483
|
-
**content_guard** | **str** | An optional content-guard. | [optional]
|
|
1484
|
-
**no_content_change_since** | **str** | Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes. | [optional] [readonly]
|
|
1485
|
-
**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]
|
|
1486
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1487
|
-
**name** | **str** | A unique name. Ex, `rawhide` and `stable`. |
|
|
1488
|
-
**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
|
1489
|
-
**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
|
1490
|
-
|
|
1491
|
-
## Example
|
|
1492
|
-
|
|
1493
|
-
```python
|
|
1494
|
-
from pulpcore.client.pulp_npm.models.npm_npm_distribution_response import NpmNpmDistributionResponse
|
|
1495
|
-
|
|
1496
|
-
# TODO update the JSON string below
|
|
1497
|
-
json = "{}"
|
|
1498
|
-
# create an instance of NpmNpmDistributionResponse from a JSON string
|
|
1499
|
-
npm_npm_distribution_response_instance = NpmNpmDistributionResponse.from_json(json)
|
|
1500
|
-
# print the JSON string representation of the object
|
|
1501
|
-
print(NpmNpmDistributionResponse.to_json())
|
|
1502
|
-
|
|
1503
|
-
# convert the object into a dict
|
|
1504
|
-
npm_npm_distribution_response_dict = npm_npm_distribution_response_instance.to_dict()
|
|
1505
|
-
# create an instance of NpmNpmDistributionResponse from a dict
|
|
1506
|
-
npm_npm_distribution_response_from_dict = NpmNpmDistributionResponse.from_dict(npm_npm_distribution_response_dict)
|
|
1507
|
-
```
|
|
1508
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
# NpmNpmRemote
|
|
1512
|
-
|
|
1513
|
-
A Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::
|
|
1514
|
-
|
|
1515
|
-
## Properties
|
|
1516
|
-
|
|
1517
|
-
Name | Type | Description | Notes
|
|
1518
|
-
------------ | ------------- | ------------- | -------------
|
|
1519
|
-
**name** | **str** | A unique name for this remote. |
|
|
1520
|
-
**url** | **str** | The URL of an external content source. |
|
|
1521
|
-
**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
|
1522
|
-
**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional]
|
|
1523
|
-
**client_key** | **str** | A PEM encoded private key used for authentication. | [optional]
|
|
1524
|
-
**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional]
|
|
1525
|
-
**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional]
|
|
1526
|
-
**proxy_username** | **str** | The username to authenticte to the proxy. | [optional]
|
|
1527
|
-
**proxy_password** | **str** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
|
|
1528
|
-
**username** | **str** | The username to be used for authentication when syncing. | [optional]
|
|
1529
|
-
**password** | **str** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
|
|
1530
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1531
|
-
**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
|
1532
|
-
**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
|
1533
|
-
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
|
|
1534
|
-
**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]
|
|
1535
|
-
**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]
|
|
1536
|
-
**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]
|
|
1537
|
-
**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]
|
|
1538
|
-
**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional]
|
|
1539
|
-
**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional]
|
|
1540
|
-
|
|
1541
|
-
## Example
|
|
1542
|
-
|
|
1543
|
-
```python
|
|
1544
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote
|
|
1545
|
-
|
|
1546
|
-
# TODO update the JSON string below
|
|
1547
|
-
json = "{}"
|
|
1548
|
-
# create an instance of NpmNpmRemote from a JSON string
|
|
1549
|
-
npm_npm_remote_instance = NpmNpmRemote.from_json(json)
|
|
1550
|
-
# print the JSON string representation of the object
|
|
1551
|
-
print(NpmNpmRemote.to_json())
|
|
1552
|
-
|
|
1553
|
-
# convert the object into a dict
|
|
1554
|
-
npm_npm_remote_dict = npm_npm_remote_instance.to_dict()
|
|
1555
|
-
# create an instance of NpmNpmRemote from a dict
|
|
1556
|
-
npm_npm_remote_from_dict = NpmNpmRemote.from_dict(npm_npm_remote_dict)
|
|
1557
|
-
```
|
|
1558
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
# NpmNpmRemoteResponseHiddenFieldsInner
|
|
1562
|
-
|
|
1563
|
-
|
|
1564
|
-
## Properties
|
|
1565
|
-
|
|
1566
|
-
Name | Type | Description | Notes
|
|
1567
|
-
------------ | ------------- | ------------- | -------------
|
|
1568
|
-
**name** | **str** | |
|
|
1569
|
-
**is_set** | **bool** | |
|
|
1570
|
-
|
|
1571
|
-
## Example
|
|
1572
|
-
|
|
1573
|
-
```python
|
|
1574
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote_response_hidden_fields_inner import NpmNpmRemoteResponseHiddenFieldsInner
|
|
1575
|
-
|
|
1576
|
-
# TODO update the JSON string below
|
|
1577
|
-
json = "{}"
|
|
1578
|
-
# create an instance of NpmNpmRemoteResponseHiddenFieldsInner from a JSON string
|
|
1579
|
-
npm_npm_remote_response_hidden_fields_inner_instance = NpmNpmRemoteResponseHiddenFieldsInner.from_json(json)
|
|
1580
|
-
# print the JSON string representation of the object
|
|
1581
|
-
print(NpmNpmRemoteResponseHiddenFieldsInner.to_json())
|
|
1582
|
-
|
|
1583
|
-
# convert the object into a dict
|
|
1584
|
-
npm_npm_remote_response_hidden_fields_inner_dict = npm_npm_remote_response_hidden_fields_inner_instance.to_dict()
|
|
1585
|
-
# create an instance of NpmNpmRemoteResponseHiddenFieldsInner from a dict
|
|
1586
|
-
npm_npm_remote_response_hidden_fields_inner_from_dict = NpmNpmRemoteResponseHiddenFieldsInner.from_dict(npm_npm_remote_response_hidden_fields_inner_dict)
|
|
1587
|
-
```
|
|
1588
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1589
|
-
|
|
1590
|
-
|
|
1591
|
-
# NpmNpmRemoteResponse
|
|
1592
|
-
|
|
1593
|
-
A Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::
|
|
1594
|
-
|
|
1595
|
-
## Properties
|
|
1596
|
-
|
|
1597
|
-
Name | Type | Description | Notes
|
|
1598
|
-
------------ | ------------- | ------------- | -------------
|
|
1599
|
-
**pulp_href** | **str** | | [optional] [readonly]
|
|
1600
|
-
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1601
|
-
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1602
|
-
**pulp_last_updated** | **datetime** | Timestamp of the most recent update of the remote. | [optional] [readonly]
|
|
1603
|
-
**name** | **str** | A unique name for this remote. |
|
|
1604
|
-
**url** | **str** | The URL of an external content source. |
|
|
1605
|
-
**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
|
1606
|
-
**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional]
|
|
1607
|
-
**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional]
|
|
1608
|
-
**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional]
|
|
1609
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1610
|
-
**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
|
1611
|
-
**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
|
1612
|
-
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
|
|
1613
|
-
**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]
|
|
1614
|
-
**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]
|
|
1615
|
-
**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]
|
|
1616
|
-
**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]
|
|
1617
|
-
**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional]
|
|
1618
|
-
**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional]
|
|
1619
|
-
**hidden_fields** | [**List[NpmNpmRemoteResponseHiddenFieldsInner]**](NpmNpmRemoteResponseHiddenFieldsInner.md) | List of hidden (write only) fields | [optional] [readonly]
|
|
1620
|
-
|
|
1621
|
-
## Example
|
|
1622
|
-
|
|
1623
|
-
```python
|
|
1624
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
|
|
1625
|
-
|
|
1626
|
-
# TODO update the JSON string below
|
|
1627
|
-
json = "{}"
|
|
1628
|
-
# create an instance of NpmNpmRemoteResponse from a JSON string
|
|
1629
|
-
npm_npm_remote_response_instance = NpmNpmRemoteResponse.from_json(json)
|
|
1630
|
-
# print the JSON string representation of the object
|
|
1631
|
-
print(NpmNpmRemoteResponse.to_json())
|
|
1632
|
-
|
|
1633
|
-
# convert the object into a dict
|
|
1634
|
-
npm_npm_remote_response_dict = npm_npm_remote_response_instance.to_dict()
|
|
1635
|
-
# create an instance of NpmNpmRemoteResponse from a dict
|
|
1636
|
-
npm_npm_remote_response_from_dict = NpmNpmRemoteResponse.from_dict(npm_npm_remote_response_dict)
|
|
1637
|
-
```
|
|
1638
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
# NpmNpmRepository
|
|
1642
|
-
|
|
1643
|
-
A Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]
|
|
1644
|
-
|
|
1645
|
-
## Properties
|
|
1646
|
-
|
|
1647
|
-
Name | Type | Description | Notes
|
|
1648
|
-
------------ | ------------- | ------------- | -------------
|
|
1649
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1650
|
-
**name** | **str** | A unique name for this repository. |
|
|
1651
|
-
**description** | **str** | An optional description. | [optional]
|
|
1652
|
-
**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
|
|
1653
|
-
**remote** | **str** | An optional remote to use by default when syncing. | [optional]
|
|
1654
|
-
|
|
1655
|
-
## Example
|
|
1656
|
-
|
|
1657
|
-
```python
|
|
1658
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository
|
|
1659
|
-
|
|
1660
|
-
# TODO update the JSON string below
|
|
1661
|
-
json = "{}"
|
|
1662
|
-
# create an instance of NpmNpmRepository from a JSON string
|
|
1663
|
-
npm_npm_repository_instance = NpmNpmRepository.from_json(json)
|
|
1664
|
-
# print the JSON string representation of the object
|
|
1665
|
-
print(NpmNpmRepository.to_json())
|
|
1666
|
-
|
|
1667
|
-
# convert the object into a dict
|
|
1668
|
-
npm_npm_repository_dict = npm_npm_repository_instance.to_dict()
|
|
1669
|
-
# create an instance of NpmNpmRepository from a dict
|
|
1670
|
-
npm_npm_repository_from_dict = NpmNpmRepository.from_dict(npm_npm_repository_dict)
|
|
1671
|
-
```
|
|
1672
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
# NpmNpmRepositoryResponse
|
|
1676
|
-
|
|
1677
|
-
A Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]
|
|
1678
|
-
|
|
1679
|
-
## Properties
|
|
1680
|
-
|
|
1681
|
-
Name | Type | Description | Notes
|
|
1682
|
-
------------ | ------------- | ------------- | -------------
|
|
1683
|
-
**pulp_href** | **str** | | [optional] [readonly]
|
|
1684
|
-
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1685
|
-
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1686
|
-
**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]
|
|
1687
|
-
**versions_href** | **str** | | [optional] [readonly]
|
|
1688
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1689
|
-
**latest_version_href** | **str** | | [optional] [readonly]
|
|
1690
|
-
**name** | **str** | A unique name for this repository. |
|
|
1691
|
-
**description** | **str** | An optional description. | [optional]
|
|
1692
|
-
**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
|
|
1693
|
-
**remote** | **str** | An optional remote to use by default when syncing. | [optional]
|
|
1694
|
-
|
|
1695
|
-
## Example
|
|
1696
|
-
|
|
1697
|
-
```python
|
|
1698
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
|
|
1699
|
-
|
|
1700
|
-
# TODO update the JSON string below
|
|
1701
|
-
json = "{}"
|
|
1702
|
-
# create an instance of NpmNpmRepositoryResponse from a JSON string
|
|
1703
|
-
npm_npm_repository_response_instance = NpmNpmRepositoryResponse.from_json(json)
|
|
1704
|
-
# print the JSON string representation of the object
|
|
1705
|
-
print(NpmNpmRepositoryResponse.to_json())
|
|
1706
|
-
|
|
1707
|
-
# convert the object into a dict
|
|
1708
|
-
npm_npm_repository_response_dict = npm_npm_repository_response_instance.to_dict()
|
|
1709
|
-
# create an instance of NpmNpmRepositoryResponse from a dict
|
|
1710
|
-
npm_npm_repository_response_from_dict = NpmNpmRepositoryResponse.from_dict(npm_npm_repository_response_dict)
|
|
1711
|
-
```
|
|
1712
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
# NpmPackageResponse
|
|
1716
|
-
|
|
1717
|
-
A Serializer for Package. Add serializers for the new fields defined in Package and add those fields to the Meta class keeping fields from the parent class as well. For example:: field1 = serializers.TextField() field2 = serializers.IntegerField() field3 = serializers.CharField() class Meta: fields = core_serializers.SingleArtifactContentSerializer.Meta.fields + ( 'field1', 'field2', 'field3' ) model = models.Package
|
|
1718
|
-
|
|
1719
|
-
## Properties
|
|
1720
|
-
|
|
1721
|
-
Name | Type | Description | Notes
|
|
1722
|
-
------------ | ------------- | ------------- | -------------
|
|
1723
|
-
**pulp_href** | **str** | | [optional] [readonly]
|
|
1724
|
-
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
1725
|
-
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
1726
|
-
**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]
|
|
1727
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional]
|
|
1728
|
-
**vuln_report** | **str** | | [optional] [readonly]
|
|
1729
|
-
**artifact** | **str** | Artifact file representing the physical content | [optional]
|
|
1730
|
-
**relative_path** | **str** | |
|
|
1731
|
-
**name** | **str** | |
|
|
1732
|
-
**version** | **str** | |
|
|
1733
|
-
|
|
1734
|
-
## Example
|
|
1735
|
-
|
|
1736
|
-
```python
|
|
1737
|
-
from pulpcore.client.pulp_npm.models.npm_package_response import NpmPackageResponse
|
|
1738
|
-
|
|
1739
|
-
# TODO update the JSON string below
|
|
1740
|
-
json = "{}"
|
|
1741
|
-
# create an instance of NpmPackageResponse from a JSON string
|
|
1742
|
-
npm_package_response_instance = NpmPackageResponse.from_json(json)
|
|
1743
|
-
# print the JSON string representation of the object
|
|
1744
|
-
print(NpmPackageResponse.to_json())
|
|
1745
|
-
|
|
1746
|
-
# convert the object into a dict
|
|
1747
|
-
npm_package_response_dict = npm_package_response_instance.to_dict()
|
|
1748
|
-
# create an instance of NpmPackageResponse from a dict
|
|
1749
|
-
npm_package_response_from_dict = NpmPackageResponse.from_dict(npm_package_response_dict)
|
|
1750
|
-
```
|
|
1751
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
# PaginatednpmNpmDistributionResponseList
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
## Properties
|
|
1758
|
-
|
|
1759
|
-
Name | Type | Description | Notes
|
|
1760
|
-
------------ | ------------- | ------------- | -------------
|
|
1761
|
-
**count** | **int** | |
|
|
1762
|
-
**next** | **str** | | [optional]
|
|
1763
|
-
**previous** | **str** | | [optional]
|
|
1764
|
-
**results** | [**List[NpmNpmDistributionResponse]**](NpmNpmDistributionResponse.md) | |
|
|
1765
|
-
|
|
1766
|
-
## Example
|
|
1767
|
-
|
|
1768
|
-
```python
|
|
1769
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_npm_distribution_response_list import PaginatednpmNpmDistributionResponseList
|
|
1770
|
-
|
|
1771
|
-
# TODO update the JSON string below
|
|
1772
|
-
json = "{}"
|
|
1773
|
-
# create an instance of PaginatednpmNpmDistributionResponseList from a JSON string
|
|
1774
|
-
paginatednpm_npm_distribution_response_list_instance = PaginatednpmNpmDistributionResponseList.from_json(json)
|
|
1775
|
-
# print the JSON string representation of the object
|
|
1776
|
-
print(PaginatednpmNpmDistributionResponseList.to_json())
|
|
1777
|
-
|
|
1778
|
-
# convert the object into a dict
|
|
1779
|
-
paginatednpm_npm_distribution_response_list_dict = paginatednpm_npm_distribution_response_list_instance.to_dict()
|
|
1780
|
-
# create an instance of PaginatednpmNpmDistributionResponseList from a dict
|
|
1781
|
-
paginatednpm_npm_distribution_response_list_from_dict = PaginatednpmNpmDistributionResponseList.from_dict(paginatednpm_npm_distribution_response_list_dict)
|
|
1782
|
-
```
|
|
1783
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
# PaginatednpmNpmRemoteResponseList
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
## Properties
|
|
1790
|
-
|
|
1791
|
-
Name | Type | Description | Notes
|
|
1792
|
-
------------ | ------------- | ------------- | -------------
|
|
1793
|
-
**count** | **int** | |
|
|
1794
|
-
**next** | **str** | | [optional]
|
|
1795
|
-
**previous** | **str** | | [optional]
|
|
1796
|
-
**results** | [**List[NpmNpmRemoteResponse]**](NpmNpmRemoteResponse.md) | |
|
|
1797
|
-
|
|
1798
|
-
## Example
|
|
1799
|
-
|
|
1800
|
-
```python
|
|
1801
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_npm_remote_response_list import PaginatednpmNpmRemoteResponseList
|
|
1802
|
-
|
|
1803
|
-
# TODO update the JSON string below
|
|
1804
|
-
json = "{}"
|
|
1805
|
-
# create an instance of PaginatednpmNpmRemoteResponseList from a JSON string
|
|
1806
|
-
paginatednpm_npm_remote_response_list_instance = PaginatednpmNpmRemoteResponseList.from_json(json)
|
|
1807
|
-
# print the JSON string representation of the object
|
|
1808
|
-
print(PaginatednpmNpmRemoteResponseList.to_json())
|
|
1809
|
-
|
|
1810
|
-
# convert the object into a dict
|
|
1811
|
-
paginatednpm_npm_remote_response_list_dict = paginatednpm_npm_remote_response_list_instance.to_dict()
|
|
1812
|
-
# create an instance of PaginatednpmNpmRemoteResponseList from a dict
|
|
1813
|
-
paginatednpm_npm_remote_response_list_from_dict = PaginatednpmNpmRemoteResponseList.from_dict(paginatednpm_npm_remote_response_list_dict)
|
|
1814
|
-
```
|
|
1815
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
# PaginatednpmNpmRepositoryResponseList
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
## Properties
|
|
1822
|
-
|
|
1823
|
-
Name | Type | Description | Notes
|
|
1824
|
-
------------ | ------------- | ------------- | -------------
|
|
1825
|
-
**count** | **int** | |
|
|
1826
|
-
**next** | **str** | | [optional]
|
|
1827
|
-
**previous** | **str** | | [optional]
|
|
1828
|
-
**results** | [**List[NpmNpmRepositoryResponse]**](NpmNpmRepositoryResponse.md) | |
|
|
1829
|
-
|
|
1830
|
-
## Example
|
|
1831
|
-
|
|
1832
|
-
```python
|
|
1833
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_npm_repository_response_list import PaginatednpmNpmRepositoryResponseList
|
|
1834
|
-
|
|
1835
|
-
# TODO update the JSON string below
|
|
1836
|
-
json = "{}"
|
|
1837
|
-
# create an instance of PaginatednpmNpmRepositoryResponseList from a JSON string
|
|
1838
|
-
paginatednpm_npm_repository_response_list_instance = PaginatednpmNpmRepositoryResponseList.from_json(json)
|
|
1839
|
-
# print the JSON string representation of the object
|
|
1840
|
-
print(PaginatednpmNpmRepositoryResponseList.to_json())
|
|
1841
|
-
|
|
1842
|
-
# convert the object into a dict
|
|
1843
|
-
paginatednpm_npm_repository_response_list_dict = paginatednpm_npm_repository_response_list_instance.to_dict()
|
|
1844
|
-
# create an instance of PaginatednpmNpmRepositoryResponseList from a dict
|
|
1845
|
-
paginatednpm_npm_repository_response_list_from_dict = PaginatednpmNpmRepositoryResponseList.from_dict(paginatednpm_npm_repository_response_list_dict)
|
|
1846
|
-
```
|
|
1847
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
# PaginatednpmPackageResponseList
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
## Properties
|
|
1854
|
-
|
|
1855
|
-
Name | Type | Description | Notes
|
|
1856
|
-
------------ | ------------- | ------------- | -------------
|
|
1857
|
-
**count** | **int** | |
|
|
1858
|
-
**next** | **str** | | [optional]
|
|
1859
|
-
**previous** | **str** | | [optional]
|
|
1860
|
-
**results** | [**List[NpmPackageResponse]**](NpmPackageResponse.md) | |
|
|
1861
|
-
|
|
1862
|
-
## Example
|
|
1863
|
-
|
|
1864
|
-
```python
|
|
1865
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_package_response_list import PaginatednpmPackageResponseList
|
|
1866
|
-
|
|
1867
|
-
# TODO update the JSON string below
|
|
1868
|
-
json = "{}"
|
|
1869
|
-
# create an instance of PaginatednpmPackageResponseList from a JSON string
|
|
1870
|
-
paginatednpm_package_response_list_instance = PaginatednpmPackageResponseList.from_json(json)
|
|
1871
|
-
# print the JSON string representation of the object
|
|
1872
|
-
print(PaginatednpmPackageResponseList.to_json())
|
|
1873
|
-
|
|
1874
|
-
# convert the object into a dict
|
|
1875
|
-
paginatednpm_package_response_list_dict = paginatednpm_package_response_list_instance.to_dict()
|
|
1876
|
-
# create an instance of PaginatednpmPackageResponseList from a dict
|
|
1877
|
-
paginatednpm_package_response_list_from_dict = PaginatednpmPackageResponseList.from_dict(paginatednpm_package_response_list_dict)
|
|
1878
|
-
```
|
|
1879
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
# PaginatedRepositoryVersionResponseList
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
## Properties
|
|
1886
|
-
|
|
1887
|
-
Name | Type | Description | Notes
|
|
1888
|
-
------------ | ------------- | ------------- | -------------
|
|
1889
|
-
**count** | **int** | |
|
|
1890
|
-
**next** | **str** | | [optional]
|
|
1891
|
-
**previous** | **str** | | [optional]
|
|
1892
|
-
**results** | [**List[RepositoryVersionResponse]**](RepositoryVersionResponse.md) | |
|
|
1893
|
-
|
|
1894
|
-
## Example
|
|
1895
|
-
|
|
1896
|
-
```python
|
|
1897
|
-
from pulpcore.client.pulp_npm.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
|
|
1898
|
-
|
|
1899
|
-
# TODO update the JSON string below
|
|
1900
|
-
json = "{}"
|
|
1901
|
-
# create an instance of PaginatedRepositoryVersionResponseList from a JSON string
|
|
1902
|
-
paginated_repository_version_response_list_instance = PaginatedRepositoryVersionResponseList.from_json(json)
|
|
1903
|
-
# print the JSON string representation of the object
|
|
1904
|
-
print(PaginatedRepositoryVersionResponseList.to_json())
|
|
1905
|
-
|
|
1906
|
-
# convert the object into a dict
|
|
1907
|
-
paginated_repository_version_response_list_dict = paginated_repository_version_response_list_instance.to_dict()
|
|
1908
|
-
# create an instance of PaginatedRepositoryVersionResponseList from a dict
|
|
1909
|
-
paginated_repository_version_response_list_from_dict = PaginatedRepositoryVersionResponseList.from_dict(paginated_repository_version_response_list_dict)
|
|
1910
|
-
```
|
|
1911
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
# PatchednpmNpmDistribution
|
|
1915
|
-
|
|
1916
|
-
Serializer for NPM Distributions.
|
|
1917
|
-
|
|
1918
|
-
## Properties
|
|
1919
|
-
|
|
1920
|
-
Name | Type | Description | Notes
|
|
1921
|
-
------------ | ------------- | ------------- | -------------
|
|
1922
|
-
**base_path** | **str** | 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]
|
|
1923
|
-
**content_guard** | **str** | An optional content-guard. | [optional]
|
|
1924
|
-
**hidden** | **bool** | Whether this distribution should be shown in the content app. | [optional] [default to False]
|
|
1925
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1926
|
-
**name** | **str** | A unique name. Ex, `rawhide` and `stable`. | [optional]
|
|
1927
|
-
**repository** | **str** | The latest RepositoryVersion for this Repository will be served. | [optional]
|
|
1928
|
-
**remote** | **str** | Remote that can be used to fetch content when using pull-through caching. | [optional]
|
|
1929
|
-
|
|
1930
|
-
## Example
|
|
1931
|
-
|
|
1932
|
-
```python
|
|
1933
|
-
from pulpcore.client.pulp_npm.models.patchednpm_npm_distribution import PatchednpmNpmDistribution
|
|
1934
|
-
|
|
1935
|
-
# TODO update the JSON string below
|
|
1936
|
-
json = "{}"
|
|
1937
|
-
# create an instance of PatchednpmNpmDistribution from a JSON string
|
|
1938
|
-
patchednpm_npm_distribution_instance = PatchednpmNpmDistribution.from_json(json)
|
|
1939
|
-
# print the JSON string representation of the object
|
|
1940
|
-
print(PatchednpmNpmDistribution.to_json())
|
|
1941
|
-
|
|
1942
|
-
# convert the object into a dict
|
|
1943
|
-
patchednpm_npm_distribution_dict = patchednpm_npm_distribution_instance.to_dict()
|
|
1944
|
-
# create an instance of PatchednpmNpmDistribution from a dict
|
|
1945
|
-
patchednpm_npm_distribution_from_dict = PatchednpmNpmDistribution.from_dict(patchednpm_npm_distribution_dict)
|
|
1946
|
-
```
|
|
1947
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1948
|
-
|
|
1949
|
-
|
|
1950
|
-
# PatchednpmNpmRemote
|
|
1951
|
-
|
|
1952
|
-
A Serializer for NpmRemote. Add any new fields if defined on NpmRemote. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RemoteSerializer.Meta.validators + [myValidator1, ...] By default the 'policy' field in core_serializers.RemoteSerializer only validates the choice 'immediate'. To add on-demand support for more 'policy' options, e.g. 'streamed' or 'on_demand', re-define the 'policy' option as follows::
|
|
1953
|
-
|
|
1954
|
-
## Properties
|
|
1955
|
-
|
|
1956
|
-
Name | Type | Description | Notes
|
|
1957
|
-
------------ | ------------- | ------------- | -------------
|
|
1958
|
-
**name** | **str** | A unique name for this remote. | [optional]
|
|
1959
|
-
**url** | **str** | The URL of an external content source. | [optional]
|
|
1960
|
-
**ca_cert** | **str** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional]
|
|
1961
|
-
**client_cert** | **str** | A PEM encoded client certificate used for authentication. | [optional]
|
|
1962
|
-
**client_key** | **str** | A PEM encoded private key used for authentication. | [optional]
|
|
1963
|
-
**tls_validation** | **bool** | If True, TLS peer validation must be performed. | [optional]
|
|
1964
|
-
**proxy_url** | **str** | The proxy URL. Format: scheme://host:port | [optional]
|
|
1965
|
-
**proxy_username** | **str** | The username to authenticte to the proxy. | [optional]
|
|
1966
|
-
**proxy_password** | **str** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional]
|
|
1967
|
-
**username** | **str** | The username to be used for authentication when syncing. | [optional]
|
|
1968
|
-
**password** | **str** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional]
|
|
1969
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
1970
|
-
**download_concurrency** | **int** | Total number of simultaneous connections. If not set then the default value will be used. | [optional]
|
|
1971
|
-
**max_retries** | **int** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional]
|
|
1972
|
-
**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'immediate' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional]
|
|
1973
|
-
**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]
|
|
1974
|
-
**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]
|
|
1975
|
-
**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]
|
|
1976
|
-
**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]
|
|
1977
|
-
**headers** | **List[object]** | Headers for aiohttp.Clientsession | [optional]
|
|
1978
|
-
**rate_limit** | **int** | Limits requests per second for each concurrent downloader | [optional]
|
|
1979
|
-
|
|
1980
|
-
## Example
|
|
1981
|
-
|
|
1982
|
-
```python
|
|
1983
|
-
from pulpcore.client.pulp_npm.models.patchednpm_npm_remote import PatchednpmNpmRemote
|
|
1984
|
-
|
|
1985
|
-
# TODO update the JSON string below
|
|
1986
|
-
json = "{}"
|
|
1987
|
-
# create an instance of PatchednpmNpmRemote from a JSON string
|
|
1988
|
-
patchednpm_npm_remote_instance = PatchednpmNpmRemote.from_json(json)
|
|
1989
|
-
# print the JSON string representation of the object
|
|
1990
|
-
print(PatchednpmNpmRemote.to_json())
|
|
1991
|
-
|
|
1992
|
-
# convert the object into a dict
|
|
1993
|
-
patchednpm_npm_remote_dict = patchednpm_npm_remote_instance.to_dict()
|
|
1994
|
-
# create an instance of PatchednpmNpmRemote from a dict
|
|
1995
|
-
patchednpm_npm_remote_from_dict = PatchednpmNpmRemote.from_dict(patchednpm_npm_remote_dict)
|
|
1996
|
-
```
|
|
1997
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
# PatchednpmNpmRepository
|
|
2001
|
-
|
|
2002
|
-
A Serializer for NpmRepository. Add any new fields if defined on NpmRepository. Similar to the example above, in PackageSerializer. Additional validators can be added to the parent validators list For example:: class Meta: validators = core_serializers.RepositorySerializer.Meta.validators + [myValidator1, ...]
|
|
2003
|
-
|
|
2004
|
-
## Properties
|
|
2005
|
-
|
|
2006
|
-
Name | Type | Description | Notes
|
|
2007
|
-
------------ | ------------- | ------------- | -------------
|
|
2008
|
-
**pulp_labels** | **Dict[str, Optional[str]]** | | [optional]
|
|
2009
|
-
**name** | **str** | A unique name for this repository. | [optional]
|
|
2010
|
-
**description** | **str** | An optional description. | [optional]
|
|
2011
|
-
**retain_repo_versions** | **int** | Retain X versions of the repository. Default is null which retains all versions. | [optional]
|
|
2012
|
-
**remote** | **str** | An optional remote to use by default when syncing. | [optional]
|
|
2013
|
-
|
|
2014
|
-
## Example
|
|
2015
|
-
|
|
2016
|
-
```python
|
|
2017
|
-
from pulpcore.client.pulp_npm.models.patchednpm_npm_repository import PatchednpmNpmRepository
|
|
2018
|
-
|
|
2019
|
-
# TODO update the JSON string below
|
|
2020
|
-
json = "{}"
|
|
2021
|
-
# create an instance of PatchednpmNpmRepository from a JSON string
|
|
2022
|
-
patchednpm_npm_repository_instance = PatchednpmNpmRepository.from_json(json)
|
|
2023
|
-
# print the JSON string representation of the object
|
|
2024
|
-
print(PatchednpmNpmRepository.to_json())
|
|
2025
|
-
|
|
2026
|
-
# convert the object into a dict
|
|
2027
|
-
patchednpm_npm_repository_dict = patchednpm_npm_repository_instance.to_dict()
|
|
2028
|
-
# create an instance of PatchednpmNpmRepository from a dict
|
|
2029
|
-
patchednpm_npm_repository_from_dict = PatchednpmNpmRepository.from_dict(patchednpm_npm_repository_dict)
|
|
2030
|
-
```
|
|
2031
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
# PolicyEnum
|
|
2035
|
-
|
|
2036
|
-
* `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.
|
|
2037
|
-
|
|
2038
|
-
## Enum
|
|
2039
|
-
|
|
2040
|
-
* `IMMEDIATE` (value: `'immediate'`)
|
|
2041
|
-
|
|
2042
|
-
* `ON_DEMAND` (value: `'on_demand'`)
|
|
2043
|
-
|
|
2044
|
-
* `STREAMED` (value: `'streamed'`)
|
|
2045
|
-
|
|
2046
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
# pulpcore.client.pulp_npm.RemotesNpmApi
|
|
2050
|
-
|
|
2051
|
-
All URIs are relative to *https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
2052
|
-
|
|
2053
|
-
Method | HTTP request | Description
|
|
2054
|
-
------------- | ------------- | -------------
|
|
2055
|
-
[**create**](RemotesNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/remotes/npm/npm/ | Create a npm remote
|
|
2056
|
-
[**delete**](RemotesNpmApi.md#delete) | **DELETE** {npm_npm_remote_href} | Delete a npm remote
|
|
2057
|
-
[**list**](RemotesNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/remotes/npm/npm/ | List npm remotes
|
|
2058
|
-
[**partial_update**](RemotesNpmApi.md#partial_update) | **PATCH** {npm_npm_remote_href} | Update a npm remote
|
|
2059
|
-
[**read**](RemotesNpmApi.md#read) | **GET** {npm_npm_remote_href} | Inspect a npm remote
|
|
2060
|
-
[**set_label**](RemotesNpmApi.md#set_label) | **POST** {npm_npm_remote_href}set_label/ | Set a label
|
|
2061
|
-
[**unset_label**](RemotesNpmApi.md#unset_label) | **POST** {npm_npm_remote_href}unset_label/ | Unset a label
|
|
2062
|
-
[**update**](RemotesNpmApi.md#update) | **PUT** {npm_npm_remote_href} | Update a npm remote
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
# **create**
|
|
2066
|
-
> NpmNpmRemoteResponse create(pulp_domain, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
|
|
2067
|
-
|
|
2068
|
-
Create a npm remote
|
|
2069
|
-
|
|
2070
|
-
A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
|
|
2071
|
-
|
|
2072
|
-
### Example
|
|
2073
|
-
|
|
2074
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2075
|
-
* Basic Authentication (basicAuth):
|
|
2076
|
-
* Api Key Authentication (cookieAuth):
|
|
2077
|
-
|
|
2078
|
-
```python
|
|
2079
|
-
import pulpcore.client.pulp_npm
|
|
2080
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote
|
|
2081
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
|
|
2082
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2083
|
-
from pprint import pprint
|
|
2084
|
-
|
|
2085
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2086
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2087
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2088
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2089
|
-
)
|
|
2090
|
-
|
|
2091
|
-
# The client must configure the authentication and authorization parameters
|
|
2092
|
-
# in accordance with the API server security policy.
|
|
2093
|
-
# Examples for each auth method are provided below, use the example that
|
|
2094
|
-
# satisfies your auth use case.
|
|
2095
|
-
|
|
2096
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2097
|
-
|
|
2098
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2099
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2100
|
-
username = os.environ["USERNAME"],
|
|
2101
|
-
password = os.environ["PASSWORD"]
|
|
2102
|
-
)
|
|
2103
|
-
|
|
2104
|
-
# Configure API key authorization: cookieAuth
|
|
2105
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2106
|
-
|
|
2107
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2108
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2109
|
-
|
|
2110
|
-
# Enter a context with an instance of the API client
|
|
2111
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2112
|
-
# Create an instance of the API class
|
|
2113
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2114
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
2115
|
-
npm_npm_remote = pulpcore.client.pulp_npm.NpmNpmRemote() # NpmNpmRemote |
|
|
2116
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2117
|
-
|
|
2118
|
-
try:
|
|
2119
|
-
# Create a npm remote
|
|
2120
|
-
api_response = api_instance.create(pulp_domain, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
|
|
2121
|
-
print("The response of RemotesNpmApi->create:\n")
|
|
2122
|
-
pprint(api_response)
|
|
2123
|
-
except Exception as e:
|
|
2124
|
-
print("Exception when calling RemotesNpmApi->create: %s\n" % e)
|
|
2125
|
-
```
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
### Parameters
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
Name | Type | Description | Notes
|
|
2133
|
-
------------- | ------------- | ------------- | -------------
|
|
2134
|
-
**pulp_domain** | **str**| |
|
|
2135
|
-
**npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
|
|
2136
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2137
|
-
|
|
2138
|
-
### Return type
|
|
2139
|
-
|
|
2140
|
-
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
|
|
2141
|
-
|
|
2142
|
-
### Authorization
|
|
2143
|
-
|
|
2144
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2145
|
-
|
|
2146
|
-
### HTTP request headers
|
|
2147
|
-
|
|
2148
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
2149
|
-
- **Accept**: application/json
|
|
2150
|
-
|
|
2151
|
-
### HTTP response details
|
|
2152
|
-
|
|
2153
|
-
| Status code | Description | Response headers |
|
|
2154
|
-
|-------------|-------------|------------------|
|
|
2155
|
-
**201** | | - |
|
|
2156
|
-
|
|
2157
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2158
|
-
|
|
2159
|
-
# **delete**
|
|
2160
|
-
> AsyncOperationResponse delete(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics)
|
|
2161
|
-
|
|
2162
|
-
Delete a npm remote
|
|
2163
|
-
|
|
2164
|
-
Trigger an asynchronous delete task
|
|
2165
|
-
|
|
2166
|
-
### Example
|
|
2167
|
-
|
|
2168
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2169
|
-
* Basic Authentication (basicAuth):
|
|
2170
|
-
* Api Key Authentication (cookieAuth):
|
|
2171
|
-
|
|
2172
|
-
```python
|
|
2173
|
-
import pulpcore.client.pulp_npm
|
|
2174
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
2175
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2176
|
-
from pprint import pprint
|
|
2177
|
-
|
|
2178
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2179
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2180
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2181
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2182
|
-
)
|
|
2183
|
-
|
|
2184
|
-
# The client must configure the authentication and authorization parameters
|
|
2185
|
-
# in accordance with the API server security policy.
|
|
2186
|
-
# Examples for each auth method are provided below, use the example that
|
|
2187
|
-
# satisfies your auth use case.
|
|
2188
|
-
|
|
2189
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2190
|
-
|
|
2191
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2192
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2193
|
-
username = os.environ["USERNAME"],
|
|
2194
|
-
password = os.environ["PASSWORD"]
|
|
2195
|
-
)
|
|
2196
|
-
|
|
2197
|
-
# Configure API key authorization: cookieAuth
|
|
2198
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2199
|
-
|
|
2200
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2201
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2202
|
-
|
|
2203
|
-
# Enter a context with an instance of the API client
|
|
2204
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2205
|
-
# Create an instance of the API class
|
|
2206
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2207
|
-
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
|
|
2208
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2209
|
-
|
|
2210
|
-
try:
|
|
2211
|
-
# Delete a npm remote
|
|
2212
|
-
api_response = api_instance.delete(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics)
|
|
2213
|
-
print("The response of RemotesNpmApi->delete:\n")
|
|
2214
|
-
pprint(api_response)
|
|
2215
|
-
except Exception as e:
|
|
2216
|
-
print("Exception when calling RemotesNpmApi->delete: %s\n" % e)
|
|
2217
|
-
```
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
### Parameters
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
Name | Type | Description | Notes
|
|
2225
|
-
------------- | ------------- | ------------- | -------------
|
|
2226
|
-
**npm_npm_remote_href** | **str**| |
|
|
2227
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2228
|
-
|
|
2229
|
-
### Return type
|
|
2230
|
-
|
|
2231
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
2232
|
-
|
|
2233
|
-
### Authorization
|
|
2234
|
-
|
|
2235
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2236
|
-
|
|
2237
|
-
### HTTP request headers
|
|
2238
|
-
|
|
2239
|
-
- **Content-Type**: Not defined
|
|
2240
|
-
- **Accept**: application/json
|
|
2241
|
-
|
|
2242
|
-
### HTTP response details
|
|
2243
|
-
|
|
2244
|
-
| Status code | Description | Response headers |
|
|
2245
|
-
|-------------|-------------|------------------|
|
|
2246
|
-
**202** | | - |
|
|
2247
|
-
|
|
2248
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2249
|
-
|
|
2250
|
-
# **list**
|
|
2251
|
-
> PaginatednpmNpmRemoteResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
|
|
2252
|
-
|
|
2253
|
-
List npm remotes
|
|
2254
|
-
|
|
2255
|
-
A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
|
|
2256
|
-
|
|
2257
|
-
### Example
|
|
2258
|
-
|
|
2259
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2260
|
-
* Basic Authentication (basicAuth):
|
|
2261
|
-
* Api Key Authentication (cookieAuth):
|
|
2262
|
-
|
|
2263
|
-
```python
|
|
2264
|
-
import pulpcore.client.pulp_npm
|
|
2265
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_npm_remote_response_list import PaginatednpmNpmRemoteResponseList
|
|
2266
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2267
|
-
from pprint import pprint
|
|
2268
|
-
|
|
2269
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2270
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2271
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2272
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2273
|
-
)
|
|
2274
|
-
|
|
2275
|
-
# The client must configure the authentication and authorization parameters
|
|
2276
|
-
# in accordance with the API server security policy.
|
|
2277
|
-
# Examples for each auth method are provided below, use the example that
|
|
2278
|
-
# satisfies your auth use case.
|
|
2279
|
-
|
|
2280
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2281
|
-
|
|
2282
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2283
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2284
|
-
username = os.environ["USERNAME"],
|
|
2285
|
-
password = os.environ["PASSWORD"]
|
|
2286
|
-
)
|
|
2287
|
-
|
|
2288
|
-
# Configure API key authorization: cookieAuth
|
|
2289
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2290
|
-
|
|
2291
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2292
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2293
|
-
|
|
2294
|
-
# Enter a context with an instance of the API client
|
|
2295
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2296
|
-
# Create an instance of the API class
|
|
2297
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2298
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
2299
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2300
|
-
limit = 56 # int | Number of results to return per page. (optional)
|
|
2301
|
-
name = 'name_example' # str | Filter results where name matches value (optional)
|
|
2302
|
-
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
|
|
2303
|
-
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
|
|
2304
|
-
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
|
|
2305
|
-
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
|
|
2306
|
-
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
|
|
2307
|
-
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
|
|
2308
|
-
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
|
|
2309
|
-
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
|
|
2310
|
-
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
2311
|
-
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
|
|
2312
|
-
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
2313
|
-
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
2314
|
-
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
2315
|
-
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
|
|
2316
|
-
pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)
|
|
2317
|
-
pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)
|
|
2318
|
-
pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)
|
|
2319
|
-
pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)
|
|
2320
|
-
pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)
|
|
2321
|
-
pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)
|
|
2322
|
-
pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)
|
|
2323
|
-
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
2324
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
2325
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
2326
|
-
|
|
2327
|
-
try:
|
|
2328
|
-
# List npm remotes
|
|
2329
|
-
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
|
|
2330
|
-
print("The response of RemotesNpmApi->list:\n")
|
|
2331
|
-
pprint(api_response)
|
|
2332
|
-
except Exception as e:
|
|
2333
|
-
print("Exception when calling RemotesNpmApi->list: %s\n" % e)
|
|
2334
|
-
```
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
### Parameters
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
Name | Type | Description | Notes
|
|
2342
|
-
------------- | ------------- | ------------- | -------------
|
|
2343
|
-
**pulp_domain** | **str**| |
|
|
2344
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2345
|
-
**limit** | **int**| Number of results to return per page. | [optional]
|
|
2346
|
-
**name** | **str**| Filter results where name matches value | [optional]
|
|
2347
|
-
**name__contains** | **str**| Filter results where name contains value | [optional]
|
|
2348
|
-
**name__icontains** | **str**| Filter results where name contains value | [optional]
|
|
2349
|
-
**name__iexact** | **str**| Filter results where name matches value | [optional]
|
|
2350
|
-
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
|
|
2351
|
-
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
|
|
2352
|
-
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
|
|
2353
|
-
**name__regex** | **str**| Filter results where name matches regex value | [optional]
|
|
2354
|
-
**name__startswith** | **str**| Filter results where name starts with value | [optional]
|
|
2355
|
-
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
2356
|
-
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
|
2357
|
-
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2358
|
-
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2359
|
-
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
2360
|
-
**pulp_label_select** | **str**| Filter labels by search string | [optional]
|
|
2361
|
-
**pulp_last_updated** | **datetime**| Filter results where pulp_last_updated matches value | [optional]
|
|
2362
|
-
**pulp_last_updated__gt** | **datetime**| Filter results where pulp_last_updated is greater than value | [optional]
|
|
2363
|
-
**pulp_last_updated__gte** | **datetime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
|
|
2364
|
-
**pulp_last_updated__isnull** | **bool**| Filter results where pulp_last_updated has a null value | [optional]
|
|
2365
|
-
**pulp_last_updated__lt** | **datetime**| Filter results where pulp_last_updated is less than value | [optional]
|
|
2366
|
-
**pulp_last_updated__lte** | **datetime**| Filter results where pulp_last_updated is less than or equal to value | [optional]
|
|
2367
|
-
**pulp_last_updated__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
|
|
2368
|
-
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
2369
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
2370
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
2371
|
-
|
|
2372
|
-
### Return type
|
|
2373
|
-
|
|
2374
|
-
[**PaginatednpmNpmRemoteResponseList**](PaginatednpmNpmRemoteResponseList.md)
|
|
2375
|
-
|
|
2376
|
-
### Authorization
|
|
2377
|
-
|
|
2378
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2379
|
-
|
|
2380
|
-
### HTTP request headers
|
|
2381
|
-
|
|
2382
|
-
- **Content-Type**: Not defined
|
|
2383
|
-
- **Accept**: application/json
|
|
2384
|
-
|
|
2385
|
-
### HTTP response details
|
|
2386
|
-
|
|
2387
|
-
| Status code | Description | Response headers |
|
|
2388
|
-
|-------------|-------------|------------------|
|
|
2389
|
-
**200** | | - |
|
|
2390
|
-
|
|
2391
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2392
|
-
|
|
2393
|
-
# **partial_update**
|
|
2394
|
-
> NpmNpmRemoteResponse partial_update(npm_npm_remote_href, patchednpm_npm_remote, x_task_diagnostics=x_task_diagnostics)
|
|
2395
|
-
|
|
2396
|
-
Update a npm remote
|
|
2397
|
-
|
|
2398
|
-
Update the entity partially and trigger an asynchronous task if necessary
|
|
2399
|
-
|
|
2400
|
-
### Example
|
|
2401
|
-
|
|
2402
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2403
|
-
* Basic Authentication (basicAuth):
|
|
2404
|
-
* Api Key Authentication (cookieAuth):
|
|
2405
|
-
|
|
2406
|
-
```python
|
|
2407
|
-
import pulpcore.client.pulp_npm
|
|
2408
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
|
|
2409
|
-
from pulpcore.client.pulp_npm.models.patchednpm_npm_remote import PatchednpmNpmRemote
|
|
2410
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2411
|
-
from pprint import pprint
|
|
2412
|
-
|
|
2413
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2414
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2415
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2416
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2417
|
-
)
|
|
2418
|
-
|
|
2419
|
-
# The client must configure the authentication and authorization parameters
|
|
2420
|
-
# in accordance with the API server security policy.
|
|
2421
|
-
# Examples for each auth method are provided below, use the example that
|
|
2422
|
-
# satisfies your auth use case.
|
|
2423
|
-
|
|
2424
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2425
|
-
|
|
2426
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2427
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2428
|
-
username = os.environ["USERNAME"],
|
|
2429
|
-
password = os.environ["PASSWORD"]
|
|
2430
|
-
)
|
|
2431
|
-
|
|
2432
|
-
# Configure API key authorization: cookieAuth
|
|
2433
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2434
|
-
|
|
2435
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2436
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2437
|
-
|
|
2438
|
-
# Enter a context with an instance of the API client
|
|
2439
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2440
|
-
# Create an instance of the API class
|
|
2441
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2442
|
-
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
|
|
2443
|
-
patchednpm_npm_remote = pulpcore.client.pulp_npm.PatchednpmNpmRemote() # PatchednpmNpmRemote |
|
|
2444
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2445
|
-
|
|
2446
|
-
try:
|
|
2447
|
-
# Update a npm remote
|
|
2448
|
-
api_response = api_instance.partial_update(npm_npm_remote_href, patchednpm_npm_remote, x_task_diagnostics=x_task_diagnostics)
|
|
2449
|
-
print("The response of RemotesNpmApi->partial_update:\n")
|
|
2450
|
-
pprint(api_response)
|
|
2451
|
-
except Exception as e:
|
|
2452
|
-
print("Exception when calling RemotesNpmApi->partial_update: %s\n" % e)
|
|
2453
|
-
```
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
### Parameters
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
Name | Type | Description | Notes
|
|
2461
|
-
------------- | ------------- | ------------- | -------------
|
|
2462
|
-
**npm_npm_remote_href** | **str**| |
|
|
2463
|
-
**patchednpm_npm_remote** | [**PatchednpmNpmRemote**](PatchednpmNpmRemote.md)| |
|
|
2464
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2465
|
-
|
|
2466
|
-
### Return type
|
|
2467
|
-
|
|
2468
|
-
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
|
|
2469
|
-
|
|
2470
|
-
### Authorization
|
|
2471
|
-
|
|
2472
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2473
|
-
|
|
2474
|
-
### HTTP request headers
|
|
2475
|
-
|
|
2476
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
2477
|
-
- **Accept**: application/json
|
|
2478
|
-
|
|
2479
|
-
### HTTP response details
|
|
2480
|
-
|
|
2481
|
-
| Status code | Description | Response headers |
|
|
2482
|
-
|-------------|-------------|------------------|
|
|
2483
|
-
**200** | | - |
|
|
2484
|
-
**202** | | - |
|
|
2485
|
-
|
|
2486
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2487
|
-
|
|
2488
|
-
# **read**
|
|
2489
|
-
> NpmNpmRemoteResponse read(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
2490
|
-
|
|
2491
|
-
Inspect a npm remote
|
|
2492
|
-
|
|
2493
|
-
A ViewSet for NpmRemote. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
|
|
2494
|
-
|
|
2495
|
-
### Example
|
|
2496
|
-
|
|
2497
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2498
|
-
* Basic Authentication (basicAuth):
|
|
2499
|
-
* Api Key Authentication (cookieAuth):
|
|
2500
|
-
|
|
2501
|
-
```python
|
|
2502
|
-
import pulpcore.client.pulp_npm
|
|
2503
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
|
|
2504
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2505
|
-
from pprint import pprint
|
|
2506
|
-
|
|
2507
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2508
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2509
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2510
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2511
|
-
)
|
|
2512
|
-
|
|
2513
|
-
# The client must configure the authentication and authorization parameters
|
|
2514
|
-
# in accordance with the API server security policy.
|
|
2515
|
-
# Examples for each auth method are provided below, use the example that
|
|
2516
|
-
# satisfies your auth use case.
|
|
2517
|
-
|
|
2518
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2519
|
-
|
|
2520
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2521
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2522
|
-
username = os.environ["USERNAME"],
|
|
2523
|
-
password = os.environ["PASSWORD"]
|
|
2524
|
-
)
|
|
2525
|
-
|
|
2526
|
-
# Configure API key authorization: cookieAuth
|
|
2527
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2528
|
-
|
|
2529
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2530
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2531
|
-
|
|
2532
|
-
# Enter a context with an instance of the API client
|
|
2533
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2534
|
-
# Create an instance of the API class
|
|
2535
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2536
|
-
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
|
|
2537
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2538
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
2539
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
2540
|
-
|
|
2541
|
-
try:
|
|
2542
|
-
# Inspect a npm remote
|
|
2543
|
-
api_response = api_instance.read(npm_npm_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
2544
|
-
print("The response of RemotesNpmApi->read:\n")
|
|
2545
|
-
pprint(api_response)
|
|
2546
|
-
except Exception as e:
|
|
2547
|
-
print("Exception when calling RemotesNpmApi->read: %s\n" % e)
|
|
2548
|
-
```
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
### Parameters
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
Name | Type | Description | Notes
|
|
2556
|
-
------------- | ------------- | ------------- | -------------
|
|
2557
|
-
**npm_npm_remote_href** | **str**| |
|
|
2558
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2559
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
2560
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
2561
|
-
|
|
2562
|
-
### Return type
|
|
2563
|
-
|
|
2564
|
-
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
|
|
2565
|
-
|
|
2566
|
-
### Authorization
|
|
2567
|
-
|
|
2568
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2569
|
-
|
|
2570
|
-
### HTTP request headers
|
|
2571
|
-
|
|
2572
|
-
- **Content-Type**: Not defined
|
|
2573
|
-
- **Accept**: application/json
|
|
2574
|
-
|
|
2575
|
-
### HTTP response details
|
|
2576
|
-
|
|
2577
|
-
| Status code | Description | Response headers |
|
|
2578
|
-
|-------------|-------------|------------------|
|
|
2579
|
-
**200** | | - |
|
|
2580
|
-
|
|
2581
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2582
|
-
|
|
2583
|
-
# **set_label**
|
|
2584
|
-
> SetLabelResponse set_label(npm_npm_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
2585
|
-
|
|
2586
|
-
Set a label
|
|
2587
|
-
|
|
2588
|
-
Set a single pulp_label on the object to a specific value or null.
|
|
2589
|
-
|
|
2590
|
-
### Example
|
|
2591
|
-
|
|
2592
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2593
|
-
* Basic Authentication (basicAuth):
|
|
2594
|
-
* Api Key Authentication (cookieAuth):
|
|
2595
|
-
|
|
2596
|
-
```python
|
|
2597
|
-
import pulpcore.client.pulp_npm
|
|
2598
|
-
from pulpcore.client.pulp_npm.models.set_label import SetLabel
|
|
2599
|
-
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
|
|
2600
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2601
|
-
from pprint import pprint
|
|
2602
|
-
|
|
2603
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2604
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2605
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2606
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2607
|
-
)
|
|
2608
|
-
|
|
2609
|
-
# The client must configure the authentication and authorization parameters
|
|
2610
|
-
# in accordance with the API server security policy.
|
|
2611
|
-
# Examples for each auth method are provided below, use the example that
|
|
2612
|
-
# satisfies your auth use case.
|
|
2613
|
-
|
|
2614
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2615
|
-
|
|
2616
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2617
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2618
|
-
username = os.environ["USERNAME"],
|
|
2619
|
-
password = os.environ["PASSWORD"]
|
|
2620
|
-
)
|
|
2621
|
-
|
|
2622
|
-
# Configure API key authorization: cookieAuth
|
|
2623
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2624
|
-
|
|
2625
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2626
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2627
|
-
|
|
2628
|
-
# Enter a context with an instance of the API client
|
|
2629
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2630
|
-
# Create an instance of the API class
|
|
2631
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2632
|
-
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
|
|
2633
|
-
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
|
|
2634
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2635
|
-
|
|
2636
|
-
try:
|
|
2637
|
-
# Set a label
|
|
2638
|
-
api_response = api_instance.set_label(npm_npm_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
2639
|
-
print("The response of RemotesNpmApi->set_label:\n")
|
|
2640
|
-
pprint(api_response)
|
|
2641
|
-
except Exception as e:
|
|
2642
|
-
print("Exception when calling RemotesNpmApi->set_label: %s\n" % e)
|
|
2643
|
-
```
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
### Parameters
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
Name | Type | Description | Notes
|
|
2651
|
-
------------- | ------------- | ------------- | -------------
|
|
2652
|
-
**npm_npm_remote_href** | **str**| |
|
|
2653
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
|
2654
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2655
|
-
|
|
2656
|
-
### Return type
|
|
2657
|
-
|
|
2658
|
-
[**SetLabelResponse**](SetLabelResponse.md)
|
|
2659
|
-
|
|
2660
|
-
### Authorization
|
|
2661
|
-
|
|
2662
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2663
|
-
|
|
2664
|
-
### HTTP request headers
|
|
2665
|
-
|
|
2666
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
2667
|
-
- **Accept**: application/json
|
|
2668
|
-
|
|
2669
|
-
### HTTP response details
|
|
2670
|
-
|
|
2671
|
-
| Status code | Description | Response headers |
|
|
2672
|
-
|-------------|-------------|------------------|
|
|
2673
|
-
**201** | | - |
|
|
2674
|
-
|
|
2675
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2676
|
-
|
|
2677
|
-
# **unset_label**
|
|
2678
|
-
> UnsetLabelResponse unset_label(npm_npm_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
2679
|
-
|
|
2680
|
-
Unset a label
|
|
2681
|
-
|
|
2682
|
-
Unset a single pulp_label on the object.
|
|
2683
|
-
|
|
2684
|
-
### Example
|
|
2685
|
-
|
|
2686
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2687
|
-
* Basic Authentication (basicAuth):
|
|
2688
|
-
* Api Key Authentication (cookieAuth):
|
|
2689
|
-
|
|
2690
|
-
```python
|
|
2691
|
-
import pulpcore.client.pulp_npm
|
|
2692
|
-
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
|
|
2693
|
-
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
|
|
2694
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2695
|
-
from pprint import pprint
|
|
2696
|
-
|
|
2697
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2698
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2699
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2700
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2701
|
-
)
|
|
2702
|
-
|
|
2703
|
-
# The client must configure the authentication and authorization parameters
|
|
2704
|
-
# in accordance with the API server security policy.
|
|
2705
|
-
# Examples for each auth method are provided below, use the example that
|
|
2706
|
-
# satisfies your auth use case.
|
|
2707
|
-
|
|
2708
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2709
|
-
|
|
2710
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2711
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2712
|
-
username = os.environ["USERNAME"],
|
|
2713
|
-
password = os.environ["PASSWORD"]
|
|
2714
|
-
)
|
|
2715
|
-
|
|
2716
|
-
# Configure API key authorization: cookieAuth
|
|
2717
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2718
|
-
|
|
2719
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2720
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2721
|
-
|
|
2722
|
-
# Enter a context with an instance of the API client
|
|
2723
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2724
|
-
# Create an instance of the API class
|
|
2725
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2726
|
-
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
|
|
2727
|
-
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
|
|
2728
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2729
|
-
|
|
2730
|
-
try:
|
|
2731
|
-
# Unset a label
|
|
2732
|
-
api_response = api_instance.unset_label(npm_npm_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
2733
|
-
print("The response of RemotesNpmApi->unset_label:\n")
|
|
2734
|
-
pprint(api_response)
|
|
2735
|
-
except Exception as e:
|
|
2736
|
-
print("Exception when calling RemotesNpmApi->unset_label: %s\n" % e)
|
|
2737
|
-
```
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
### Parameters
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
Name | Type | Description | Notes
|
|
2745
|
-
------------- | ------------- | ------------- | -------------
|
|
2746
|
-
**npm_npm_remote_href** | **str**| |
|
|
2747
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
|
2748
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2749
|
-
|
|
2750
|
-
### Return type
|
|
2751
|
-
|
|
2752
|
-
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
|
2753
|
-
|
|
2754
|
-
### Authorization
|
|
2755
|
-
|
|
2756
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2757
|
-
|
|
2758
|
-
### HTTP request headers
|
|
2759
|
-
|
|
2760
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
2761
|
-
- **Accept**: application/json
|
|
2762
|
-
|
|
2763
|
-
### HTTP response details
|
|
2764
|
-
|
|
2765
|
-
| Status code | Description | Response headers |
|
|
2766
|
-
|-------------|-------------|------------------|
|
|
2767
|
-
**201** | | - |
|
|
2768
|
-
|
|
2769
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2770
|
-
|
|
2771
|
-
# **update**
|
|
2772
|
-
> NpmNpmRemoteResponse update(npm_npm_remote_href, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
|
|
2773
|
-
|
|
2774
|
-
Update a npm remote
|
|
2775
|
-
|
|
2776
|
-
Update the entity and trigger an asynchronous task if necessary
|
|
2777
|
-
|
|
2778
|
-
### Example
|
|
2779
|
-
|
|
2780
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2781
|
-
* Basic Authentication (basicAuth):
|
|
2782
|
-
* Api Key Authentication (cookieAuth):
|
|
2783
|
-
|
|
2784
|
-
```python
|
|
2785
|
-
import pulpcore.client.pulp_npm
|
|
2786
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote import NpmNpmRemote
|
|
2787
|
-
from pulpcore.client.pulp_npm.models.npm_npm_remote_response import NpmNpmRemoteResponse
|
|
2788
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2789
|
-
from pprint import pprint
|
|
2790
|
-
|
|
2791
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2792
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2793
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2794
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2795
|
-
)
|
|
2796
|
-
|
|
2797
|
-
# The client must configure the authentication and authorization parameters
|
|
2798
|
-
# in accordance with the API server security policy.
|
|
2799
|
-
# Examples for each auth method are provided below, use the example that
|
|
2800
|
-
# satisfies your auth use case.
|
|
2801
|
-
|
|
2802
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2803
|
-
|
|
2804
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2805
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2806
|
-
username = os.environ["USERNAME"],
|
|
2807
|
-
password = os.environ["PASSWORD"]
|
|
2808
|
-
)
|
|
2809
|
-
|
|
2810
|
-
# Configure API key authorization: cookieAuth
|
|
2811
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2812
|
-
|
|
2813
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2814
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2815
|
-
|
|
2816
|
-
# Enter a context with an instance of the API client
|
|
2817
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2818
|
-
# Create an instance of the API class
|
|
2819
|
-
api_instance = pulpcore.client.pulp_npm.RemotesNpmApi(api_client)
|
|
2820
|
-
npm_npm_remote_href = 'npm_npm_remote_href_example' # str |
|
|
2821
|
-
npm_npm_remote = pulpcore.client.pulp_npm.NpmNpmRemote() # NpmNpmRemote |
|
|
2822
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2823
|
-
|
|
2824
|
-
try:
|
|
2825
|
-
# Update a npm remote
|
|
2826
|
-
api_response = api_instance.update(npm_npm_remote_href, npm_npm_remote, x_task_diagnostics=x_task_diagnostics)
|
|
2827
|
-
print("The response of RemotesNpmApi->update:\n")
|
|
2828
|
-
pprint(api_response)
|
|
2829
|
-
except Exception as e:
|
|
2830
|
-
print("Exception when calling RemotesNpmApi->update: %s\n" % e)
|
|
2831
|
-
```
|
|
2832
|
-
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
### Parameters
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
Name | Type | Description | Notes
|
|
2839
|
-
------------- | ------------- | ------------- | -------------
|
|
2840
|
-
**npm_npm_remote_href** | **str**| |
|
|
2841
|
-
**npm_npm_remote** | [**NpmNpmRemote**](NpmNpmRemote.md)| |
|
|
2842
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2843
|
-
|
|
2844
|
-
### Return type
|
|
2845
|
-
|
|
2846
|
-
[**NpmNpmRemoteResponse**](NpmNpmRemoteResponse.md)
|
|
2847
|
-
|
|
2848
|
-
### Authorization
|
|
2849
|
-
|
|
2850
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2851
|
-
|
|
2852
|
-
### HTTP request headers
|
|
2853
|
-
|
|
2854
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
2855
|
-
- **Accept**: application/json
|
|
2856
|
-
|
|
2857
|
-
### HTTP response details
|
|
2858
|
-
|
|
2859
|
-
| Status code | Description | Response headers |
|
|
2860
|
-
|-------------|-------------|------------------|
|
|
2861
|
-
**200** | | - |
|
|
2862
|
-
**202** | | - |
|
|
2863
|
-
|
|
2864
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
2865
|
-
|
|
2866
|
-
# Repair
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
## Properties
|
|
2870
|
-
|
|
2871
|
-
Name | Type | Description | Notes
|
|
2872
|
-
------------ | ------------- | ------------- | -------------
|
|
2873
|
-
**verify_checksums** | **bool** | Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default | [optional] [default to True]
|
|
2874
|
-
|
|
2875
|
-
## Example
|
|
2876
|
-
|
|
2877
|
-
```python
|
|
2878
|
-
from pulpcore.client.pulp_npm.models.repair import Repair
|
|
2879
|
-
|
|
2880
|
-
# TODO update the JSON string below
|
|
2881
|
-
json = "{}"
|
|
2882
|
-
# create an instance of Repair from a JSON string
|
|
2883
|
-
repair_instance = Repair.from_json(json)
|
|
2884
|
-
# print the JSON string representation of the object
|
|
2885
|
-
print(Repair.to_json())
|
|
2886
|
-
|
|
2887
|
-
# convert the object into a dict
|
|
2888
|
-
repair_dict = repair_instance.to_dict()
|
|
2889
|
-
# create an instance of Repair from a dict
|
|
2890
|
-
repair_from_dict = Repair.from_dict(repair_dict)
|
|
2891
|
-
```
|
|
2892
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
# pulpcore.client.pulp_npm.RepositoriesNpmApi
|
|
2896
|
-
|
|
2897
|
-
All URIs are relative to *https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
2898
|
-
|
|
2899
|
-
Method | HTTP request | Description
|
|
2900
|
-
------------- | ------------- | -------------
|
|
2901
|
-
[**create**](RepositoriesNpmApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/repositories/npm/npm/ | Create a npm repository
|
|
2902
|
-
[**delete**](RepositoriesNpmApi.md#delete) | **DELETE** {npm_npm_repository_href} | Delete a npm repository
|
|
2903
|
-
[**list**](RepositoriesNpmApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/repositories/npm/npm/ | List npm repositorys
|
|
2904
|
-
[**modify**](RepositoriesNpmApi.md#modify) | **POST** {npm_npm_repository_href}modify/ | Modify Repository Content
|
|
2905
|
-
[**partial_update**](RepositoriesNpmApi.md#partial_update) | **PATCH** {npm_npm_repository_href} | Update a npm repository
|
|
2906
|
-
[**read**](RepositoriesNpmApi.md#read) | **GET** {npm_npm_repository_href} | Inspect a npm repository
|
|
2907
|
-
[**set_label**](RepositoriesNpmApi.md#set_label) | **POST** {npm_npm_repository_href}set_label/ | Set a label
|
|
2908
|
-
[**sync**](RepositoriesNpmApi.md#sync) | **POST** {npm_npm_repository_href}sync/ | Sync from remote
|
|
2909
|
-
[**unset_label**](RepositoriesNpmApi.md#unset_label) | **POST** {npm_npm_repository_href}unset_label/ | Unset a label
|
|
2910
|
-
[**update**](RepositoriesNpmApi.md#update) | **PUT** {npm_npm_repository_href} | Update a npm repository
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
# **create**
|
|
2914
|
-
> NpmNpmRepositoryResponse create(pulp_domain, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
|
|
2915
|
-
|
|
2916
|
-
Create a npm repository
|
|
2917
|
-
|
|
2918
|
-
A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
|
|
2919
|
-
|
|
2920
|
-
### Example
|
|
2921
|
-
|
|
2922
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
2923
|
-
* Basic Authentication (basicAuth):
|
|
2924
|
-
* Api Key Authentication (cookieAuth):
|
|
2925
|
-
|
|
2926
|
-
```python
|
|
2927
|
-
import pulpcore.client.pulp_npm
|
|
2928
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository
|
|
2929
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
|
|
2930
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
2931
|
-
from pprint import pprint
|
|
2932
|
-
|
|
2933
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
2934
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
2935
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2936
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
2937
|
-
)
|
|
2938
|
-
|
|
2939
|
-
# The client must configure the authentication and authorization parameters
|
|
2940
|
-
# in accordance with the API server security policy.
|
|
2941
|
-
# Examples for each auth method are provided below, use the example that
|
|
2942
|
-
# satisfies your auth use case.
|
|
2943
|
-
|
|
2944
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
2945
|
-
|
|
2946
|
-
# Configure HTTP basic authorization: basicAuth
|
|
2947
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
2948
|
-
username = os.environ["USERNAME"],
|
|
2949
|
-
password = os.environ["PASSWORD"]
|
|
2950
|
-
)
|
|
2951
|
-
|
|
2952
|
-
# Configure API key authorization: cookieAuth
|
|
2953
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
2954
|
-
|
|
2955
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
2956
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
2957
|
-
|
|
2958
|
-
# Enter a context with an instance of the API client
|
|
2959
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
2960
|
-
# Create an instance of the API class
|
|
2961
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
2962
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
2963
|
-
npm_npm_repository = pulpcore.client.pulp_npm.NpmNpmRepository() # NpmNpmRepository |
|
|
2964
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
2965
|
-
|
|
2966
|
-
try:
|
|
2967
|
-
# Create a npm repository
|
|
2968
|
-
api_response = api_instance.create(pulp_domain, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
|
|
2969
|
-
print("The response of RepositoriesNpmApi->create:\n")
|
|
2970
|
-
pprint(api_response)
|
|
2971
|
-
except Exception as e:
|
|
2972
|
-
print("Exception when calling RepositoriesNpmApi->create: %s\n" % e)
|
|
2973
|
-
```
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
### Parameters
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
Name | Type | Description | Notes
|
|
2981
|
-
------------- | ------------- | ------------- | -------------
|
|
2982
|
-
**pulp_domain** | **str**| |
|
|
2983
|
-
**npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| |
|
|
2984
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
2985
|
-
|
|
2986
|
-
### Return type
|
|
2987
|
-
|
|
2988
|
-
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
|
|
2989
|
-
|
|
2990
|
-
### Authorization
|
|
2991
|
-
|
|
2992
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
2993
|
-
|
|
2994
|
-
### HTTP request headers
|
|
2995
|
-
|
|
2996
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
2997
|
-
- **Accept**: application/json
|
|
2998
|
-
|
|
2999
|
-
### HTTP response details
|
|
3000
|
-
|
|
3001
|
-
| Status code | Description | Response headers |
|
|
3002
|
-
|-------------|-------------|------------------|
|
|
3003
|
-
**201** | | - |
|
|
3004
|
-
|
|
3005
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3006
|
-
|
|
3007
|
-
# **delete**
|
|
3008
|
-
> AsyncOperationResponse delete(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics)
|
|
3009
|
-
|
|
3010
|
-
Delete a npm repository
|
|
3011
|
-
|
|
3012
|
-
Trigger an asynchronous delete task
|
|
3013
|
-
|
|
3014
|
-
### Example
|
|
3015
|
-
|
|
3016
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3017
|
-
* Basic Authentication (basicAuth):
|
|
3018
|
-
* Api Key Authentication (cookieAuth):
|
|
3019
|
-
|
|
3020
|
-
```python
|
|
3021
|
-
import pulpcore.client.pulp_npm
|
|
3022
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
3023
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3024
|
-
from pprint import pprint
|
|
3025
|
-
|
|
3026
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3027
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3028
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3029
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3030
|
-
)
|
|
3031
|
-
|
|
3032
|
-
# The client must configure the authentication and authorization parameters
|
|
3033
|
-
# in accordance with the API server security policy.
|
|
3034
|
-
# Examples for each auth method are provided below, use the example that
|
|
3035
|
-
# satisfies your auth use case.
|
|
3036
|
-
|
|
3037
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3038
|
-
|
|
3039
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3040
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3041
|
-
username = os.environ["USERNAME"],
|
|
3042
|
-
password = os.environ["PASSWORD"]
|
|
3043
|
-
)
|
|
3044
|
-
|
|
3045
|
-
# Configure API key authorization: cookieAuth
|
|
3046
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3047
|
-
|
|
3048
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3049
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3050
|
-
|
|
3051
|
-
# Enter a context with an instance of the API client
|
|
3052
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3053
|
-
# Create an instance of the API class
|
|
3054
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3055
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3056
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3057
|
-
|
|
3058
|
-
try:
|
|
3059
|
-
# Delete a npm repository
|
|
3060
|
-
api_response = api_instance.delete(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics)
|
|
3061
|
-
print("The response of RepositoriesNpmApi->delete:\n")
|
|
3062
|
-
pprint(api_response)
|
|
3063
|
-
except Exception as e:
|
|
3064
|
-
print("Exception when calling RepositoriesNpmApi->delete: %s\n" % e)
|
|
3065
|
-
```
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
### Parameters
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
Name | Type | Description | Notes
|
|
3073
|
-
------------- | ------------- | ------------- | -------------
|
|
3074
|
-
**npm_npm_repository_href** | **str**| |
|
|
3075
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3076
|
-
|
|
3077
|
-
### Return type
|
|
3078
|
-
|
|
3079
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
3080
|
-
|
|
3081
|
-
### Authorization
|
|
3082
|
-
|
|
3083
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3084
|
-
|
|
3085
|
-
### HTTP request headers
|
|
3086
|
-
|
|
3087
|
-
- **Content-Type**: Not defined
|
|
3088
|
-
- **Accept**: application/json
|
|
3089
|
-
|
|
3090
|
-
### HTTP response details
|
|
3091
|
-
|
|
3092
|
-
| Status code | Description | Response headers |
|
|
3093
|
-
|-------------|-------------|------------------|
|
|
3094
|
-
**202** | | - |
|
|
3095
|
-
|
|
3096
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3097
|
-
|
|
3098
|
-
# **list**
|
|
3099
|
-
> PaginatednpmNpmRepositoryResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
|
|
3100
|
-
|
|
3101
|
-
List npm repositorys
|
|
3102
|
-
|
|
3103
|
-
A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
|
|
3104
|
-
|
|
3105
|
-
### Example
|
|
3106
|
-
|
|
3107
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3108
|
-
* Basic Authentication (basicAuth):
|
|
3109
|
-
* Api Key Authentication (cookieAuth):
|
|
3110
|
-
|
|
3111
|
-
```python
|
|
3112
|
-
import pulpcore.client.pulp_npm
|
|
3113
|
-
from pulpcore.client.pulp_npm.models.paginatednpm_npm_repository_response_list import PaginatednpmNpmRepositoryResponseList
|
|
3114
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3115
|
-
from pprint import pprint
|
|
3116
|
-
|
|
3117
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3118
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3119
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3120
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3121
|
-
)
|
|
3122
|
-
|
|
3123
|
-
# The client must configure the authentication and authorization parameters
|
|
3124
|
-
# in accordance with the API server security policy.
|
|
3125
|
-
# Examples for each auth method are provided below, use the example that
|
|
3126
|
-
# satisfies your auth use case.
|
|
3127
|
-
|
|
3128
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3129
|
-
|
|
3130
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3131
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3132
|
-
username = os.environ["USERNAME"],
|
|
3133
|
-
password = os.environ["PASSWORD"]
|
|
3134
|
-
)
|
|
3135
|
-
|
|
3136
|
-
# Configure API key authorization: cookieAuth
|
|
3137
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3138
|
-
|
|
3139
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3140
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3141
|
-
|
|
3142
|
-
# Enter a context with an instance of the API client
|
|
3143
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3144
|
-
# Create an instance of the API class
|
|
3145
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3146
|
-
pulp_domain = 'pulp_domain_example' # str |
|
|
3147
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3148
|
-
latest_with_content = 'latest_with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
|
|
3149
|
-
limit = 56 # int | Number of results to return per page. (optional)
|
|
3150
|
-
name = 'name_example' # str | Filter results where name matches value (optional)
|
|
3151
|
-
name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
|
|
3152
|
-
name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
|
|
3153
|
-
name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
|
|
3154
|
-
name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
|
|
3155
|
-
name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
|
|
3156
|
-
name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
|
|
3157
|
-
name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
|
|
3158
|
-
name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
|
|
3159
|
-
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
3160
|
-
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
|
|
3161
|
-
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
3162
|
-
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
3163
|
-
pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
3164
|
-
pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
|
|
3165
|
-
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
3166
|
-
remote = 'remote_example' # str | Foreign Key referenced by HREF (optional)
|
|
3167
|
-
retain_repo_versions = 56 # int | Filter results where retain_repo_versions matches value (optional)
|
|
3168
|
-
retain_repo_versions__gt = 56 # int | Filter results where retain_repo_versions is greater than value (optional)
|
|
3169
|
-
retain_repo_versions__gte = 56 # int | Filter results where retain_repo_versions is greater than or equal to value (optional)
|
|
3170
|
-
retain_repo_versions__isnull = True # bool | Filter results where retain_repo_versions has a null value (optional)
|
|
3171
|
-
retain_repo_versions__lt = 56 # int | Filter results where retain_repo_versions is less than value (optional)
|
|
3172
|
-
retain_repo_versions__lte = 56 # int | Filter results where retain_repo_versions is less than or equal to value (optional)
|
|
3173
|
-
retain_repo_versions__ne = 56 # int | Filter results where retain_repo_versions not equal to value (optional)
|
|
3174
|
-
retain_repo_versions__range = [56] # List[int] | Filter results where retain_repo_versions is between two comma separated values (optional)
|
|
3175
|
-
with_content = 'with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
|
|
3176
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
3177
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
3178
|
-
|
|
3179
|
-
try:
|
|
3180
|
-
# List npm repositorys
|
|
3181
|
-
api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
|
|
3182
|
-
print("The response of RepositoriesNpmApi->list:\n")
|
|
3183
|
-
pprint(api_response)
|
|
3184
|
-
except Exception as e:
|
|
3185
|
-
print("Exception when calling RepositoriesNpmApi->list: %s\n" % e)
|
|
3186
|
-
```
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
### Parameters
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
Name | Type | Description | Notes
|
|
3194
|
-
------------- | ------------- | ------------- | -------------
|
|
3195
|
-
**pulp_domain** | **str**| |
|
|
3196
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3197
|
-
**latest_with_content** | **str**| Content Unit referenced by HREF/PRN | [optional]
|
|
3198
|
-
**limit** | **int**| Number of results to return per page. | [optional]
|
|
3199
|
-
**name** | **str**| Filter results where name matches value | [optional]
|
|
3200
|
-
**name__contains** | **str**| Filter results where name contains value | [optional]
|
|
3201
|
-
**name__icontains** | **str**| Filter results where name contains value | [optional]
|
|
3202
|
-
**name__iexact** | **str**| Filter results where name matches value | [optional]
|
|
3203
|
-
**name__in** | [**List[str]**](str.md)| Filter results where name is in a comma-separated list of values | [optional]
|
|
3204
|
-
**name__iregex** | **str**| Filter results where name matches regex value | [optional]
|
|
3205
|
-
**name__istartswith** | **str**| Filter results where name starts with value | [optional]
|
|
3206
|
-
**name__regex** | **str**| Filter results where name matches regex value | [optional]
|
|
3207
|
-
**name__startswith** | **str**| Filter results where name starts with value | [optional]
|
|
3208
|
-
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
3209
|
-
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
|
3210
|
-
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
3211
|
-
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
3212
|
-
**pulp_id__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
3213
|
-
**pulp_label_select** | **str**| Filter labels by search string | [optional]
|
|
3214
|
-
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
3215
|
-
**remote** | **str**| Foreign Key referenced by HREF | [optional]
|
|
3216
|
-
**retain_repo_versions** | **int**| Filter results where retain_repo_versions matches value | [optional]
|
|
3217
|
-
**retain_repo_versions__gt** | **int**| Filter results where retain_repo_versions is greater than value | [optional]
|
|
3218
|
-
**retain_repo_versions__gte** | **int**| Filter results where retain_repo_versions is greater than or equal to value | [optional]
|
|
3219
|
-
**retain_repo_versions__isnull** | **bool**| Filter results where retain_repo_versions has a null value | [optional]
|
|
3220
|
-
**retain_repo_versions__lt** | **int**| Filter results where retain_repo_versions is less than value | [optional]
|
|
3221
|
-
**retain_repo_versions__lte** | **int**| Filter results where retain_repo_versions is less than or equal to value | [optional]
|
|
3222
|
-
**retain_repo_versions__ne** | **int**| Filter results where retain_repo_versions not equal to value | [optional]
|
|
3223
|
-
**retain_repo_versions__range** | [**List[int]**](int.md)| Filter results where retain_repo_versions is between two comma separated values | [optional]
|
|
3224
|
-
**with_content** | **str**| Content Unit referenced by HREF/PRN | [optional]
|
|
3225
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
3226
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
3227
|
-
|
|
3228
|
-
### Return type
|
|
3229
|
-
|
|
3230
|
-
[**PaginatednpmNpmRepositoryResponseList**](PaginatednpmNpmRepositoryResponseList.md)
|
|
3231
|
-
|
|
3232
|
-
### Authorization
|
|
3233
|
-
|
|
3234
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3235
|
-
|
|
3236
|
-
### HTTP request headers
|
|
3237
|
-
|
|
3238
|
-
- **Content-Type**: Not defined
|
|
3239
|
-
- **Accept**: application/json
|
|
3240
|
-
|
|
3241
|
-
### HTTP response details
|
|
3242
|
-
|
|
3243
|
-
| Status code | Description | Response headers |
|
|
3244
|
-
|-------------|-------------|------------------|
|
|
3245
|
-
**200** | | - |
|
|
3246
|
-
|
|
3247
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3248
|
-
|
|
3249
|
-
# **modify**
|
|
3250
|
-
> AsyncOperationResponse modify(npm_npm_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
|
|
3251
|
-
|
|
3252
|
-
Modify Repository Content
|
|
3253
|
-
|
|
3254
|
-
Trigger an asynchronous task to create a new repository version.
|
|
3255
|
-
|
|
3256
|
-
### Example
|
|
3257
|
-
|
|
3258
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3259
|
-
* Basic Authentication (basicAuth):
|
|
3260
|
-
* Api Key Authentication (cookieAuth):
|
|
3261
|
-
|
|
3262
|
-
```python
|
|
3263
|
-
import pulpcore.client.pulp_npm
|
|
3264
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
3265
|
-
from pulpcore.client.pulp_npm.models.repository_add_remove_content import RepositoryAddRemoveContent
|
|
3266
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3267
|
-
from pprint import pprint
|
|
3268
|
-
|
|
3269
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3270
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3271
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3272
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3273
|
-
)
|
|
3274
|
-
|
|
3275
|
-
# The client must configure the authentication and authorization parameters
|
|
3276
|
-
# in accordance with the API server security policy.
|
|
3277
|
-
# Examples for each auth method are provided below, use the example that
|
|
3278
|
-
# satisfies your auth use case.
|
|
3279
|
-
|
|
3280
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3281
|
-
|
|
3282
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3283
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3284
|
-
username = os.environ["USERNAME"],
|
|
3285
|
-
password = os.environ["PASSWORD"]
|
|
3286
|
-
)
|
|
3287
|
-
|
|
3288
|
-
# Configure API key authorization: cookieAuth
|
|
3289
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3290
|
-
|
|
3291
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3292
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3293
|
-
|
|
3294
|
-
# Enter a context with an instance of the API client
|
|
3295
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3296
|
-
# Create an instance of the API class
|
|
3297
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3298
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3299
|
-
repository_add_remove_content = pulpcore.client.pulp_npm.RepositoryAddRemoveContent() # RepositoryAddRemoveContent |
|
|
3300
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3301
|
-
|
|
3302
|
-
try:
|
|
3303
|
-
# Modify Repository Content
|
|
3304
|
-
api_response = api_instance.modify(npm_npm_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
|
|
3305
|
-
print("The response of RepositoriesNpmApi->modify:\n")
|
|
3306
|
-
pprint(api_response)
|
|
3307
|
-
except Exception as e:
|
|
3308
|
-
print("Exception when calling RepositoriesNpmApi->modify: %s\n" % e)
|
|
3309
|
-
```
|
|
3310
|
-
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
### Parameters
|
|
3314
|
-
|
|
3315
|
-
|
|
3316
|
-
Name | Type | Description | Notes
|
|
3317
|
-
------------- | ------------- | ------------- | -------------
|
|
3318
|
-
**npm_npm_repository_href** | **str**| |
|
|
3319
|
-
**repository_add_remove_content** | [**RepositoryAddRemoveContent**](RepositoryAddRemoveContent.md)| |
|
|
3320
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3321
|
-
|
|
3322
|
-
### Return type
|
|
3323
|
-
|
|
3324
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
3325
|
-
|
|
3326
|
-
### Authorization
|
|
3327
|
-
|
|
3328
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3329
|
-
|
|
3330
|
-
### HTTP request headers
|
|
3331
|
-
|
|
3332
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
3333
|
-
- **Accept**: application/json
|
|
3334
|
-
|
|
3335
|
-
### HTTP response details
|
|
3336
|
-
|
|
3337
|
-
| Status code | Description | Response headers |
|
|
3338
|
-
|-------------|-------------|------------------|
|
|
3339
|
-
**202** | | - |
|
|
3340
|
-
|
|
3341
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3342
|
-
|
|
3343
|
-
# **partial_update**
|
|
3344
|
-
> NpmNpmRepositoryResponse partial_update(npm_npm_repository_href, patchednpm_npm_repository, x_task_diagnostics=x_task_diagnostics)
|
|
3345
|
-
|
|
3346
|
-
Update a npm repository
|
|
3347
|
-
|
|
3348
|
-
Update the entity partially and trigger an asynchronous task if necessary
|
|
3349
|
-
|
|
3350
|
-
### Example
|
|
3351
|
-
|
|
3352
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3353
|
-
* Basic Authentication (basicAuth):
|
|
3354
|
-
* Api Key Authentication (cookieAuth):
|
|
3355
|
-
|
|
3356
|
-
```python
|
|
3357
|
-
import pulpcore.client.pulp_npm
|
|
3358
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
|
|
3359
|
-
from pulpcore.client.pulp_npm.models.patchednpm_npm_repository import PatchednpmNpmRepository
|
|
3360
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3361
|
-
from pprint import pprint
|
|
3362
|
-
|
|
3363
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3364
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3365
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3366
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3367
|
-
)
|
|
3368
|
-
|
|
3369
|
-
# The client must configure the authentication and authorization parameters
|
|
3370
|
-
# in accordance with the API server security policy.
|
|
3371
|
-
# Examples for each auth method are provided below, use the example that
|
|
3372
|
-
# satisfies your auth use case.
|
|
3373
|
-
|
|
3374
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3375
|
-
|
|
3376
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3377
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3378
|
-
username = os.environ["USERNAME"],
|
|
3379
|
-
password = os.environ["PASSWORD"]
|
|
3380
|
-
)
|
|
3381
|
-
|
|
3382
|
-
# Configure API key authorization: cookieAuth
|
|
3383
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3384
|
-
|
|
3385
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3386
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3387
|
-
|
|
3388
|
-
# Enter a context with an instance of the API client
|
|
3389
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3390
|
-
# Create an instance of the API class
|
|
3391
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3392
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3393
|
-
patchednpm_npm_repository = pulpcore.client.pulp_npm.PatchednpmNpmRepository() # PatchednpmNpmRepository |
|
|
3394
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3395
|
-
|
|
3396
|
-
try:
|
|
3397
|
-
# Update a npm repository
|
|
3398
|
-
api_response = api_instance.partial_update(npm_npm_repository_href, patchednpm_npm_repository, x_task_diagnostics=x_task_diagnostics)
|
|
3399
|
-
print("The response of RepositoriesNpmApi->partial_update:\n")
|
|
3400
|
-
pprint(api_response)
|
|
3401
|
-
except Exception as e:
|
|
3402
|
-
print("Exception when calling RepositoriesNpmApi->partial_update: %s\n" % e)
|
|
3403
|
-
```
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
### Parameters
|
|
3408
|
-
|
|
3409
|
-
|
|
3410
|
-
Name | Type | Description | Notes
|
|
3411
|
-
------------- | ------------- | ------------- | -------------
|
|
3412
|
-
**npm_npm_repository_href** | **str**| |
|
|
3413
|
-
**patchednpm_npm_repository** | [**PatchednpmNpmRepository**](PatchednpmNpmRepository.md)| |
|
|
3414
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3415
|
-
|
|
3416
|
-
### Return type
|
|
3417
|
-
|
|
3418
|
-
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
|
|
3419
|
-
|
|
3420
|
-
### Authorization
|
|
3421
|
-
|
|
3422
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3423
|
-
|
|
3424
|
-
### HTTP request headers
|
|
3425
|
-
|
|
3426
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
3427
|
-
- **Accept**: application/json
|
|
3428
|
-
|
|
3429
|
-
### HTTP response details
|
|
3430
|
-
|
|
3431
|
-
| Status code | Description | Response headers |
|
|
3432
|
-
|-------------|-------------|------------------|
|
|
3433
|
-
**200** | | - |
|
|
3434
|
-
**202** | | - |
|
|
3435
|
-
|
|
3436
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3437
|
-
|
|
3438
|
-
# **read**
|
|
3439
|
-
> NpmNpmRepositoryResponse read(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
3440
|
-
|
|
3441
|
-
Inspect a npm repository
|
|
3442
|
-
|
|
3443
|
-
A ViewSet for NpmRepository. Similar to the PackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
|
|
3444
|
-
|
|
3445
|
-
### Example
|
|
3446
|
-
|
|
3447
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3448
|
-
* Basic Authentication (basicAuth):
|
|
3449
|
-
* Api Key Authentication (cookieAuth):
|
|
3450
|
-
|
|
3451
|
-
```python
|
|
3452
|
-
import pulpcore.client.pulp_npm
|
|
3453
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
|
|
3454
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3455
|
-
from pprint import pprint
|
|
3456
|
-
|
|
3457
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3458
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3459
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3460
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3461
|
-
)
|
|
3462
|
-
|
|
3463
|
-
# The client must configure the authentication and authorization parameters
|
|
3464
|
-
# in accordance with the API server security policy.
|
|
3465
|
-
# Examples for each auth method are provided below, use the example that
|
|
3466
|
-
# satisfies your auth use case.
|
|
3467
|
-
|
|
3468
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3469
|
-
|
|
3470
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3471
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3472
|
-
username = os.environ["USERNAME"],
|
|
3473
|
-
password = os.environ["PASSWORD"]
|
|
3474
|
-
)
|
|
3475
|
-
|
|
3476
|
-
# Configure API key authorization: cookieAuth
|
|
3477
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3478
|
-
|
|
3479
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3480
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3481
|
-
|
|
3482
|
-
# Enter a context with an instance of the API client
|
|
3483
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3484
|
-
# Create an instance of the API class
|
|
3485
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3486
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3487
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3488
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
3489
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
3490
|
-
|
|
3491
|
-
try:
|
|
3492
|
-
# Inspect a npm repository
|
|
3493
|
-
api_response = api_instance.read(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
3494
|
-
print("The response of RepositoriesNpmApi->read:\n")
|
|
3495
|
-
pprint(api_response)
|
|
3496
|
-
except Exception as e:
|
|
3497
|
-
print("Exception when calling RepositoriesNpmApi->read: %s\n" % e)
|
|
3498
|
-
```
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
### Parameters
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
Name | Type | Description | Notes
|
|
3506
|
-
------------- | ------------- | ------------- | -------------
|
|
3507
|
-
**npm_npm_repository_href** | **str**| |
|
|
3508
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3509
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
3510
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
3511
|
-
|
|
3512
|
-
### Return type
|
|
3513
|
-
|
|
3514
|
-
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
|
|
3515
|
-
|
|
3516
|
-
### Authorization
|
|
3517
|
-
|
|
3518
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3519
|
-
|
|
3520
|
-
### HTTP request headers
|
|
3521
|
-
|
|
3522
|
-
- **Content-Type**: Not defined
|
|
3523
|
-
- **Accept**: application/json
|
|
3524
|
-
|
|
3525
|
-
### HTTP response details
|
|
3526
|
-
|
|
3527
|
-
| Status code | Description | Response headers |
|
|
3528
|
-
|-------------|-------------|------------------|
|
|
3529
|
-
**200** | | - |
|
|
3530
|
-
|
|
3531
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3532
|
-
|
|
3533
|
-
# **set_label**
|
|
3534
|
-
> SetLabelResponse set_label(npm_npm_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
3535
|
-
|
|
3536
|
-
Set a label
|
|
3537
|
-
|
|
3538
|
-
Set a single pulp_label on the object to a specific value or null.
|
|
3539
|
-
|
|
3540
|
-
### Example
|
|
3541
|
-
|
|
3542
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3543
|
-
* Basic Authentication (basicAuth):
|
|
3544
|
-
* Api Key Authentication (cookieAuth):
|
|
3545
|
-
|
|
3546
|
-
```python
|
|
3547
|
-
import pulpcore.client.pulp_npm
|
|
3548
|
-
from pulpcore.client.pulp_npm.models.set_label import SetLabel
|
|
3549
|
-
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
|
|
3550
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3551
|
-
from pprint import pprint
|
|
3552
|
-
|
|
3553
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3554
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3555
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3556
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3557
|
-
)
|
|
3558
|
-
|
|
3559
|
-
# The client must configure the authentication and authorization parameters
|
|
3560
|
-
# in accordance with the API server security policy.
|
|
3561
|
-
# Examples for each auth method are provided below, use the example that
|
|
3562
|
-
# satisfies your auth use case.
|
|
3563
|
-
|
|
3564
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3565
|
-
|
|
3566
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3567
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3568
|
-
username = os.environ["USERNAME"],
|
|
3569
|
-
password = os.environ["PASSWORD"]
|
|
3570
|
-
)
|
|
3571
|
-
|
|
3572
|
-
# Configure API key authorization: cookieAuth
|
|
3573
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3574
|
-
|
|
3575
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3576
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3577
|
-
|
|
3578
|
-
# Enter a context with an instance of the API client
|
|
3579
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3580
|
-
# Create an instance of the API class
|
|
3581
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3582
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3583
|
-
set_label = pulpcore.client.pulp_npm.SetLabel() # SetLabel |
|
|
3584
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3585
|
-
|
|
3586
|
-
try:
|
|
3587
|
-
# Set a label
|
|
3588
|
-
api_response = api_instance.set_label(npm_npm_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
|
|
3589
|
-
print("The response of RepositoriesNpmApi->set_label:\n")
|
|
3590
|
-
pprint(api_response)
|
|
3591
|
-
except Exception as e:
|
|
3592
|
-
print("Exception when calling RepositoriesNpmApi->set_label: %s\n" % e)
|
|
3593
|
-
```
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
|
|
3597
|
-
### Parameters
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
Name | Type | Description | Notes
|
|
3601
|
-
------------- | ------------- | ------------- | -------------
|
|
3602
|
-
**npm_npm_repository_href** | **str**| |
|
|
3603
|
-
**set_label** | [**SetLabel**](SetLabel.md)| |
|
|
3604
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3605
|
-
|
|
3606
|
-
### Return type
|
|
3607
|
-
|
|
3608
|
-
[**SetLabelResponse**](SetLabelResponse.md)
|
|
3609
|
-
|
|
3610
|
-
### Authorization
|
|
3611
|
-
|
|
3612
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3613
|
-
|
|
3614
|
-
### HTTP request headers
|
|
3615
|
-
|
|
3616
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
3617
|
-
- **Accept**: application/json
|
|
3618
|
-
|
|
3619
|
-
### HTTP response details
|
|
3620
|
-
|
|
3621
|
-
| Status code | Description | Response headers |
|
|
3622
|
-
|-------------|-------------|------------------|
|
|
3623
|
-
**201** | | - |
|
|
3624
|
-
|
|
3625
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3626
|
-
|
|
3627
|
-
# **sync**
|
|
3628
|
-
> AsyncOperationResponse sync(npm_npm_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
|
|
3629
|
-
|
|
3630
|
-
Sync from remote
|
|
3631
|
-
|
|
3632
|
-
Trigger an asynchronous task to sync content.
|
|
3633
|
-
|
|
3634
|
-
### Example
|
|
3635
|
-
|
|
3636
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3637
|
-
* Basic Authentication (basicAuth):
|
|
3638
|
-
* Api Key Authentication (cookieAuth):
|
|
3639
|
-
|
|
3640
|
-
```python
|
|
3641
|
-
import pulpcore.client.pulp_npm
|
|
3642
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
3643
|
-
from pulpcore.client.pulp_npm.models.repository_sync_url import RepositorySyncURL
|
|
3644
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3645
|
-
from pprint import pprint
|
|
3646
|
-
|
|
3647
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3648
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3649
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3650
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3651
|
-
)
|
|
3652
|
-
|
|
3653
|
-
# The client must configure the authentication and authorization parameters
|
|
3654
|
-
# in accordance with the API server security policy.
|
|
3655
|
-
# Examples for each auth method are provided below, use the example that
|
|
3656
|
-
# satisfies your auth use case.
|
|
3657
|
-
|
|
3658
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3659
|
-
|
|
3660
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3661
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3662
|
-
username = os.environ["USERNAME"],
|
|
3663
|
-
password = os.environ["PASSWORD"]
|
|
3664
|
-
)
|
|
3665
|
-
|
|
3666
|
-
# Configure API key authorization: cookieAuth
|
|
3667
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3668
|
-
|
|
3669
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3670
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3671
|
-
|
|
3672
|
-
# Enter a context with an instance of the API client
|
|
3673
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3674
|
-
# Create an instance of the API class
|
|
3675
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3676
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3677
|
-
repository_sync_url = pulpcore.client.pulp_npm.RepositorySyncURL() # RepositorySyncURL |
|
|
3678
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3679
|
-
|
|
3680
|
-
try:
|
|
3681
|
-
# Sync from remote
|
|
3682
|
-
api_response = api_instance.sync(npm_npm_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
|
|
3683
|
-
print("The response of RepositoriesNpmApi->sync:\n")
|
|
3684
|
-
pprint(api_response)
|
|
3685
|
-
except Exception as e:
|
|
3686
|
-
print("Exception when calling RepositoriesNpmApi->sync: %s\n" % e)
|
|
3687
|
-
```
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
### Parameters
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
Name | Type | Description | Notes
|
|
3695
|
-
------------- | ------------- | ------------- | -------------
|
|
3696
|
-
**npm_npm_repository_href** | **str**| |
|
|
3697
|
-
**repository_sync_url** | [**RepositorySyncURL**](RepositorySyncURL.md)| |
|
|
3698
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3699
|
-
|
|
3700
|
-
### Return type
|
|
3701
|
-
|
|
3702
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
3703
|
-
|
|
3704
|
-
### Authorization
|
|
3705
|
-
|
|
3706
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3707
|
-
|
|
3708
|
-
### HTTP request headers
|
|
3709
|
-
|
|
3710
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
3711
|
-
- **Accept**: application/json
|
|
3712
|
-
|
|
3713
|
-
### HTTP response details
|
|
3714
|
-
|
|
3715
|
-
| Status code | Description | Response headers |
|
|
3716
|
-
|-------------|-------------|------------------|
|
|
3717
|
-
**202** | | - |
|
|
3718
|
-
|
|
3719
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3720
|
-
|
|
3721
|
-
# **unset_label**
|
|
3722
|
-
> UnsetLabelResponse unset_label(npm_npm_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
3723
|
-
|
|
3724
|
-
Unset a label
|
|
3725
|
-
|
|
3726
|
-
Unset a single pulp_label on the object.
|
|
3727
|
-
|
|
3728
|
-
### Example
|
|
3729
|
-
|
|
3730
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3731
|
-
* Basic Authentication (basicAuth):
|
|
3732
|
-
* Api Key Authentication (cookieAuth):
|
|
3733
|
-
|
|
3734
|
-
```python
|
|
3735
|
-
import pulpcore.client.pulp_npm
|
|
3736
|
-
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
|
|
3737
|
-
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
|
|
3738
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3739
|
-
from pprint import pprint
|
|
3740
|
-
|
|
3741
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3742
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3743
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3744
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3745
|
-
)
|
|
3746
|
-
|
|
3747
|
-
# The client must configure the authentication and authorization parameters
|
|
3748
|
-
# in accordance with the API server security policy.
|
|
3749
|
-
# Examples for each auth method are provided below, use the example that
|
|
3750
|
-
# satisfies your auth use case.
|
|
3751
|
-
|
|
3752
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3753
|
-
|
|
3754
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3755
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3756
|
-
username = os.environ["USERNAME"],
|
|
3757
|
-
password = os.environ["PASSWORD"]
|
|
3758
|
-
)
|
|
3759
|
-
|
|
3760
|
-
# Configure API key authorization: cookieAuth
|
|
3761
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3762
|
-
|
|
3763
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3764
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3765
|
-
|
|
3766
|
-
# Enter a context with an instance of the API client
|
|
3767
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3768
|
-
# Create an instance of the API class
|
|
3769
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3770
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3771
|
-
unset_label = pulpcore.client.pulp_npm.UnsetLabel() # UnsetLabel |
|
|
3772
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3773
|
-
|
|
3774
|
-
try:
|
|
3775
|
-
# Unset a label
|
|
3776
|
-
api_response = api_instance.unset_label(npm_npm_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
|
|
3777
|
-
print("The response of RepositoriesNpmApi->unset_label:\n")
|
|
3778
|
-
pprint(api_response)
|
|
3779
|
-
except Exception as e:
|
|
3780
|
-
print("Exception when calling RepositoriesNpmApi->unset_label: %s\n" % e)
|
|
3781
|
-
```
|
|
3782
|
-
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
### Parameters
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
Name | Type | Description | Notes
|
|
3789
|
-
------------- | ------------- | ------------- | -------------
|
|
3790
|
-
**npm_npm_repository_href** | **str**| |
|
|
3791
|
-
**unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
|
|
3792
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3793
|
-
|
|
3794
|
-
### Return type
|
|
3795
|
-
|
|
3796
|
-
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
|
3797
|
-
|
|
3798
|
-
### Authorization
|
|
3799
|
-
|
|
3800
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3801
|
-
|
|
3802
|
-
### HTTP request headers
|
|
3803
|
-
|
|
3804
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
3805
|
-
- **Accept**: application/json
|
|
3806
|
-
|
|
3807
|
-
### HTTP response details
|
|
3808
|
-
|
|
3809
|
-
| Status code | Description | Response headers |
|
|
3810
|
-
|-------------|-------------|------------------|
|
|
3811
|
-
**201** | | - |
|
|
3812
|
-
|
|
3813
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3814
|
-
|
|
3815
|
-
# **update**
|
|
3816
|
-
> NpmNpmRepositoryResponse update(npm_npm_repository_href, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
|
|
3817
|
-
|
|
3818
|
-
Update a npm repository
|
|
3819
|
-
|
|
3820
|
-
Update the entity and trigger an asynchronous task if necessary
|
|
3821
|
-
|
|
3822
|
-
### Example
|
|
3823
|
-
|
|
3824
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3825
|
-
* Basic Authentication (basicAuth):
|
|
3826
|
-
* Api Key Authentication (cookieAuth):
|
|
3827
|
-
|
|
3828
|
-
```python
|
|
3829
|
-
import pulpcore.client.pulp_npm
|
|
3830
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository import NpmNpmRepository
|
|
3831
|
-
from pulpcore.client.pulp_npm.models.npm_npm_repository_response import NpmNpmRepositoryResponse
|
|
3832
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3833
|
-
from pprint import pprint
|
|
3834
|
-
|
|
3835
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3836
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3837
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3838
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3839
|
-
)
|
|
3840
|
-
|
|
3841
|
-
# The client must configure the authentication and authorization parameters
|
|
3842
|
-
# in accordance with the API server security policy.
|
|
3843
|
-
# Examples for each auth method are provided below, use the example that
|
|
3844
|
-
# satisfies your auth use case.
|
|
3845
|
-
|
|
3846
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3847
|
-
|
|
3848
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3849
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3850
|
-
username = os.environ["USERNAME"],
|
|
3851
|
-
password = os.environ["PASSWORD"]
|
|
3852
|
-
)
|
|
3853
|
-
|
|
3854
|
-
# Configure API key authorization: cookieAuth
|
|
3855
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3856
|
-
|
|
3857
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3858
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3859
|
-
|
|
3860
|
-
# Enter a context with an instance of the API client
|
|
3861
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3862
|
-
# Create an instance of the API class
|
|
3863
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmApi(api_client)
|
|
3864
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
3865
|
-
npm_npm_repository = pulpcore.client.pulp_npm.NpmNpmRepository() # NpmNpmRepository |
|
|
3866
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3867
|
-
|
|
3868
|
-
try:
|
|
3869
|
-
# Update a npm repository
|
|
3870
|
-
api_response = api_instance.update(npm_npm_repository_href, npm_npm_repository, x_task_diagnostics=x_task_diagnostics)
|
|
3871
|
-
print("The response of RepositoriesNpmApi->update:\n")
|
|
3872
|
-
pprint(api_response)
|
|
3873
|
-
except Exception as e:
|
|
3874
|
-
print("Exception when calling RepositoriesNpmApi->update: %s\n" % e)
|
|
3875
|
-
```
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
|
|
3879
|
-
### Parameters
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
Name | Type | Description | Notes
|
|
3883
|
-
------------- | ------------- | ------------- | -------------
|
|
3884
|
-
**npm_npm_repository_href** | **str**| |
|
|
3885
|
-
**npm_npm_repository** | [**NpmNpmRepository**](NpmNpmRepository.md)| |
|
|
3886
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3887
|
-
|
|
3888
|
-
### Return type
|
|
3889
|
-
|
|
3890
|
-
[**NpmNpmRepositoryResponse**](NpmNpmRepositoryResponse.md)
|
|
3891
|
-
|
|
3892
|
-
### Authorization
|
|
3893
|
-
|
|
3894
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3895
|
-
|
|
3896
|
-
### HTTP request headers
|
|
3897
|
-
|
|
3898
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
3899
|
-
- **Accept**: application/json
|
|
3900
|
-
|
|
3901
|
-
### HTTP response details
|
|
3902
|
-
|
|
3903
|
-
| Status code | Description | Response headers |
|
|
3904
|
-
|-------------|-------------|------------------|
|
|
3905
|
-
**200** | | - |
|
|
3906
|
-
**202** | | - |
|
|
3907
|
-
|
|
3908
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
3909
|
-
|
|
3910
|
-
# pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi
|
|
3911
|
-
|
|
3912
|
-
All URIs are relative to *https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com*
|
|
3913
|
-
|
|
3914
|
-
Method | HTTP request | Description
|
|
3915
|
-
------------- | ------------- | -------------
|
|
3916
|
-
[**delete**](RepositoriesNpmVersionsApi.md#delete) | **DELETE** {npm_npm_repository_version_href} | Delete a repository version
|
|
3917
|
-
[**list**](RepositoriesNpmVersionsApi.md#list) | **GET** {npm_npm_repository_href}versions/ | List repository versions
|
|
3918
|
-
[**read**](RepositoriesNpmVersionsApi.md#read) | **GET** {npm_npm_repository_version_href} | Inspect a repository version
|
|
3919
|
-
[**repair**](RepositoriesNpmVersionsApi.md#repair) | **POST** {npm_npm_repository_version_href}repair/ |
|
|
3920
|
-
|
|
3921
|
-
|
|
3922
|
-
# **delete**
|
|
3923
|
-
> AsyncOperationResponse delete(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics)
|
|
3924
|
-
|
|
3925
|
-
Delete a repository version
|
|
3926
|
-
|
|
3927
|
-
Trigger an asynchronous task to delete a repository version.
|
|
3928
|
-
|
|
3929
|
-
### Example
|
|
3930
|
-
|
|
3931
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
3932
|
-
* Basic Authentication (basicAuth):
|
|
3933
|
-
* Api Key Authentication (cookieAuth):
|
|
3934
|
-
|
|
3935
|
-
```python
|
|
3936
|
-
import pulpcore.client.pulp_npm
|
|
3937
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
3938
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
3939
|
-
from pprint import pprint
|
|
3940
|
-
|
|
3941
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
3942
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
3943
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3944
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
3945
|
-
)
|
|
3946
|
-
|
|
3947
|
-
# The client must configure the authentication and authorization parameters
|
|
3948
|
-
# in accordance with the API server security policy.
|
|
3949
|
-
# Examples for each auth method are provided below, use the example that
|
|
3950
|
-
# satisfies your auth use case.
|
|
3951
|
-
|
|
3952
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
3953
|
-
|
|
3954
|
-
# Configure HTTP basic authorization: basicAuth
|
|
3955
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
3956
|
-
username = os.environ["USERNAME"],
|
|
3957
|
-
password = os.environ["PASSWORD"]
|
|
3958
|
-
)
|
|
3959
|
-
|
|
3960
|
-
# Configure API key authorization: cookieAuth
|
|
3961
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
3962
|
-
|
|
3963
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
3964
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
3965
|
-
|
|
3966
|
-
# Enter a context with an instance of the API client
|
|
3967
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
3968
|
-
# Create an instance of the API class
|
|
3969
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
|
|
3970
|
-
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str |
|
|
3971
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
3972
|
-
|
|
3973
|
-
try:
|
|
3974
|
-
# Delete a repository version
|
|
3975
|
-
api_response = api_instance.delete(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics)
|
|
3976
|
-
print("The response of RepositoriesNpmVersionsApi->delete:\n")
|
|
3977
|
-
pprint(api_response)
|
|
3978
|
-
except Exception as e:
|
|
3979
|
-
print("Exception when calling RepositoriesNpmVersionsApi->delete: %s\n" % e)
|
|
3980
|
-
```
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
### Parameters
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
Name | Type | Description | Notes
|
|
3988
|
-
------------- | ------------- | ------------- | -------------
|
|
3989
|
-
**npm_npm_repository_version_href** | **str**| |
|
|
3990
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
3991
|
-
|
|
3992
|
-
### Return type
|
|
3993
|
-
|
|
3994
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
3995
|
-
|
|
3996
|
-
### Authorization
|
|
3997
|
-
|
|
3998
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
3999
|
-
|
|
4000
|
-
### HTTP request headers
|
|
4001
|
-
|
|
4002
|
-
- **Content-Type**: Not defined
|
|
4003
|
-
- **Accept**: application/json
|
|
4004
|
-
|
|
4005
|
-
### HTTP response details
|
|
4006
|
-
|
|
4007
|
-
| Status code | Description | Response headers |
|
|
4008
|
-
|-------------|-------------|------------------|
|
|
4009
|
-
**202** | | - |
|
|
4010
|
-
|
|
4011
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4012
|
-
|
|
4013
|
-
# **list**
|
|
4014
|
-
> PaginatedRepositoryVersionResponseList list(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
|
|
4015
|
-
|
|
4016
|
-
List repository versions
|
|
4017
|
-
|
|
4018
|
-
A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
|
|
4019
|
-
|
|
4020
|
-
### Example
|
|
4021
|
-
|
|
4022
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
4023
|
-
* Basic Authentication (basicAuth):
|
|
4024
|
-
* Api Key Authentication (cookieAuth):
|
|
4025
|
-
|
|
4026
|
-
```python
|
|
4027
|
-
import pulpcore.client.pulp_npm
|
|
4028
|
-
from pulpcore.client.pulp_npm.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
|
|
4029
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
4030
|
-
from pprint import pprint
|
|
4031
|
-
|
|
4032
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
4033
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
4034
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
4035
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
4036
|
-
)
|
|
4037
|
-
|
|
4038
|
-
# The client must configure the authentication and authorization parameters
|
|
4039
|
-
# in accordance with the API server security policy.
|
|
4040
|
-
# Examples for each auth method are provided below, use the example that
|
|
4041
|
-
# satisfies your auth use case.
|
|
4042
|
-
|
|
4043
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
4044
|
-
|
|
4045
|
-
# Configure HTTP basic authorization: basicAuth
|
|
4046
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
4047
|
-
username = os.environ["USERNAME"],
|
|
4048
|
-
password = os.environ["PASSWORD"]
|
|
4049
|
-
)
|
|
4050
|
-
|
|
4051
|
-
# Configure API key authorization: cookieAuth
|
|
4052
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
4053
|
-
|
|
4054
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
4055
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
4056
|
-
|
|
4057
|
-
# Enter a context with an instance of the API client
|
|
4058
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
4059
|
-
# Create an instance of the API class
|
|
4060
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
|
|
4061
|
-
npm_npm_repository_href = 'npm_npm_repository_href_example' # str |
|
|
4062
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
4063
|
-
content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
|
|
4064
|
-
content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
4065
|
-
limit = 56 # int | Number of results to return per page. (optional)
|
|
4066
|
-
number = 56 # int | Filter results where number matches value (optional)
|
|
4067
|
-
number__gt = 56 # int | Filter results where number is greater than value (optional)
|
|
4068
|
-
number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)
|
|
4069
|
-
number__lt = 56 # int | Filter results where number is less than value (optional)
|
|
4070
|
-
number__lte = 56 # int | Filter results where number is less than or equal to value (optional)
|
|
4071
|
-
number__range = [56] # List[int] | Filter results where number is between two comma separated values (optional)
|
|
4072
|
-
offset = 56 # int | The initial index from which to return the results. (optional)
|
|
4073
|
-
ordering = ['ordering_example'] # List[str] | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
|
|
4074
|
-
prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
4075
|
-
pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
|
|
4076
|
-
pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
|
|
4077
|
-
pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
|
|
4078
|
-
pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
|
|
4079
|
-
pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
|
|
4080
|
-
pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
|
|
4081
|
-
pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
|
|
4082
|
-
pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
|
|
4083
|
-
q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
|
|
4084
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
4085
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
4086
|
-
|
|
4087
|
-
try:
|
|
4088
|
-
# List repository versions
|
|
4089
|
-
api_response = api_instance.list(npm_npm_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
|
|
4090
|
-
print("The response of RepositoriesNpmVersionsApi->list:\n")
|
|
4091
|
-
pprint(api_response)
|
|
4092
|
-
except Exception as e:
|
|
4093
|
-
print("Exception when calling RepositoriesNpmVersionsApi->list: %s\n" % e)
|
|
4094
|
-
```
|
|
4095
|
-
|
|
4096
|
-
|
|
4097
|
-
|
|
4098
|
-
### Parameters
|
|
4099
|
-
|
|
4100
|
-
|
|
4101
|
-
Name | Type | Description | Notes
|
|
4102
|
-
------------- | ------------- | ------------- | -------------
|
|
4103
|
-
**npm_npm_repository_href** | **str**| |
|
|
4104
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
4105
|
-
**content** | **str**| Content Unit referenced by HREF/PRN | [optional]
|
|
4106
|
-
**content__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
4107
|
-
**limit** | **int**| Number of results to return per page. | [optional]
|
|
4108
|
-
**number** | **int**| Filter results where number matches value | [optional]
|
|
4109
|
-
**number__gt** | **int**| Filter results where number is greater than value | [optional]
|
|
4110
|
-
**number__gte** | **int**| Filter results where number is greater than or equal to value | [optional]
|
|
4111
|
-
**number__lt** | **int**| Filter results where number is less than value | [optional]
|
|
4112
|
-
**number__lte** | **int**| Filter results where number is less than or equal to value | [optional]
|
|
4113
|
-
**number__range** | [**List[int]**](int.md)| Filter results where number is between two comma separated values | [optional]
|
|
4114
|
-
**offset** | **int**| The initial index from which to return the results. | [optional]
|
|
4115
|
-
**ordering** | [**List[str]**](str.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
|
|
4116
|
-
**prn__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
4117
|
-
**pulp_created** | **datetime**| Filter results where pulp_created matches value | [optional]
|
|
4118
|
-
**pulp_created__gt** | **datetime**| Filter results where pulp_created is greater than value | [optional]
|
|
4119
|
-
**pulp_created__gte** | **datetime**| Filter results where pulp_created is greater than or equal to value | [optional]
|
|
4120
|
-
**pulp_created__isnull** | **bool**| Filter results where pulp_created has a null value | [optional]
|
|
4121
|
-
**pulp_created__lt** | **datetime**| Filter results where pulp_created is less than value | [optional]
|
|
4122
|
-
**pulp_created__lte** | **datetime**| Filter results where pulp_created is less than or equal to value | [optional]
|
|
4123
|
-
**pulp_created__range** | [**List[datetime]**](datetime.md)| Filter results where pulp_created is between two comma separated values | [optional]
|
|
4124
|
-
**pulp_href__in** | [**List[str]**](str.md)| Multiple values may be separated by commas. | [optional]
|
|
4125
|
-
**q** | **str**| Filter results by using NOT, AND and OR operations on other filters | [optional]
|
|
4126
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
4127
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
4128
|
-
|
|
4129
|
-
### Return type
|
|
4130
|
-
|
|
4131
|
-
[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
|
|
4132
|
-
|
|
4133
|
-
### Authorization
|
|
4134
|
-
|
|
4135
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
4136
|
-
|
|
4137
|
-
### HTTP request headers
|
|
4138
|
-
|
|
4139
|
-
- **Content-Type**: Not defined
|
|
4140
|
-
- **Accept**: application/json
|
|
4141
|
-
|
|
4142
|
-
### HTTP response details
|
|
4143
|
-
|
|
4144
|
-
| Status code | Description | Response headers |
|
|
4145
|
-
|-------------|-------------|------------------|
|
|
4146
|
-
**200** | | - |
|
|
4147
|
-
|
|
4148
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4149
|
-
|
|
4150
|
-
# **read**
|
|
4151
|
-
> RepositoryVersionResponse read(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
4152
|
-
|
|
4153
|
-
Inspect a repository version
|
|
4154
|
-
|
|
4155
|
-
A ViewSet for a NpmRepositoryVersion represents a single Npm repository version.
|
|
4156
|
-
|
|
4157
|
-
### Example
|
|
4158
|
-
|
|
4159
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
4160
|
-
* Basic Authentication (basicAuth):
|
|
4161
|
-
* Api Key Authentication (cookieAuth):
|
|
4162
|
-
|
|
4163
|
-
```python
|
|
4164
|
-
import pulpcore.client.pulp_npm
|
|
4165
|
-
from pulpcore.client.pulp_npm.models.repository_version_response import RepositoryVersionResponse
|
|
4166
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
4167
|
-
from pprint import pprint
|
|
4168
|
-
|
|
4169
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
4170
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
4171
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
4172
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
4173
|
-
)
|
|
4174
|
-
|
|
4175
|
-
# The client must configure the authentication and authorization parameters
|
|
4176
|
-
# in accordance with the API server security policy.
|
|
4177
|
-
# Examples for each auth method are provided below, use the example that
|
|
4178
|
-
# satisfies your auth use case.
|
|
4179
|
-
|
|
4180
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
4181
|
-
|
|
4182
|
-
# Configure HTTP basic authorization: basicAuth
|
|
4183
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
4184
|
-
username = os.environ["USERNAME"],
|
|
4185
|
-
password = os.environ["PASSWORD"]
|
|
4186
|
-
)
|
|
4187
|
-
|
|
4188
|
-
# Configure API key authorization: cookieAuth
|
|
4189
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
4190
|
-
|
|
4191
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
4192
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
4193
|
-
|
|
4194
|
-
# Enter a context with an instance of the API client
|
|
4195
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
4196
|
-
# Create an instance of the API class
|
|
4197
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
|
|
4198
|
-
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str |
|
|
4199
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
4200
|
-
fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
|
|
4201
|
-
exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)
|
|
4202
|
-
|
|
4203
|
-
try:
|
|
4204
|
-
# Inspect a repository version
|
|
4205
|
-
api_response = api_instance.read(npm_npm_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
|
|
4206
|
-
print("The response of RepositoriesNpmVersionsApi->read:\n")
|
|
4207
|
-
pprint(api_response)
|
|
4208
|
-
except Exception as e:
|
|
4209
|
-
print("Exception when calling RepositoriesNpmVersionsApi->read: %s\n" % e)
|
|
4210
|
-
```
|
|
4211
|
-
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
### Parameters
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
Name | Type | Description | Notes
|
|
4218
|
-
------------- | ------------- | ------------- | -------------
|
|
4219
|
-
**npm_npm_repository_version_href** | **str**| |
|
|
4220
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
4221
|
-
**fields** | [**List[str]**](str.md)| A list of fields to include in the response. | [optional]
|
|
4222
|
-
**exclude_fields** | [**List[str]**](str.md)| A list of fields to exclude from the response. | [optional]
|
|
4223
|
-
|
|
4224
|
-
### Return type
|
|
4225
|
-
|
|
4226
|
-
[**RepositoryVersionResponse**](RepositoryVersionResponse.md)
|
|
4227
|
-
|
|
4228
|
-
### Authorization
|
|
4229
|
-
|
|
4230
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
4231
|
-
|
|
4232
|
-
### HTTP request headers
|
|
4233
|
-
|
|
4234
|
-
- **Content-Type**: Not defined
|
|
4235
|
-
- **Accept**: application/json
|
|
4236
|
-
|
|
4237
|
-
### HTTP response details
|
|
4238
|
-
|
|
4239
|
-
| Status code | Description | Response headers |
|
|
4240
|
-
|-------------|-------------|------------------|
|
|
4241
|
-
**200** | | - |
|
|
4242
|
-
|
|
4243
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4244
|
-
|
|
4245
|
-
# **repair**
|
|
4246
|
-
> AsyncOperationResponse repair(npm_npm_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
4250
|
-
Trigger an asynchronous task to repair a repository version.
|
|
4251
|
-
|
|
4252
|
-
### Example
|
|
4253
|
-
|
|
4254
|
-
* OAuth Authentication (json_header_remote_authentication):
|
|
4255
|
-
* Basic Authentication (basicAuth):
|
|
4256
|
-
* Api Key Authentication (cookieAuth):
|
|
4257
|
-
|
|
4258
|
-
```python
|
|
4259
|
-
import pulpcore.client.pulp_npm
|
|
4260
|
-
from pulpcore.client.pulp_npm.models.async_operation_response import AsyncOperationResponse
|
|
4261
|
-
from pulpcore.client.pulp_npm.models.repair import Repair
|
|
4262
|
-
from pulpcore.client.pulp_npm.rest import ApiException
|
|
4263
|
-
from pprint import pprint
|
|
4264
|
-
|
|
4265
|
-
# Defining the host is optional and defaults to https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com
|
|
4266
|
-
# See configuration.py for a list of all supported configuration parameters.
|
|
4267
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
4268
|
-
host = "https://env-ephemeral-yvk3tx.apps.crc-eph.r9lp.p1.openshiftapps.com"
|
|
4269
|
-
)
|
|
4270
|
-
|
|
4271
|
-
# The client must configure the authentication and authorization parameters
|
|
4272
|
-
# in accordance with the API server security policy.
|
|
4273
|
-
# Examples for each auth method are provided below, use the example that
|
|
4274
|
-
# satisfies your auth use case.
|
|
4275
|
-
|
|
4276
|
-
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
4277
|
-
|
|
4278
|
-
# Configure HTTP basic authorization: basicAuth
|
|
4279
|
-
configuration = pulpcore.client.pulp_npm.Configuration(
|
|
4280
|
-
username = os.environ["USERNAME"],
|
|
4281
|
-
password = os.environ["PASSWORD"]
|
|
4282
|
-
)
|
|
4283
|
-
|
|
4284
|
-
# Configure API key authorization: cookieAuth
|
|
4285
|
-
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]
|
|
4286
|
-
|
|
4287
|
-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
4288
|
-
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'
|
|
4289
|
-
|
|
4290
|
-
# Enter a context with an instance of the API client
|
|
4291
|
-
with pulpcore.client.pulp_npm.ApiClient(configuration) as api_client:
|
|
4292
|
-
# Create an instance of the API class
|
|
4293
|
-
api_instance = pulpcore.client.pulp_npm.RepositoriesNpmVersionsApi(api_client)
|
|
4294
|
-
npm_npm_repository_version_href = 'npm_npm_repository_version_href_example' # str |
|
|
4295
|
-
repair = pulpcore.client.pulp_npm.Repair() # Repair |
|
|
4296
|
-
x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
|
|
4297
|
-
|
|
4298
|
-
try:
|
|
4299
|
-
api_response = api_instance.repair(npm_npm_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
|
|
4300
|
-
print("The response of RepositoriesNpmVersionsApi->repair:\n")
|
|
4301
|
-
pprint(api_response)
|
|
4302
|
-
except Exception as e:
|
|
4303
|
-
print("Exception when calling RepositoriesNpmVersionsApi->repair: %s\n" % e)
|
|
4304
|
-
```
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
### Parameters
|
|
4309
|
-
|
|
4310
|
-
|
|
4311
|
-
Name | Type | Description | Notes
|
|
4312
|
-
------------- | ------------- | ------------- | -------------
|
|
4313
|
-
**npm_npm_repository_version_href** | **str**| |
|
|
4314
|
-
**repair** | [**Repair**](Repair.md)| |
|
|
4315
|
-
**x_task_diagnostics** | [**List[str]**](str.md)| List of profilers to use on tasks. | [optional]
|
|
4316
|
-
|
|
4317
|
-
### Return type
|
|
4318
|
-
|
|
4319
|
-
[**AsyncOperationResponse**](AsyncOperationResponse.md)
|
|
4320
|
-
|
|
4321
|
-
### Authorization
|
|
4322
|
-
|
|
4323
|
-
[json_header_remote_authentication](../README.md#json_header_remote_authentication), [basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
|
|
4324
|
-
|
|
4325
|
-
### HTTP request headers
|
|
4326
|
-
|
|
4327
|
-
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
4328
|
-
- **Accept**: application/json
|
|
4329
|
-
|
|
4330
|
-
### HTTP response details
|
|
4331
|
-
|
|
4332
|
-
| Status code | Description | Response headers |
|
|
4333
|
-
|-------------|-------------|------------------|
|
|
4334
|
-
**202** | | - |
|
|
4335
|
-
|
|
4336
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4337
|
-
|
|
4338
|
-
# RepositoryAddRemoveContent
|
|
4339
|
-
|
|
4340
|
-
Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.
|
|
4341
|
-
|
|
4342
|
-
## Properties
|
|
4343
|
-
|
|
4344
|
-
Name | Type | Description | Notes
|
|
4345
|
-
------------ | ------------- | ------------- | -------------
|
|
4346
|
-
**add_content_units** | **List[str]** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional]
|
|
4347
|
-
**remove_content_units** | **List[str]** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional]
|
|
4348
|
-
**base_version** | **str** | A repository version whose content will be used as the initial set of content for the new repository version | [optional]
|
|
4349
|
-
|
|
4350
|
-
## Example
|
|
4351
|
-
|
|
4352
|
-
```python
|
|
4353
|
-
from pulpcore.client.pulp_npm.models.repository_add_remove_content import RepositoryAddRemoveContent
|
|
4354
|
-
|
|
4355
|
-
# TODO update the JSON string below
|
|
4356
|
-
json = "{}"
|
|
4357
|
-
# create an instance of RepositoryAddRemoveContent from a JSON string
|
|
4358
|
-
repository_add_remove_content_instance = RepositoryAddRemoveContent.from_json(json)
|
|
4359
|
-
# print the JSON string representation of the object
|
|
4360
|
-
print(RepositoryAddRemoveContent.to_json())
|
|
4361
|
-
|
|
4362
|
-
# convert the object into a dict
|
|
4363
|
-
repository_add_remove_content_dict = repository_add_remove_content_instance.to_dict()
|
|
4364
|
-
# create an instance of RepositoryAddRemoveContent from a dict
|
|
4365
|
-
repository_add_remove_content_from_dict = RepositoryAddRemoveContent.from_dict(repository_add_remove_content_dict)
|
|
4366
|
-
```
|
|
4367
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
# RepositorySyncURL
|
|
4371
|
-
|
|
4372
|
-
A mixin for validating unknown serializers' fields.
|
|
4373
|
-
|
|
4374
|
-
## Properties
|
|
4375
|
-
|
|
4376
|
-
Name | Type | Description | Notes
|
|
4377
|
-
------------ | ------------- | ------------- | -------------
|
|
4378
|
-
**remote** | **str** | A remote to sync from. This will override a remote set on repository. | [optional]
|
|
4379
|
-
**mirror** | **bool** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional] [default to False]
|
|
4380
|
-
|
|
4381
|
-
## Example
|
|
4382
|
-
|
|
4383
|
-
```python
|
|
4384
|
-
from pulpcore.client.pulp_npm.models.repository_sync_url import RepositorySyncURL
|
|
4385
|
-
|
|
4386
|
-
# TODO update the JSON string below
|
|
4387
|
-
json = "{}"
|
|
4388
|
-
# create an instance of RepositorySyncURL from a JSON string
|
|
4389
|
-
repository_sync_url_instance = RepositorySyncURL.from_json(json)
|
|
4390
|
-
# print the JSON string representation of the object
|
|
4391
|
-
print(RepositorySyncURL.to_json())
|
|
4392
|
-
|
|
4393
|
-
# convert the object into a dict
|
|
4394
|
-
repository_sync_url_dict = repository_sync_url_instance.to_dict()
|
|
4395
|
-
# create an instance of RepositorySyncURL from a dict
|
|
4396
|
-
repository_sync_url_from_dict = RepositorySyncURL.from_dict(repository_sync_url_dict)
|
|
4397
|
-
```
|
|
4398
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4399
|
-
|
|
4400
|
-
|
|
4401
|
-
# RepositoryVersionResponse
|
|
4402
|
-
|
|
4403
|
-
Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ``ref_name`` attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.
|
|
4404
|
-
|
|
4405
|
-
## Properties
|
|
4406
|
-
|
|
4407
|
-
Name | Type | Description | Notes
|
|
4408
|
-
------------ | ------------- | ------------- | -------------
|
|
4409
|
-
**pulp_href** | **str** | | [optional] [readonly]
|
|
4410
|
-
**prn** | **str** | The Pulp Resource Name (PRN). | [optional] [readonly]
|
|
4411
|
-
**pulp_created** | **datetime** | Timestamp of creation. | [optional] [readonly]
|
|
4412
|
-
**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]
|
|
4413
|
-
**number** | **int** | | [optional] [readonly]
|
|
4414
|
-
**repository** | **str** | | [optional] [readonly]
|
|
4415
|
-
**base_version** | **str** | A repository version whose content was used as the initial set of content for this repository version | [optional]
|
|
4416
|
-
**content_summary** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional] [readonly]
|
|
4417
|
-
**vuln_report** | **str** | | [optional] [readonly]
|
|
4418
|
-
|
|
4419
|
-
## Example
|
|
4420
|
-
|
|
4421
|
-
```python
|
|
4422
|
-
from pulpcore.client.pulp_npm.models.repository_version_response import RepositoryVersionResponse
|
|
4423
|
-
|
|
4424
|
-
# TODO update the JSON string below
|
|
4425
|
-
json = "{}"
|
|
4426
|
-
# create an instance of RepositoryVersionResponse from a JSON string
|
|
4427
|
-
repository_version_response_instance = RepositoryVersionResponse.from_json(json)
|
|
4428
|
-
# print the JSON string representation of the object
|
|
4429
|
-
print(RepositoryVersionResponse.to_json())
|
|
4430
|
-
|
|
4431
|
-
# convert the object into a dict
|
|
4432
|
-
repository_version_response_dict = repository_version_response_instance.to_dict()
|
|
4433
|
-
# create an instance of RepositoryVersionResponse from a dict
|
|
4434
|
-
repository_version_response_from_dict = RepositoryVersionResponse.from_dict(repository_version_response_dict)
|
|
4435
|
-
```
|
|
4436
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4437
|
-
|
|
4438
|
-
|
|
4439
|
-
# SetLabel
|
|
4440
|
-
|
|
4441
|
-
Serializer for synchronously setting a label.
|
|
4442
|
-
|
|
4443
|
-
## Properties
|
|
4444
|
-
|
|
4445
|
-
Name | Type | Description | Notes
|
|
4446
|
-
------------ | ------------- | ------------- | -------------
|
|
4447
|
-
**key** | **str** | |
|
|
4448
|
-
**value** | **str** | |
|
|
4449
|
-
|
|
4450
|
-
## Example
|
|
4451
|
-
|
|
4452
|
-
```python
|
|
4453
|
-
from pulpcore.client.pulp_npm.models.set_label import SetLabel
|
|
4454
|
-
|
|
4455
|
-
# TODO update the JSON string below
|
|
4456
|
-
json = "{}"
|
|
4457
|
-
# create an instance of SetLabel from a JSON string
|
|
4458
|
-
set_label_instance = SetLabel.from_json(json)
|
|
4459
|
-
# print the JSON string representation of the object
|
|
4460
|
-
print(SetLabel.to_json())
|
|
4461
|
-
|
|
4462
|
-
# convert the object into a dict
|
|
4463
|
-
set_label_dict = set_label_instance.to_dict()
|
|
4464
|
-
# create an instance of SetLabel from a dict
|
|
4465
|
-
set_label_from_dict = SetLabel.from_dict(set_label_dict)
|
|
4466
|
-
```
|
|
4467
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4468
|
-
|
|
4469
|
-
|
|
4470
|
-
# SetLabelResponse
|
|
4471
|
-
|
|
4472
|
-
Serializer for synchronously setting a label.
|
|
4473
|
-
|
|
4474
|
-
## Properties
|
|
4475
|
-
|
|
4476
|
-
Name | Type | Description | Notes
|
|
4477
|
-
------------ | ------------- | ------------- | -------------
|
|
4478
|
-
**key** | **str** | |
|
|
4479
|
-
**value** | **str** | |
|
|
4480
|
-
|
|
4481
|
-
## Example
|
|
4482
|
-
|
|
4483
|
-
```python
|
|
4484
|
-
from pulpcore.client.pulp_npm.models.set_label_response import SetLabelResponse
|
|
4485
|
-
|
|
4486
|
-
# TODO update the JSON string below
|
|
4487
|
-
json = "{}"
|
|
4488
|
-
# create an instance of SetLabelResponse from a JSON string
|
|
4489
|
-
set_label_response_instance = SetLabelResponse.from_json(json)
|
|
4490
|
-
# print the JSON string representation of the object
|
|
4491
|
-
print(SetLabelResponse.to_json())
|
|
4492
|
-
|
|
4493
|
-
# convert the object into a dict
|
|
4494
|
-
set_label_response_dict = set_label_response_instance.to_dict()
|
|
4495
|
-
# create an instance of SetLabelResponse from a dict
|
|
4496
|
-
set_label_response_from_dict = SetLabelResponse.from_dict(set_label_response_dict)
|
|
4497
|
-
```
|
|
4498
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4499
|
-
|
|
4500
|
-
|
|
4501
|
-
# UnsetLabel
|
|
4502
|
-
|
|
4503
|
-
Serializer for synchronously UNsetting a label.
|
|
4504
|
-
|
|
4505
|
-
## Properties
|
|
4506
|
-
|
|
4507
|
-
Name | Type | Description | Notes
|
|
4508
|
-
------------ | ------------- | ------------- | -------------
|
|
4509
|
-
**key** | **str** | |
|
|
4510
|
-
|
|
4511
|
-
## Example
|
|
4512
|
-
|
|
4513
|
-
```python
|
|
4514
|
-
from pulpcore.client.pulp_npm.models.unset_label import UnsetLabel
|
|
4515
|
-
|
|
4516
|
-
# TODO update the JSON string below
|
|
4517
|
-
json = "{}"
|
|
4518
|
-
# create an instance of UnsetLabel from a JSON string
|
|
4519
|
-
unset_label_instance = UnsetLabel.from_json(json)
|
|
4520
|
-
# print the JSON string representation of the object
|
|
4521
|
-
print(UnsetLabel.to_json())
|
|
4522
|
-
|
|
4523
|
-
# convert the object into a dict
|
|
4524
|
-
unset_label_dict = unset_label_instance.to_dict()
|
|
4525
|
-
# create an instance of UnsetLabel from a dict
|
|
4526
|
-
unset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)
|
|
4527
|
-
```
|
|
4528
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4529
|
-
|
|
4530
|
-
|
|
4531
|
-
# UnsetLabelResponse
|
|
4532
|
-
|
|
4533
|
-
Serializer for synchronously UNsetting a label.
|
|
4534
|
-
|
|
4535
|
-
## Properties
|
|
4536
|
-
|
|
4537
|
-
Name | Type | Description | Notes
|
|
4538
|
-
------------ | ------------- | ------------- | -------------
|
|
4539
|
-
**key** | **str** | |
|
|
4540
|
-
**value** | **str** | | [optional] [readonly]
|
|
4541
|
-
|
|
4542
|
-
## Example
|
|
4543
|
-
|
|
4544
|
-
```python
|
|
4545
|
-
from pulpcore.client.pulp_npm.models.unset_label_response import UnsetLabelResponse
|
|
4546
|
-
|
|
4547
|
-
# TODO update the JSON string below
|
|
4548
|
-
json = "{}"
|
|
4549
|
-
# create an instance of UnsetLabelResponse from a JSON string
|
|
4550
|
-
unset_label_response_instance = UnsetLabelResponse.from_json(json)
|
|
4551
|
-
# print the JSON string representation of the object
|
|
4552
|
-
print(UnsetLabelResponse.to_json())
|
|
4553
|
-
|
|
4554
|
-
# convert the object into a dict
|
|
4555
|
-
unset_label_response_dict = unset_label_response_instance.to_dict()
|
|
4556
|
-
# create an instance of UnsetLabelResponse from a dict
|
|
4557
|
-
unset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)
|
|
4558
|
-
```
|
|
4559
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
4560
|
-
|
|
4561
|
-
|