pulp_certguard_client 3.69.2 → 3.70.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +9 -5
  3. data/docs/CertguardRHSMCertGuard.md +12 -11
  4. data/docs/CertguardRHSMCertGuardResponse.md +20 -19
  5. data/docs/CertguardX509CertGuard.md +12 -11
  6. data/docs/CertguardX509CertGuardResponse.md +20 -19
  7. data/docs/ContentguardsRhsmApi.md +195 -94
  8. data/docs/ContentguardsX509Api.md +195 -94
  9. data/docs/PaginatedcertguardRHSMCertGuardResponseList.md +14 -13
  10. data/docs/PaginatedcertguardX509CertGuardResponseList.md +14 -13
  11. data/docs/PatchedcertguardRHSMCertGuard.md +12 -11
  12. data/docs/PatchedcertguardX509CertGuard.md +12 -11
  13. data/lib/pulp_certguard_client/api/contentguards_rhsm_api.rb +42 -27
  14. data/lib/pulp_certguard_client/api/contentguards_x509_api.rb +42 -27
  15. data/lib/pulp_certguard_client/api_client.rb +137 -102
  16. data/lib/pulp_certguard_client/api_error.rb +2 -1
  17. data/lib/pulp_certguard_client/configuration.rb +162 -21
  18. data/lib/pulp_certguard_client/models/certguard_rhsm_cert_guard.rb +34 -22
  19. data/lib/pulp_certguard_client/models/certguard_rhsm_cert_guard_response.rb +36 -24
  20. data/lib/pulp_certguard_client/models/certguard_x509_cert_guard.rb +34 -22
  21. data/lib/pulp_certguard_client/models/certguard_x509_cert_guard_response.rb +36 -24
  22. data/lib/pulp_certguard_client/models/paginatedcertguard_rhsm_cert_guard_response_list.rb +34 -22
  23. data/lib/pulp_certguard_client/models/paginatedcertguard_x509_cert_guard_response_list.rb +34 -22
  24. data/lib/pulp_certguard_client/models/patchedcertguard_rhsm_cert_guard.rb +40 -24
  25. data/lib/pulp_certguard_client/models/patchedcertguard_x509_cert_guard.rb +40 -24
  26. data/lib/pulp_certguard_client/version.rb +2 -2
  27. data/lib/pulp_certguard_client.rb +1 -1
  28. data/pulp_certguard_client.gemspec +9 -6
  29. data/spec/api/contentguards_rhsm_api_spec.rb +7 -7
  30. data/spec/api/contentguards_x509_api_spec.rb +7 -7
  31. data/spec/models/certguard_rhsm_cert_guard_response_spec.rb +13 -18
  32. data/spec/models/certguard_rhsm_cert_guard_spec.rb +9 -14
  33. data/spec/models/certguard_x509_cert_guard_response_spec.rb +13 -18
  34. data/spec/models/certguard_x509_cert_guard_spec.rb +9 -14
  35. data/spec/models/paginatedcertguard_rhsm_cert_guard_response_list_spec.rb +10 -15
  36. data/spec/models/paginatedcertguard_x509_cert_guard_response_list_spec.rb +10 -15
  37. data/spec/models/patchedcertguard_rhsm_cert_guard_spec.rb +9 -14
  38. data/spec/models/patchedcertguard_x509_cert_guard_spec.rb +9 -14
  39. data/spec/spec_helper.rb +1 -1
  40. metadata +41 -17
  41. data/spec/api_client_spec.rb +0 -188
  42. data/spec/configuration_spec.rb +0 -42
@@ -2,29 +2,28 @@
2
2
 
3
3
  All URIs are relative to *http://localhost:24817*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create**](ContentguardsX509Api.md#create) | **POST** /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard
