keynetra-client 0.1.1
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +49 -0
- data/Rakefile +10 -0
- data/docs/ACLCreate.md +28 -0
- data/docs/ACLOut.md +34 -0
- data/docs/AccessApi.md +234 -0
- data/docs/AccessDecisionResponse.md +30 -0
- data/docs/AccessRequest.md +28 -0
- data/docs/AdminLoginRequest.md +20 -0
- data/docs/AdminLoginResponse.md +26 -0
- data/docs/AuditRecordOut.md +42 -0
- data/docs/AuthApi.md +133 -0
- data/docs/AuthModelCreate.md +18 -0
- data/docs/AuthModelOut.md +26 -0
- data/docs/BatchAccessItem.md +20 -0
- data/docs/BatchAccessRequest.md +24 -0
- data/docs/BatchAccessResponse.md +20 -0
- data/docs/BatchAccessResult.md +22 -0
- data/docs/DataValue.md +15 -0
- data/docs/DevApi.md +132 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/HealthApi.md +187 -0
- data/docs/ImpactAnalysisRequest.md +18 -0
- data/docs/ImpactAnalysisResponse.md +20 -0
- data/docs/LocationInner.md +15 -0
- data/docs/ManagementApi.md +2096 -0
- data/docs/MetaBody.md +24 -0
- data/docs/PermissionCreate.md +18 -0
- data/docs/PermissionOut.md +20 -0
- data/docs/PermissionUpdate.md +18 -0
- data/docs/PlaygroundApi.md +80 -0
- data/docs/PlaygroundEvaluateRequest.md +20 -0
- data/docs/PlaygroundInput.md +24 -0
- data/docs/PlaygroundPolicy.md +26 -0
- data/docs/PolicyCreate.md +26 -0
- data/docs/PolicyOut.md +28 -0
- data/docs/PolicySimulationInput.md +22 -0
- data/docs/PolicySimulationRequest.md +20 -0
- data/docs/PolicySimulationResponse.md +20 -0
- data/docs/RelationshipCreate.md +26 -0
- data/docs/RelationshipOut.md +28 -0
- data/docs/RoleCreate.md +18 -0
- data/docs/RoleOut.md +20 -0
- data/docs/RoleUpdate.md +18 -0
- data/docs/SimulationResponse.md +30 -0
- data/docs/SuccessResponseACLOut.md +22 -0
- data/docs/SuccessResponseAccessDecisionResponse.md +22 -0
- data/docs/SuccessResponseAdminLoginResponse.md +22 -0
- data/docs/SuccessResponseAuthModelOut.md +22 -0
- data/docs/SuccessResponseBatchAccessResponse.md +22 -0
- data/docs/SuccessResponseDictStrAny.md +22 -0
- data/docs/SuccessResponseDictStrInt.md +22 -0
- data/docs/SuccessResponseDictStrObject.md +22 -0
- data/docs/SuccessResponseDictStrStr.md +22 -0
- data/docs/SuccessResponseDictStrUnionIntStr.md +22 -0
- data/docs/SuccessResponseImpactAnalysisResponse.md +22 -0
- data/docs/SuccessResponseListACLOut.md +22 -0
- data/docs/SuccessResponseListAuditRecordOut.md +22 -0
- data/docs/SuccessResponseListDictStrStr.md +22 -0
- data/docs/SuccessResponseListPermissionOut.md +22 -0
- data/docs/SuccessResponseListPolicyOut.md +22 -0
- data/docs/SuccessResponseListRoleOut.md +22 -0
- data/docs/SuccessResponsePermissionOut.md +22 -0
- data/docs/SuccessResponsePolicyOut.md +22 -0
- data/docs/SuccessResponsePolicySimulationResponse.md +22 -0
- data/docs/SuccessResponseRelationshipOut.md +22 -0
- data/docs/SuccessResponseSimulationResponse.md +22 -0
- data/docs/ValidationError.md +26 -0
- data/git_push.sh +57 -0
- data/keynetra-client.gemspec +39 -0
- data/lib/keynetra-client/api/access_api.rb +226 -0
- data/lib/keynetra-client/api/auth_api.rb +154 -0
- data/lib/keynetra-client/api/dev_api.rb +135 -0
- data/lib/keynetra-client/api/health_api.rb +187 -0
- data/lib/keynetra-client/api/management_api.rb +1851 -0
- data/lib/keynetra-client/api/playground_api.rb +88 -0
- data/lib/keynetra-client/api_client.rb +397 -0
- data/lib/keynetra-client/api_error.rb +58 -0
- data/lib/keynetra-client/api_model_base.rb +88 -0
- data/lib/keynetra-client/configuration.rb +315 -0
- data/lib/keynetra-client/models/access_decision_response.rb +242 -0
- data/lib/keynetra-client/models/access_request.rb +219 -0
- data/lib/keynetra-client/models/acl_create.rb +294 -0
- data/lib/keynetra-client/models/acl_out.rb +356 -0
- data/lib/keynetra-client/models/admin_login_request.rb +190 -0
- data/lib/keynetra-client/models/admin_login_response.rb +238 -0
- data/lib/keynetra-client/models/audit_record_out.rb +454 -0
- data/lib/keynetra-client/models/auth_model_create.rb +164 -0
- data/lib/keynetra-client/models/auth_model_out.rb +272 -0
- data/lib/keynetra-client/models/batch_access_item.rb +175 -0
- data/lib/keynetra-client/models/batch_access_request.rb +198 -0
- data/lib/keynetra-client/models/batch_access_response.rb +176 -0
- data/lib/keynetra-client/models/batch_access_result.rb +200 -0
- data/lib/keynetra-client/models/data_value.rb +103 -0
- data/lib/keynetra-client/models/http_validation_error.rb +149 -0
- data/lib/keynetra-client/models/impact_analysis_request.rb +164 -0
- data/lib/keynetra-client/models/impact_analysis_response.rb +160 -0
- data/lib/keynetra-client/models/location_inner.rb +103 -0
- data/lib/keynetra-client/models/meta_body.rb +179 -0
- data/lib/keynetra-client/models/permission_create.rb +164 -0
- data/lib/keynetra-client/models/permission_out.rb +190 -0
- data/lib/keynetra-client/models/permission_update.rb +164 -0
- data/lib/keynetra-client/models/playground_evaluate_request.rb +192 -0
- data/lib/keynetra-client/models/playground_input.rb +182 -0
- data/lib/keynetra-client/models/playground_policy.rb +207 -0
- data/lib/keynetra-client/models/policy_create.rb +208 -0
- data/lib/keynetra-client/models/policy_out.rb +281 -0
- data/lib/keynetra-client/models/policy_simulation_input.rb +172 -0
- data/lib/keynetra-client/models/policy_simulation_request.rb +158 -0
- data/lib/keynetra-client/models/policy_simulation_response.rb +194 -0
- data/lib/keynetra-client/models/relationship_create.rb +268 -0
- data/lib/keynetra-client/models/relationship_out.rb +294 -0
- data/lib/keynetra-client/models/role_create.rb +164 -0
- data/lib/keynetra-client/models/role_out.rb +190 -0
- data/lib/keynetra-client/models/role_update.rb +164 -0
- data/lib/keynetra-client/models/simulation_response.rb +244 -0
- data/lib/keynetra-client/models/success_response_access_decision_response.rb +182 -0
- data/lib/keynetra-client/models/success_response_acl_out.rb +182 -0
- data/lib/keynetra-client/models/success_response_admin_login_response.rb +182 -0
- data/lib/keynetra-client/models/success_response_auth_model_out.rb +182 -0
- data/lib/keynetra-client/models/success_response_batch_access_response.rb +182 -0
- data/lib/keynetra-client/models/success_response_dict_str_any.rb +184 -0
- data/lib/keynetra-client/models/success_response_dict_str_int.rb +184 -0
- data/lib/keynetra-client/models/success_response_dict_str_object.rb +184 -0
- data/lib/keynetra-client/models/success_response_dict_str_str.rb +184 -0
- data/lib/keynetra-client/models/success_response_dict_str_union_int_str.rb +184 -0
- data/lib/keynetra-client/models/success_response_impact_analysis_response.rb +182 -0
- data/lib/keynetra-client/models/success_response_list_acl_out.rb +184 -0
- data/lib/keynetra-client/models/success_response_list_audit_record_out.rb +184 -0
- data/lib/keynetra-client/models/success_response_list_dict_str_str.rb +184 -0
- data/lib/keynetra-client/models/success_response_list_permission_out.rb +184 -0
- data/lib/keynetra-client/models/success_response_list_policy_out.rb +184 -0
- data/lib/keynetra-client/models/success_response_list_role_out.rb +184 -0
- data/lib/keynetra-client/models/success_response_permission_out.rb +182 -0
- data/lib/keynetra-client/models/success_response_policy_out.rb +182 -0
- data/lib/keynetra-client/models/success_response_policy_simulation_response.rb +182 -0
- data/lib/keynetra-client/models/success_response_relationship_out.rb +182 -0
- data/lib/keynetra-client/models/success_response_simulation_response.rb +182 -0
- data/lib/keynetra-client/models/validation_error.rb +237 -0
- data/lib/keynetra-client/version.rb +15 -0
- data/lib/keynetra-client.rb +105 -0
- data/spec/api/access_api_spec.rb +70 -0
- data/spec/api/auth_api_spec.rb +57 -0
- data/spec/api/dev_api_spec.rb +56 -0
- data/spec/api/health_api_spec.rb +65 -0
- data/spec/api/management_api_spec.rb +361 -0
- data/spec/api/playground_api_spec.rb +46 -0
- data/spec/models/access_decision_response_spec.rb +72 -0
- data/spec/models/access_request_spec.rb +66 -0
- data/spec/models/acl_create_spec.rb +66 -0
- data/spec/models/acl_out_spec.rb +84 -0
- data/spec/models/admin_login_request_spec.rb +42 -0
- data/spec/models/admin_login_response_spec.rb +60 -0
- data/spec/models/audit_record_out_spec.rb +108 -0
- data/spec/models/auth_model_create_spec.rb +36 -0
- data/spec/models/auth_model_out_spec.rb +60 -0
- data/spec/models/batch_access_item_spec.rb +42 -0
- data/spec/models/batch_access_request_spec.rb +54 -0
- data/spec/models/batch_access_response_spec.rb +42 -0
- data/spec/models/batch_access_result_spec.rb +48 -0
- data/spec/models/data_value_spec.rb +21 -0
- data/spec/models/http_validation_error_spec.rb +36 -0
- data/spec/models/impact_analysis_request_spec.rb +36 -0
- data/spec/models/impact_analysis_response_spec.rb +42 -0
- data/spec/models/location_inner_spec.rb +21 -0
- data/spec/models/meta_body_spec.rb +54 -0
- data/spec/models/permission_create_spec.rb +36 -0
- data/spec/models/permission_out_spec.rb +42 -0
- data/spec/models/permission_update_spec.rb +36 -0
- data/spec/models/playground_evaluate_request_spec.rb +42 -0
- data/spec/models/playground_input_spec.rb +54 -0
- data/spec/models/playground_policy_spec.rb +60 -0
- data/spec/models/policy_create_spec.rb +60 -0
- data/spec/models/policy_out_spec.rb +66 -0
- data/spec/models/policy_simulation_input_spec.rb +48 -0
- data/spec/models/policy_simulation_request_spec.rb +42 -0
- data/spec/models/policy_simulation_response_spec.rb +42 -0
- data/spec/models/relationship_create_spec.rb +60 -0
- data/spec/models/relationship_out_spec.rb +66 -0
- data/spec/models/role_create_spec.rb +36 -0
- data/spec/models/role_out_spec.rb +42 -0
- data/spec/models/role_update_spec.rb +36 -0
- data/spec/models/simulation_response_spec.rb +72 -0
- data/spec/models/success_response_access_decision_response_spec.rb +48 -0
- data/spec/models/success_response_acl_out_spec.rb +48 -0
- data/spec/models/success_response_admin_login_response_spec.rb +48 -0
- data/spec/models/success_response_auth_model_out_spec.rb +48 -0
- data/spec/models/success_response_batch_access_response_spec.rb +48 -0
- data/spec/models/success_response_dict_str_any_spec.rb +48 -0
- data/spec/models/success_response_dict_str_int_spec.rb +48 -0
- data/spec/models/success_response_dict_str_object_spec.rb +48 -0
- data/spec/models/success_response_dict_str_str_spec.rb +48 -0
- data/spec/models/success_response_dict_str_union_int_str_spec.rb +48 -0
- data/spec/models/success_response_impact_analysis_response_spec.rb +48 -0
- data/spec/models/success_response_list_acl_out_spec.rb +48 -0
- data/spec/models/success_response_list_audit_record_out_spec.rb +48 -0
- data/spec/models/success_response_list_dict_str_str_spec.rb +48 -0
- data/spec/models/success_response_list_permission_out_spec.rb +48 -0
- data/spec/models/success_response_list_policy_out_spec.rb +48 -0
- data/spec/models/success_response_list_role_out_spec.rb +48 -0
- data/spec/models/success_response_permission_out_spec.rb +48 -0
- data/spec/models/success_response_policy_out_spec.rb +48 -0
- data/spec/models/success_response_policy_simulation_response_spec.rb +48 -0
- data/spec/models/success_response_relationship_out_spec.rb +48 -0
- data/spec/models/success_response_simulation_response_spec.rb +48 -0
- data/spec/models/validation_error_spec.rb +60 -0
- data/spec/spec_helper.rb +111 -0
- metadata +356 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# KeyNetra::AuthModelOut
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **Integer** | | |
|
|
8
|
+
| **tenant_id** | **Integer** | | |
|
|
9
|
+
| **schema** | **String** | | |
|
|
10
|
+
| **parsed** | **Hash<String, Object>** | | |
|
|
11
|
+
| **compiled** | **Hash<String, Object>** | | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'keynetra-client'
|
|
17
|
+
|
|
18
|
+
instance = KeyNetra::AuthModelOut.new(
|
|
19
|
+
id: null,
|
|
20
|
+
tenant_id: null,
|
|
21
|
+
schema: null,
|
|
22
|
+
parsed: null,
|
|
23
|
+
compiled: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KeyNetra::BatchAccessItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | **String** | | |
|
|
8
|
+
| **resource** | **Hash<String, Object>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'keynetra-client'
|
|
14
|
+
|
|
15
|
+
instance = KeyNetra::BatchAccessItem.new(
|
|
16
|
+
action: null,
|
|
17
|
+
resource: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# KeyNetra::BatchAccessRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user** | **Hash<String, Object>** | | [optional] |
|
|
8
|
+
| **items** | [**Array<BatchAccessItem>**](BatchAccessItem.md) | | |
|
|
9
|
+
| **consistency** | **String** | | [optional][default to 'eventual'] |
|
|
10
|
+
| **revision** | **Integer** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'keynetra-client'
|
|
16
|
+
|
|
17
|
+
instance = KeyNetra::BatchAccessRequest.new(
|
|
18
|
+
user: null,
|
|
19
|
+
items: null,
|
|
20
|
+
consistency: null,
|
|
21
|
+
revision: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KeyNetra::BatchAccessResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **results** | [**Array<BatchAccessResult>**](BatchAccessResult.md) | | |
|
|
8
|
+
| **revision** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'keynetra-client'
|
|
14
|
+
|
|
15
|
+
instance = KeyNetra::BatchAccessResponse.new(
|
|
16
|
+
results: null,
|
|
17
|
+
revision: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# KeyNetra::BatchAccessResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | **String** | | |
|
|
8
|
+
| **allowed** | **Boolean** | | |
|
|
9
|
+
| **revision** | **Integer** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'keynetra-client'
|
|
15
|
+
|
|
16
|
+
instance = KeyNetra::BatchAccessResult.new(
|
|
17
|
+
action: null,
|
|
18
|
+
allowed: null,
|
|
19
|
+
revision: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/DataValue.md
ADDED
data/docs/DevApi.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# KeyNetra::DevApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_sample_data_dev_sample_data_get**](DevApi.md#get_sample_data_dev_sample_data_get) | **GET** /dev/sample-data | Get Sample Data |
|
|
8
|
+
| [**seed_sample_data_dev_sample_data_seed_post**](DevApi.md#seed_sample_data_dev_sample_data_seed_post) | **POST** /dev/sample-data/seed | Seed Sample Data |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## get_sample_data_dev_sample_data_get
|
|
12
|
+
|
|
13
|
+
> <SuccessResponseDictStrObject> get_sample_data_dev_sample_data_get
|
|
14
|
+
|
|
15
|
+
Get Sample Data
|
|
16
|
+
|
|
17
|
+
### Examples
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'time'
|
|
21
|
+
require 'keynetra-client'
|
|
22
|
+
|
|
23
|
+
api_instance = KeyNetra::DevApi.new
|
|
24
|
+
|
|
25
|
+
begin
|
|
26
|
+
# Get Sample Data
|
|
27
|
+
result = api_instance.get_sample_data_dev_sample_data_get
|
|
28
|
+
p result
|
|
29
|
+
rescue KeyNetra::ApiError => e
|
|
30
|
+
puts "Error when calling DevApi->get_sample_data_dev_sample_data_get: #{e}"
|
|
31
|
+
end
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
#### Using the get_sample_data_dev_sample_data_get_with_http_info variant
|
|
35
|
+
|
|
36
|
+
This returns an Array which contains the response data, status code and headers.
|
|
37
|
+
|
|
38
|
+
> <Array(<SuccessResponseDictStrObject>, Integer, Hash)> get_sample_data_dev_sample_data_get_with_http_info
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
begin
|
|
42
|
+
# Get Sample Data
|
|
43
|
+
data, status_code, headers = api_instance.get_sample_data_dev_sample_data_get_with_http_info
|
|
44
|
+
p status_code # => 2xx
|
|
45
|
+
p headers # => { ... }
|
|
46
|
+
p data # => <SuccessResponseDictStrObject>
|
|
47
|
+
rescue KeyNetra::ApiError => e
|
|
48
|
+
puts "Error when calling DevApi->get_sample_data_dev_sample_data_get_with_http_info: #{e}"
|
|
49
|
+
end
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Parameters
|
|
53
|
+
|
|
54
|
+
This endpoint does not need any parameter.
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
[**SuccessResponseDictStrObject**](SuccessResponseDictStrObject.md)
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
No authorization required
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: Not defined
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## seed_sample_data_dev_sample_data_seed_post
|
|
71
|
+
|
|
72
|
+
> <SuccessResponseDictStrObject> seed_sample_data_dev_sample_data_seed_post(opts)
|
|
73
|
+
|
|
74
|
+
Seed Sample Data
|
|
75
|
+
|
|
76
|
+
### Examples
|
|
77
|
+
|
|
78
|
+
```ruby
|
|
79
|
+
require 'time'
|
|
80
|
+
require 'keynetra-client'
|
|
81
|
+
|
|
82
|
+
api_instance = KeyNetra::DevApi.new
|
|
83
|
+
opts = {
|
|
84
|
+
reset: true # Boolean | Clear the sample dataset before reseeding it.
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
# Seed Sample Data
|
|
89
|
+
result = api_instance.seed_sample_data_dev_sample_data_seed_post(opts)
|
|
90
|
+
p result
|
|
91
|
+
rescue KeyNetra::ApiError => e
|
|
92
|
+
puts "Error when calling DevApi->seed_sample_data_dev_sample_data_seed_post: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
#### Using the seed_sample_data_dev_sample_data_seed_post_with_http_info variant
|
|
97
|
+
|
|
98
|
+
This returns an Array which contains the response data, status code and headers.
|
|
99
|
+
|
|
100
|
+
> <Array(<SuccessResponseDictStrObject>, Integer, Hash)> seed_sample_data_dev_sample_data_seed_post_with_http_info(opts)
|
|
101
|
+
|
|
102
|
+
```ruby
|
|
103
|
+
begin
|
|
104
|
+
# Seed Sample Data
|
|
105
|
+
data, status_code, headers = api_instance.seed_sample_data_dev_sample_data_seed_post_with_http_info(opts)
|
|
106
|
+
p status_code # => 2xx
|
|
107
|
+
p headers # => { ... }
|
|
108
|
+
p data # => <SuccessResponseDictStrObject>
|
|
109
|
+
rescue KeyNetra::ApiError => e
|
|
110
|
+
puts "Error when calling DevApi->seed_sample_data_dev_sample_data_seed_post_with_http_info: #{e}"
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Parameters
|
|
115
|
+
|
|
116
|
+
| Name | Type | Description | Notes |
|
|
117
|
+
| ---- | ---- | ----------- | ----- |
|
|
118
|
+
| **reset** | **Boolean** | Clear the sample dataset before reseeding it. | [optional][default to false] |
|
|
119
|
+
|
|
120
|
+
### Return type
|
|
121
|
+
|
|
122
|
+
[**SuccessResponseDictStrObject**](SuccessResponseDictStrObject.md)
|
|
123
|
+
|
|
124
|
+
### Authorization
|
|
125
|
+
|
|
126
|
+
No authorization required
|
|
127
|
+
|
|
128
|
+
### HTTP request headers
|
|
129
|
+
|
|
130
|
+
- **Content-Type**: Not defined
|
|
131
|
+
- **Accept**: application/json
|
|
132
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KeyNetra::HTTPValidationError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **detail** | [**Array<ValidationError>**](ValidationError.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'keynetra-client'
|
|
13
|
+
|
|
14
|
+
instance = KeyNetra::HTTPValidationError.new(
|
|
15
|
+
detail: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/HealthApi.md
ADDED
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# KeyNetra::HealthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**health_health_get**](HealthApi.md#health_health_get) | **GET** /health | Health |
|
|
8
|
+
| [**liveness_health_live_get**](HealthApi.md#liveness_health_live_get) | **GET** /health/live | Liveness |
|
|
9
|
+
| [**readiness_health_ready_get**](HealthApi.md#readiness_health_ready_get) | **GET** /health/ready | Readiness |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## health_health_get
|
|
13
|
+
|
|
14
|
+
> <SuccessResponseDictStrStr> health_health_get
|
|
15
|
+
|
|
16
|
+
Health
|
|
17
|
+
|
|
18
|
+
### Examples
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'time'
|
|
22
|
+
require 'keynetra-client'
|
|
23
|
+
|
|
24
|
+
api_instance = KeyNetra::HealthApi.new
|
|
25
|
+
|
|
26
|
+
begin
|
|
27
|
+
# Health
|
|
28
|
+
result = api_instance.health_health_get
|
|
29
|
+
p result
|
|
30
|
+
rescue KeyNetra::ApiError => e
|
|
31
|
+
puts "Error when calling HealthApi->health_health_get: #{e}"
|
|
32
|
+
end
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
#### Using the health_health_get_with_http_info variant
|
|
36
|
+
|
|
37
|
+
This returns an Array which contains the response data, status code and headers.
|
|
38
|
+
|
|
39
|
+
> <Array(<SuccessResponseDictStrStr>, Integer, Hash)> health_health_get_with_http_info
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
begin
|
|
43
|
+
# Health
|
|
44
|
+
data, status_code, headers = api_instance.health_health_get_with_http_info
|
|
45
|
+
p status_code # => 2xx
|
|
46
|
+
p headers # => { ... }
|
|
47
|
+
p data # => <SuccessResponseDictStrStr>
|
|
48
|
+
rescue KeyNetra::ApiError => e
|
|
49
|
+
puts "Error when calling HealthApi->health_health_get_with_http_info: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
This endpoint does not need any parameter.
|
|
56
|
+
|
|
57
|
+
### Return type
|
|
58
|
+
|
|
59
|
+
[**SuccessResponseDictStrStr**](SuccessResponseDictStrStr.md)
|
|
60
|
+
|
|
61
|
+
### Authorization
|
|
62
|
+
|
|
63
|
+
No authorization required
|
|
64
|
+
|
|
65
|
+
### HTTP request headers
|
|
66
|
+
|
|
67
|
+
- **Content-Type**: Not defined
|
|
68
|
+
- **Accept**: application/json
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
## liveness_health_live_get
|
|
72
|
+
|
|
73
|
+
> <SuccessResponseDictStrStr> liveness_health_live_get
|
|
74
|
+
|
|
75
|
+
Liveness
|
|
76
|
+
|
|
77
|
+
### Examples
|
|
78
|
+
|
|
79
|
+
```ruby
|
|
80
|
+
require 'time'
|
|
81
|
+
require 'keynetra-client'
|
|
82
|
+
|
|
83
|
+
api_instance = KeyNetra::HealthApi.new
|
|
84
|
+
|
|
85
|
+
begin
|
|
86
|
+
# Liveness
|
|
87
|
+
result = api_instance.liveness_health_live_get
|
|
88
|
+
p result
|
|
89
|
+
rescue KeyNetra::ApiError => e
|
|
90
|
+
puts "Error when calling HealthApi->liveness_health_live_get: #{e}"
|
|
91
|
+
end
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
#### Using the liveness_health_live_get_with_http_info variant
|
|
95
|
+
|
|
96
|
+
This returns an Array which contains the response data, status code and headers.
|
|
97
|
+
|
|
98
|
+
> <Array(<SuccessResponseDictStrStr>, Integer, Hash)> liveness_health_live_get_with_http_info
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
begin
|
|
102
|
+
# Liveness
|
|
103
|
+
data, status_code, headers = api_instance.liveness_health_live_get_with_http_info
|
|
104
|
+
p status_code # => 2xx
|
|
105
|
+
p headers # => { ... }
|
|
106
|
+
p data # => <SuccessResponseDictStrStr>
|
|
107
|
+
rescue KeyNetra::ApiError => e
|
|
108
|
+
puts "Error when calling HealthApi->liveness_health_live_get_with_http_info: #{e}"
|
|
109
|
+
end
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### Parameters
|
|
113
|
+
|
|
114
|
+
This endpoint does not need any parameter.
|
|
115
|
+
|
|
116
|
+
### Return type
|
|
117
|
+
|
|
118
|
+
[**SuccessResponseDictStrStr**](SuccessResponseDictStrStr.md)
|
|
119
|
+
|
|
120
|
+
### Authorization
|
|
121
|
+
|
|
122
|
+
No authorization required
|
|
123
|
+
|
|
124
|
+
### HTTP request headers
|
|
125
|
+
|
|
126
|
+
- **Content-Type**: Not defined
|
|
127
|
+
- **Accept**: application/json
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
## readiness_health_ready_get
|
|
131
|
+
|
|
132
|
+
> <SuccessResponseDictStrObject> readiness_health_ready_get
|
|
133
|
+
|
|
134
|
+
Readiness
|
|
135
|
+
|
|
136
|
+
### Examples
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
require 'time'
|
|
140
|
+
require 'keynetra-client'
|
|
141
|
+
|
|
142
|
+
api_instance = KeyNetra::HealthApi.new
|
|
143
|
+
|
|
144
|
+
begin
|
|
145
|
+
# Readiness
|
|
146
|
+
result = api_instance.readiness_health_ready_get
|
|
147
|
+
p result
|
|
148
|
+
rescue KeyNetra::ApiError => e
|
|
149
|
+
puts "Error when calling HealthApi->readiness_health_ready_get: #{e}"
|
|
150
|
+
end
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
#### Using the readiness_health_ready_get_with_http_info variant
|
|
154
|
+
|
|
155
|
+
This returns an Array which contains the response data, status code and headers.
|
|
156
|
+
|
|
157
|
+
> <Array(<SuccessResponseDictStrObject>, Integer, Hash)> readiness_health_ready_get_with_http_info
|
|
158
|
+
|
|
159
|
+
```ruby
|
|
160
|
+
begin
|
|
161
|
+
# Readiness
|
|
162
|
+
data, status_code, headers = api_instance.readiness_health_ready_get_with_http_info
|
|
163
|
+
p status_code # => 2xx
|
|
164
|
+
p headers # => { ... }
|
|
165
|
+
p data # => <SuccessResponseDictStrObject>
|
|
166
|
+
rescue KeyNetra::ApiError => e
|
|
167
|
+
puts "Error when calling HealthApi->readiness_health_ready_get_with_http_info: #{e}"
|
|
168
|
+
end
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
|
|
173
|
+
This endpoint does not need any parameter.
|
|
174
|
+
|
|
175
|
+
### Return type
|
|
176
|
+
|
|
177
|
+
[**SuccessResponseDictStrObject**](SuccessResponseDictStrObject.md)
|
|
178
|
+
|
|
179
|
+
### Authorization
|
|
180
|
+
|
|
181
|
+
No authorization required
|
|
182
|
+
|
|
183
|
+
### HTTP request headers
|
|
184
|
+
|
|
185
|
+
- **Content-Type**: Not defined
|
|
186
|
+
- **Accept**: application/json
|
|
187
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KeyNetra::ImpactAnalysisRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **policy_change** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'keynetra-client'
|
|
13
|
+
|
|
14
|
+
instance = KeyNetra::ImpactAnalysisRequest.new(
|
|
15
|
+
policy_change: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KeyNetra::ImpactAnalysisResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **gained_access** | **Array<Integer>** | | [optional] |
|
|
8
|
+
| **lost_access** | **Array<Integer>** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'keynetra-client'
|
|
14
|
+
|
|
15
|
+
instance = KeyNetra::ImpactAnalysisResponse.new(
|
|
16
|
+
gained_access: null,
|
|
17
|
+
lost_access: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|