Skip to content

Commit 276c3ce

Browse files
committed
correcting comments
1 parent 0c1e9dc commit 276c3ce

File tree

1 file changed

+13
-67
lines changed

1 file changed

+13
-67
lines changed

MLE.md

Lines changed: 13 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ class Configuration:
6161
configuration_dictionary = {
6262
"useMLEGlobally": True, # Globally MLE will be enabled for all MLE supported APIs
6363
"mapToControlMLEonAPI": {
64-
"apiFunctionName1": False, # Disable MLE for this API
65-
"apiFunctionName2": True # Enable MLE for this API
64+
"apiFunctionName1": False, # if want to disable the particular API from list of MLE supported APIs
65+
"apiFunctionName2": True # if want to enable MLE on API which is not in the list of supported MLE APIs for used version of REST SDK
6666
},
6767
"mleKeyAlias": "Custom_Key_Alias" # Optional custom value provided by Cybs
6868
}
@@ -73,22 +73,22 @@ class Configuration:
7373
def __init__(self):
7474
self.useMLEGlobally = True
7575
self.mapToControlMLEonAPI = {
76-
"apiFunctionName1": False, # Disable MLE for this API
77-
"apiFunctionName2": True # Enable MLE for this API
76+
"apiFunctionName1": False, # if want to disable the particular API from list of MLE supported APIs
77+
"apiFunctionName2": True # if want to enable MLE on API which is not in the list of supported MLE APIs for used version of REST SDK
7878
}
79-
self.mleKeyAlias = "Custom_Key_Alias"
80-
```
79+
self.mleKeyAlias = "Custom_Key_Alias" # Optional custom value provided by Cybs
80+
```
8181

8282
### Option 3: Disable MLE globally and enable for specific APIs
8383

8484
```python
8585
configuration_dictionary = {
8686
"useMLEGlobally": False, # Globally MLE will be disabled for all APIs
8787
"mapToControlMLEonAPI": {
88-
"apiFunctionName1": True, # Enable MLE for this API
89-
"apiFunctionName2": True # Enable MLE for this API
88+
"apiFunctionName1": True, # if want to enable MLE for API1
89+
"apiFunctionName2": True # if want to enable MLE for API2
9090
},
91-
"mleKeyAlias": "Custom_Key_Alias"
91+
"mleKeyAlias": "Custom_Key_Alias" # optional if any custom value provided by Cybs
9292
}
9393

9494
# OR
@@ -97,64 +97,10 @@ class Configuration:
9797
def __init__(self):
9898
self.useMLEGlobally = False # Globally MLE will be disabled for all APIs
9999
self.mapToControlMLEonAPI = {
100-
"apiFunctionName1": True, # Enable MLE for this API
101-
"apiFunctionName2": True # Enable MLE for this API
102-
}
103-
self.mleKeyAlias = "Custom_Key_Alias"
104-
```
105-
106-
### Another example with MLE enabled globally
107-
108-
```python
109-
mle_map = {
110-
"apiFunctionName1": False, # Disable MLE for this API
111-
"apiFunctionName2": True # Enable MLE for this API
112-
}
113-
114-
configuration_dictionary = {
115-
"useMLEGlobally": True, # Globally MLE will be enabled for all APIs
116-
"mapToControlMLEonAPI": mle_map,
117-
"mleKeyAlias": "Custom_Key_Alias"
118-
}
119-
120-
# OR
121-
122-
class Configuration:
123-
def __init__(self):
124-
self.useMLEGlobally = True # Globally MLE will be enabled for all APIs
125-
mle_map = {
126-
"apiFunctionName1": False, # Disable MLE for this API
127-
"apiFunctionName2": True # Enable MLE for this API
128-
}
129-
self.mapToControlMLEonAPI = mle_map
130-
self.mleKeyAlias = "Custom_Key_Alias"
131-
```
132-
133-
### Another example with MLE disabled globally
134-
135-
```python
136-
mle_map = {
137-
"apiFunctionName1": True, # Enable MLE for this API
138-
"apiFunctionName2": True # Enable MLE for this API
139-
}
140-
141-
configuration_dictionary = {
142-
"useMLEGlobally": False, # Globally MLE will be disabled for all APIs
143-
"mapToControlMLEonAPI": mle_map,
144-
"mleKeyAlias": "Custom_Key_Alias"
145-
}
146-
147-
# OR
148-
149-
class Configuration:
150-
def __init__(self):
151-
self.useMLEGlobally = False # Globally MLE will be disabled for all APIs
152-
mle_map = {
153-
"apiFunctionName1": True, # Enable MLE for this API
154-
"apiFunctionName2": True # Enable MLE for this API
155-
}
156-
self.mapToControlMLEonAPI = mle_map
157-
self.mleKeyAlias = "Custom_Key_Alias"
100+
"apiFunctionName1": True, # if want to enable MLE for API1
101+
"apiFunctionName2": True # if want to enable MLE for API2
102+
},
103+
self.mleKeyAlias = "Custom_Key_Alias" # optional if any custom value provided by Cybs
158104
```
159105

160106
In the above examples:

0 commit comments

Comments
 (0)