ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-14 00:07:14 +03:00
Code Issues Projects Releases Wiki Activity

made redact_fields into delete_fields

Browse Source 
otherwise there are type issues
This commit is contained in:
A_D 2021-07-03 15:53:45 +02:00
parent 4c9896569b
commit 6c56b9851a
No known key found for this signature in database
GPG Key ID: 4BE9EB7DF45076C4
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/Killswitches.md
View File

@ -21,9 +21,9 @@ The `kill_switches` array contains kill switch objects. Each contains the follow
Each entry in `kills` contains a `reason` and `additional_data` field. `reason` is self explanatory, however
additional_data can contain various things. They are outlaid below:
| Key | Type | Description |
| -------------: | :---------: | :-------------------------------------------------------------------- |
| `redact_field` | `List[str]` | A list of fields in the matching event to be redacted, if they exist. |
| Key | Type | Description |
| --------------: | :---------: | :------------------------------------------------------------------- |
| `delete_fields` | `List[str]` | A list of fields in the matching event to be removed, if they exist. |
An example follows:
@ -60,12 +60,13 @@ The version of the JSON file will be automatically upgraded if possible by the c
## Currently supported killswitch strings
The current recognised (to EDMC and its internal plugins) killswitch strings are as follows:
| Kill Switch | Description |
| :----------------------------------------------------- | :------------------------------------------------------------------------------------------- |
| `plugins.eddn.send` | Disables all use of the send method on EDDN (effectively disables EDDN updates) |
| `plugins.(eddn\|inara\|edsm\|eddb).journal` | Disables all journal processing for EDDN/EDSM/INARA |
| `plugins.(edsm\|inara).worker` | Disables the EDSM/INARA worker thread (effectively disables updates) (does not close thread) |
| `plugins.(eddn\|inara\|edsm).journal.event.$eventname` | Specific events to disable processing for |
| Kill Switch | Description |
| :----------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- |
| `plugins.eddn.send` | Disables all use of the send method on EDDN (effectively disables EDDN updates) |
| `plugins.(eddn\|inara\|edsm\|eddb).journal` | Disables all journal processing for EDDN/EDSM/INARA |
| `plugins.(edsm\|inara).worker` | Disables the EDSM/INARA worker thread (effectively disables updates) (does not close thread) |
| `plugins.(edsm\|inara).worker.$eventname` | Disables the EDSM/INARA worker for the given eventname, OR if delete_fields exists, removes the fields from the event |
| `plugins.(eddn\|inara\|edsm).journal.event.$eventname` | Specific events to disable processing for. OR, if delete_fields exists as additional_data, the fields listed will be removed before processing |
## File location