8
- [**delete**](ContentguardsX509Api.md#delete) | **DELETE** {certguard_x509_cert_guard_href} | Delete a x509 cert guard
9
- [**list**](ContentguardsX509Api.md#list) | **GET** /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards
10
- [**partial_update**](ContentguardsX509Api.md#partial_update) | **PATCH** {certguard_x509_cert_guard_href} | Update a x509 cert guard
11
- [**read**](ContentguardsX509Api.md#read) | **GET** {certguard_x509_cert_guard_href} | Inspect a x509 cert guard
12
- [**update**](ContentguardsX509Api.md#update) | **PUT** {certguard_x509_cert_guard_href} | Update a x509 cert guard
13
-
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](ContentguardsX509Api.md#create) | **POST** /pulp/api/v3/contentguards/certguard/x509/ | Create a x509 cert guard |
8
+ | [**delete**](ContentguardsX509Api.md#delete) | **DELETE** {certguard_x509_cert_guard_href} | Delete a x509 cert guard |
9
+ | [**list**](ContentguardsX509Api.md#list) | **GET** /pulp/api/v3/contentguards/certguard/x509/ | List x509 cert guards |
10
+ | [**partial_update**](ContentguardsX509Api.md#partial_update) | **PATCH** {certguard_x509_cert_guard_href} | Update a x509 cert guard |
11
+ | [**read**](ContentguardsX509Api.md#read) | **GET** {certguard_x509_cert_guard_href} | Inspect a x509 cert guard |
12
+ | [**update**](ContentguardsX509Api.md#update) | **PUT** {certguard_x509_cert_guard_href} | Update a x509 cert guard |
14
13
 
15
14
 
16
15
  ## create
17
16
 
18
- > CertguardX509CertGuardResponse create(certguard_x509_cert_guard)
17
+ > <CertguardX509CertGuardResponse> create(certguard_x509_cert_guard)
19
18
 
20
19
  Create a x509 cert guard
21
20
 
22
21
  X509CertGuard API Viewsets.
23
22
 
24
- ### Example
23
+ ### Examples
25
24
 
26
25
  ```ruby
27
- # load the gem
26
+ require 'time'
28
27
  require 'pulp_certguard_client'
29
28
  # setup authorization
30
29
  PulpCertguardClient.configure do |config|
@@ -34,23 +33,40 @@ PulpCertguardClient.configure do |config|
34
33
  end
35
34
 
36
35
  api_instance = PulpCertguardClient::ContentguardsX509Api.new
37
- certguard_x509_cert_guard = PulpCertguardClient::CertguardX509CertGuard.new # CertguardX509CertGuard |
36
+ certguard_x509_cert_guard = PulpCertguardClient::CertguardX509CertGuard.new({name: 'name_example', ca_certificate: 'ca_certificate_example'}) # CertguardX509CertGuard |
38
37
 
39
38
  begin
40
- #Create a x509 cert guard
39
+ # Create a x509 cert guard
41
40
  result = api_instance.create(certguard_x509_cert_guard)
42
41
  p result
43
42
  rescue PulpCertguardClient::ApiError => e
44
- puts "Exception when calling ContentguardsX509Api->create: #{e}"
43
+ puts "Error when calling ContentguardsX509Api->create: #{e}"
45
44
  end
46
45
  ```
47
46
 
48
- ### Parameters
47
+ #### Using the create_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<CertguardX509CertGuardResponse>, Integer, Hash)> create_with_http_info(certguard_x509_cert_guard)
52
+
53
+ ```ruby
54
+ begin
55
+ # Create a x509 cert guard
56
+ data, status_code, headers = api_instance.create_with_http_info(certguard_x509_cert_guard)
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <CertguardX509CertGuardResponse>
60
+ rescue PulpCertguardClient::ApiError => e
61
+ puts "Error when calling ContentguardsX509Api->create_with_http_info: #{e}"
62
+ end
63
+ ```
49
64
 
65
+ ### Parameters
50
66
 
51
- Name | Type | Description | Notes
52
- ------------- | ------------- | ------------- | -------------
53
- **certguard_x509_cert_guard** | [**CertguardX509CertGuard**](CertguardX509CertGuard.md)| |
67
+ | Name | Type | Description | Notes |
68
+ | ---- | ---- | ----------- | ----- |
69
+ | **certguard_x509_cert_guard** | [**CertguardX509CertGuard**](CertguardX509CertGuard.md) | | |
54
70
 
55
71
  ### Return type
56
72
 
@@ -74,10 +90,10 @@ Delete a x509 cert guard
74
90
 
75
91
  X509CertGuard API Viewsets.
76
92
 
77
- ### Example
93
+ ### Examples
78
94
 
79
95
  ```ruby
80
- # load the gem
96
+ require 'time'
81
97
  require 'pulp_certguard_client'
82
98
  # setup authorization
83
99
  PulpCertguardClient.configure do |config|
@@ -90,19 +106,36 @@ api_instance = PulpCertguardClient::ContentguardsX509Api.new
90
106
  certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
91
107
 
92
108
  begin
93
- #Delete a x509 cert guard
109
+ # Delete a x509 cert guard
94
110
  api_instance.delete(certguard_x509_cert_guard_href)
95
111
  rescue PulpCertguardClient::ApiError => e
96
- puts "Exception when calling ContentguardsX509Api->delete: #{e}"
112
+ puts "Error when calling ContentguardsX509Api->delete: #{e}"
97
113
  end
98
114
  ```
99
115
 
100
- ### Parameters
116
+ #### Using the delete_with_http_info variant
101
117
 
118
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
102
119
 
103
- Name | Type | Description | Notes
104
- ------------- | ------------- | ------------- | -------------
105
- **certguard_x509_cert_guard_href** | **String**| |
120
+ > <Array(nil, Integer, Hash)> delete_with_http_info(certguard_x509_cert_guard_href)
121
+
122
+ ```ruby
123
+ begin
124
+ # Delete a x509 cert guard
125
+ data, status_code, headers = api_instance.delete_with_http_info(certguard_x509_cert_guard_href)
126
+ p status_code # => 2xx
127
+ p headers # => { ... }
128
+ p data # => nil
129
+ rescue PulpCertguardClient::ApiError => e
130
+ puts "Error when calling ContentguardsX509Api->delete_with_http_info: #{e}"
131
+ end
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ | Name | Type | Description | Notes |
137
+ | ---- | ---- | ----------- | ----- |
138
+ | **certguard_x509_cert_guard_href** | **String** | | |
106
139
 
107
140
  ### Return type
108
141
 
@@ -120,16 +153,16 @@ nil (empty response body)
120
153
 
121
154
  ## list
122
155
 
123
- > PaginatedcertguardX509CertGuardResponseList list(opts)
156
+ > <PaginatedcertguardX509CertGuardResponseList> list(opts)
124
157
 
125
158
  List x509 cert guards
126
159
 
127
160
  X509CertGuard API Viewsets.
128
161
 
129
- ### Example
162
+ ### Examples
130
163
 
131
164
  ```ruby
132
- # load the gem
165
+ require 'time'
133
166
  require 'pulp_certguard_client'
134
167
  # setup authorization
135
168
  PulpCertguardClient.configure do |config|
@@ -145,53 +178,70 @@ opts = {
145
178
  name__contains: 'name__contains_example', # String | Filter results where name contains value
146
179
  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
147
180
  name__iexact: 'name__iexact_example', # String | Filter results where name matches value
148
- name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
181
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
149
182
  name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
150
183
  name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
151
184
  name__regex: 'name__regex_example', # String | Filter results where name matches regex value
152
185
  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
153
186
  offset: 56, # Integer | The initial index from which to return the results.
154
- ordering: ['ordering_example'], # Array<String> | 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) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
155
- prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
156
- pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
157
- pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
187
+ ordering: ['-description'], # Array<String> | 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) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
188
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
189
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
190
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
158
191
  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
159
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
160
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
192
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
193
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
161
194
  }
162
195
 
163
196
  begin
164
- #List x509 cert guards
197
+ # List x509 cert guards
165
198
  result = api_instance.list(opts)
166
199
  p result
167
200
  rescue PulpCertguardClient::ApiError => e
168
- puts "Exception when calling ContentguardsX509Api->list: #{e}"
201
+ puts "Error when calling ContentguardsX509Api->list: #{e}"
169
202
  end
170
203
  ```
171
204
 
172
- ### Parameters
205
+ #### Using the list_with_http_info variant
206
+
207
+ This returns an Array which contains the response data, status code and headers.
208
+
209
+ > <Array(<PaginatedcertguardX509CertGuardResponseList>, Integer, Hash)> list_with_http_info(opts)
173
210
 
211
+ ```ruby
212
+ begin
213
+ # List x509 cert guards
214
+ data, status_code, headers = api_instance.list_with_http_info(opts)
215
+ p status_code # => 2xx
216
+ p headers # => { ... }
217
+ p data # => <PaginatedcertguardX509CertGuardResponseList>
218
+ rescue PulpCertguardClient::ApiError => e
219
+ puts "Error when calling ContentguardsX509Api->list_with_http_info: #{e}"
220
+ end
221
+ ```
222
+
223
+ ### Parameters
174
224
 
175
- Name | Type | Description | Notes
176
- ------------- | ------------- | ------------- | -------------
177
- **limit** | **Integer**| Number of results to return per page. | [optional]
178
- **name** | **String**| Filter results where name matches value | [optional]
179
- **name__contains** | **String**| Filter results where name contains value | [optional]
180
- **name__icontains** | **String**| Filter results where name contains value | [optional]
181
- **name__iexact** | **String**| Filter results where name matches value | [optional]
182
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
183
- **name__iregex** | **String**| Filter results where name matches regex value | [optional]
184
- **name__istartswith** | **String**| Filter results where name starts with value | [optional]
185
- **name__regex** | **String**| Filter results where name matches regex value | [optional]
186
- **name__startswith** | **String**| Filter results where name starts with value | [optional]
187
- **offset** | **Integer**| The initial index from which to return the results. | [optional]
188
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional]
189
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
190
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
191
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional]
192
- **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [optional]
193
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
194
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
225
+ | Name | Type | Description | Notes |
226
+ | ---- | ---- | ----------- | ----- |
227
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
228
+ | **name** | **String** | Filter results where name matches value | [optional] |
229
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
230
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
231
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
232
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
233
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
234
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
235
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
236
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
237
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
238
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
239
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
240
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
241
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
242
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
243
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
244
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
195
245
 
196
246
  ### Return type
197
247
 
@@ -209,16 +259,16 @@ Name | Type | Description | Notes
209
259
 
210
260
  ## partial_update
211
261
 
212
- > CertguardX509CertGuardResponse partial_update(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard)
262
+ > <CertguardX509CertGuardResponse> partial_update(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard)
213
263
 
214
264
  Update a x509 cert guard
215
265
 
216
266
  X509CertGuard API Viewsets.
217
267
 
218
- ### Example
268
+ ### Examples
219
269
 
220
270
  ```ruby
221
- # load the gem
271
+ require 'time'
222
272
  require 'pulp_certguard_client'
223
273
  # setup authorization
224
274
  PulpCertguardClient.configure do |config|
@@ -232,21 +282,38 @@ certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # Stri
232
282
  patchedcertguard_x509_cert_guard = PulpCertguardClient::PatchedcertguardX509CertGuard.new # PatchedcertguardX509CertGuard |
233
283
 
234
284
  begin
235
- #Update a x509 cert guard
285
+ # Update a x509 cert guard
236
286
  result = api_instance.partial_update(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard)
237
287
  p result
238
288
  rescue PulpCertguardClient::ApiError => e
239
- puts "Exception when calling ContentguardsX509Api->partial_update: #{e}"
289
+ puts "Error when calling ContentguardsX509Api->partial_update: #{e}"
240
290
  end
241
291
  ```
242
292
 
243
- ### Parameters
293
+ #### Using the partial_update_with_http_info variant
294
+
295
+ This returns an Array which contains the response data, status code and headers.
244
296
 
297
+ > <Array(<CertguardX509CertGuardResponse>, Integer, Hash)> partial_update_with_http_info(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard)
245
298
 
246
- Name | Type | Description | Notes
247
- ------------- | ------------- | ------------- | -------------
248
- **certguard_x509_cert_guard_href** | **String**| |
249
- **patchedcertguard_x509_cert_guard** | [**PatchedcertguardX509CertGuard**](PatchedcertguardX509CertGuard.md)| |
299
+ ```ruby
300
+ begin
301
+ # Update a x509 cert guard
302
+ data, status_code, headers = api_instance.partial_update_with_http_info(certguard_x509_cert_guard_href, patchedcertguard_x509_cert_guard)
303
+ p status_code # => 2xx
304
+ p headers # => { ... }
305
+ p data # => <CertguardX509CertGuardResponse>
306
+ rescue PulpCertguardClient::ApiError => e
307
+ puts "Error when calling ContentguardsX509Api->partial_update_with_http_info: #{e}"
308
+ end
309
+ ```
310
+
311
+ ### Parameters
312
+
313
+ | Name | Type | Description | Notes |
314
+ | ---- | ---- | ----------- | ----- |
315
+ | **certguard_x509_cert_guard_href** | **String** | | |
316
+ | **patchedcertguard_x509_cert_guard** | [**PatchedcertguardX509CertGuard**](PatchedcertguardX509CertGuard.md) | | |
250
317
 
251
318
  ### Return type
252
319
 
@@ -264,16 +331,16 @@ Name | Type | Description | Notes
264
331
 
265
332
  ## read
266
333
 
267
- > CertguardX509CertGuardResponse read(certguard_x509_cert_guard_href, opts)
334
+ > <CertguardX509CertGuardResponse> read(certguard_x509_cert_guard_href, opts)
268
335
 
269
336
  Inspect a x509 cert guard
270
337
 
271
338
  X509CertGuard API Viewsets.
272
339
 
273
- ### Example
340
+ ### Examples
274
341
 
275
342
  ```ruby
276
- # load the gem
343
+ require 'time'
277
344
  require 'pulp_certguard_client'
278
345
  # setup authorization
279
346
  PulpCertguardClient.configure do |config|
@@ -285,27 +352,44 @@ end
285
352
  api_instance = PulpCertguardClient::ContentguardsX509Api.new
286
353
  certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
287
354
  opts = {
288
- fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
289
- exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
355
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
356
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
290
357
  }
291
358
 
292
359
  begin
293
- #Inspect a x509 cert guard
360
+ # Inspect a x509 cert guard
294
361
  result = api_instance.read(certguard_x509_cert_guard_href, opts)
295
362
  p result
296
363
  rescue PulpCertguardClient::ApiError => e
297
- puts "Exception when calling ContentguardsX509Api->read: #{e}"
364
+ puts "Error when calling ContentguardsX509Api->read: #{e}"
298
365
  end
299
366
  ```
300
367
 
301
- ### Parameters
368
+ #### Using the read_with_http_info variant
369
+
370
+ This returns an Array which contains the response data, status code and headers.
371
+
372
+ > <Array(<CertguardX509CertGuardResponse>, Integer, Hash)> read_with_http_info(certguard_x509_cert_guard_href, opts)
373
+
374
+ ```ruby
375
+ begin
376
+ # Inspect a x509 cert guard
377
+ data, status_code, headers = api_instance.read_with_http_info(certguard_x509_cert_guard_href, opts)
378
+ p status_code # => 2xx
379
+ p headers # => { ... }
380
+ p data # => <CertguardX509CertGuardResponse>
381
+ rescue PulpCertguardClient::ApiError => e
382
+ puts "Error when calling ContentguardsX509Api->read_with_http_info: #{e}"
383
+ end
384
+ ```
302
385
 
386
+ ### Parameters
303
387
 
304
- Name | Type | Description | Notes
305
- ------------- | ------------- | ------------- | -------------
306
- **certguard_x509_cert_guard_href** | **String**| |
307
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional]
308
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional]
388
+ | Name | Type | Description | Notes |
389
+ | ---- | ---- | ----------- | ----- |
390
+ | **certguard_x509_cert_guard_href** | **String** | | |
391
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
392
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
309
393
 
310
394
  ### Return type
311
395
 
@@ -323,16 +407,16 @@ Name | Type | Description | Notes
323
407
 
324
408
  ## update
325
409
 
326
- > CertguardX509CertGuardResponse update(certguard_x509_cert_guard_href, certguard_x509_cert_guard)
410
+ > <CertguardX509CertGuardResponse> update(certguard_x509_cert_guard_href, certguard_x509_cert_guard)
327
411
 
328
412
  Update a x509 cert guard
329
413
 
330
414
  X509CertGuard API Viewsets.
331
415
 
332
- ### Example
416
+ ### Examples
333
417
 
334
418
  ```ruby
335
- # load the gem
419
+ require 'time'
336
420
  require 'pulp_certguard_client'
337
421
  # setup authorization
338
422
  PulpCertguardClient.configure do |config|
@@ -343,24 +427,41 @@ end
343
427
 
344
428
  api_instance = PulpCertguardClient::ContentguardsX509Api.new
345
429
  certguard_x509_cert_guard_href = 'certguard_x509_cert_guard_href_example' # String |
346
- certguard_x509_cert_guard = PulpCertguardClient::CertguardX509CertGuard.new # CertguardX509CertGuard |
430
+ certguard_x509_cert_guard = PulpCertguardClient::CertguardX509CertGuard.new({name: 'name_example', ca_certificate: 'ca_certificate_example'}) # CertguardX509CertGuard |
347
431
 
348
432
  begin
349
- #Update a x509 cert guard
433
+ # Update a x509 cert guard
350
434
  result = api_instance.update(certguard_x509_cert_guard_href, certguard_x509_cert_guard)
351
435
  p result
352
436
  rescue PulpCertguardClient::ApiError => e
353
- puts "Exception when calling ContentguardsX509Api->update: #{e}"
437
+ puts "Error when calling ContentguardsX509Api->update: #{e}"
354
438
  end
355
439
  ```
356
440
 
357
- ### Parameters
441
+ #### Using the update_with_http_info variant
442
+
443
+ This returns an Array which contains the response data, status code and headers.
444
+
445
+ > <Array(<CertguardX509CertGuardResponse>, Integer, Hash)> update_with_http_info(certguard_x509_cert_guard_href, certguard_x509_cert_guard)
358
446
 
447
+ ```ruby
448
+ begin
449
+ # Update a x509 cert guard
450
+ data, status_code, headers = api_instance.update_with_http_info(certguard_x509_cert_guard_href, certguard_x509_cert_guard)
451
+ p status_code # => 2xx
452
+ p headers # => { ... }
453
+ p data # => <CertguardX509CertGuardResponse>
454
+ rescue PulpCertguardClient::ApiError => e
455
+ puts "Error when calling ContentguardsX509Api->update_with_http_info: #{e}"
456
+ end
457
+ ```
458
+
459
+ ### Parameters
359
460
 
360
- Name | Type | Description | Notes
361
- ------------- | ------------- | ------------- | -------------
362
- **certguard_x509_cert_guard_href** | **String**| |
363
- **certguard_x509_cert_guard** | [**CertguardX509CertGuard**](CertguardX509CertGuard.md)| |
461
+ | Name | Type | Description | Notes |
462
+ | ---- | ---- | ----------- | ----- |
463
+ | **certguard_x509_cert_guard_href** | **String** | | |
464
+ | **certguard_x509_cert_guard** | [**CertguardX509CertGuard**](CertguardX509CertGuard.md) | | |
364
465
 
365
466
  ### Return type
366
467
 
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | |
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array&lt;CertguardRHSMCertGuardResponse&gt;**](CertguardRHSMCertGuardResponse.md) | |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array&lt;CertguardRHSMCertGuardResponse&gt;**](CertguardRHSMCertGuardResponse.md) | | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'PulpCertguardClient'
15
+ require 'pulp_certguard_client'
16
16
 
17
- instance = PulpCertguardClient::PaginatedcertguardRHSMCertGuardResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
19
- previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
20
- results: null)
17
+ instance = PulpCertguardClient::PaginatedcertguardRHSMCertGuardResponseList.new(
18
+ count: 123,
19
+ _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
20
+ previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
21
+ results: null
22
+ )
21
23
  ```
22
24
 
23
-
@@ -2,22 +2,23 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **count** | **Integer** | |
8
- **_next** | **String** | | [optional]
9
- **previous** | **String** | | [optional]
10
- **results** | [**Array&lt;CertguardX509CertGuardResponse&gt;**](CertguardX509CertGuardResponse.md) | |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | | |
8
+ | **_next** | **String** | | [optional] |
9
+ | **previous** | **String** | | [optional] |
10
+ | **results** | [**Array&lt;CertguardX509CertGuardResponse&gt;**](CertguardX509CertGuardResponse.md) | | |
11
11
 
12
- ## Code Sample
12
+ ## Example
13
13
 
14
14
  ```ruby
15
- require 'PulpCertguardClient'
15
+ require 'pulp_certguard_client'
16
16
 
17
- instance = PulpCertguardClient::PaginatedcertguardX509CertGuardResponseList.new(count: 123,
18
- _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
19
- previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
20
- results: null)
17
+ instance = PulpCertguardClient::PaginatedcertguardX509CertGuardResponseList.new(
18
+ count: 123,
19
+ _next: http://api.example.org/accounts/?offset&#x3D;400&amp;limit&#x3D;100,
20
+ previous: http://api.example.org/accounts/?offset&#x3D;200&amp;limit&#x3D;100,
21
+ results: null
22
+ )
21
23
  ```
22
24
 
23
-
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | The unique name. | [optional]
8
- **description** | **String** | An optional description. | [optional]
9
- **ca_certificate** | **String** | A Certificate Authority (CA) certificate (or a bundle thereof) used to verify client-certificate authenticity. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The unique name. | [optional] |
8
+ | **description** | **String** | An optional description. | [optional] |
9
+ | **ca_certificate** | **String** | A Certificate Authority (CA) certificate (or a bundle thereof) used to verify client-certificate authenticity. | [optional] |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'PulpCertguardClient'
14
+ require 'pulp_certguard_client'
15
15
 
16
- instance = PulpCertguardClient::PatchedcertguardRHSMCertGuard.new(name: null,
17
- description: null,
18
- ca_certificate: null)
16
+ instance = PulpCertguardClient::PatchedcertguardRHSMCertGuard.new(
17
+ name: null,
18
+ description: null,
19
+ ca_certificate: null
20
+ )
19
21
  ```
20
22
 
21
-
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **name** | **String** | The unique name. | [optional]
8
- **description** | **String** | An optional description. | [optional]
9
- **ca_certificate** | **String** | A Certificate Authority (CA) certificate (or a bundle thereof) used to verify client-certificate authenticity. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The unique name. | [optional] |
8
+ | **description** | **String** | An optional description. | [optional] |
9
+ | **ca_certificate** | **String** | A Certificate Authority (CA) certificate (or a bundle thereof) used to verify client-certificate authenticity. | [optional] |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'PulpCertguardClient'
14
+ require 'pulp_certguard_client'
15
15
 
16
- instance = PulpCertguardClient::PatchedcertguardX509CertGuard.new(name: null,
17
- description: null,
18
- ca_certificate: null)
16
+ instance = PulpCertguardClient::PatchedcertguardX509CertGuard.new(
17
+ name: null,
18
+ description: null,
19
+ ca_certificate: null
20
+ )
19
21
  ```
20
22
 
21
-