Pipeline: Release 4.5.0.stable40 documentation

CybercentreCanada · Jul 29, 2024 · c556b50 · c556b50
1 parent c99faa0
commit c556b50
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 1 deletion.
diff --git a/docs/odm/messages/task.md b/docs/odm/messages/task.md
@@ -30,7 +30,8 @@
 | temporary_submission_data | List [[DataItem](/assemblyline4_docs/odm/messages/task/#dataitem)] | Temporary submission data | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 | deep_scan | Boolean | Perform deep scanning | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_cache | Boolean | Whether the service cache should be ignored during the processing of this task | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
-| ignore_dynamic_recursion_prevention | Boolean | Whether the service should ignore the dynamic recursion prevention or not | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| ignore_recursion_prevention | Boolean | Whether the service should ignore recursion prevention or not | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| ignore_dynamic_recursion_prevention | Boolean | Whether the service should ignore dynamic recursion prevention or not | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_filtering | Boolean | Should the service filter it's output? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | priority | Integer | Priority for processing order | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `0` |
 | safelist_config | [ServiceSafelist](/assemblyline4_docs/odm/models/config/#servicesafelist) | Safelisting configuration (as defined in global configuration) | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [ServiceSafelist](/assemblyline4_docs/odm/models/config/#servicesafelist) for more details. |

diff --git a/docs/odm/models/service.md b/docs/odm/models/service.md
@@ -31,6 +31,7 @@
 | dependencies | Mapping [String, [DependencyConfig](/assemblyline4_docs/odm/models/service/#dependencyconfig)] | Dependency configuration for service | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [DependencyConfig](/assemblyline4_docs/odm/models/service/#dependencyconfig) for more details. |
 | update_channel | Enum | What channel to watch for service updates?<br>Values:<br>`"beta", "dev", "rc", "stable"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `stable` |
 | update_config | [UpdateConfig](/assemblyline4_docs/odm/models/service/#updateconfig) | Update configuration for fetching external resources | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| recursion_prevention | List [Keyword] | List of service names/categories where recursion is prevented. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)

diff --git a/docs/odm/models/service_delta.md b/docs/odm/models/service_delta.md
@@ -31,6 +31,7 @@
 | dependencies | Mapping [String, [DependencyConfigDelta](/assemblyline4_docs/odm/models/service_delta/#dependencyconfigdelta)] | Refer to:<br>[Service](../service/#service) | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [DependencyConfigDelta](/assemblyline4_docs/odm/models/service_delta/#dependencyconfigdelta) for more details. |
 | update_channel | Enum | Refer to:<br>[Service](../service/#service)<br>Values:<br>`"beta", "dev", "rc", "stable"` | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | update_config | [UpdateConfigDelta](/assemblyline4_docs/odm/models/service_delta/#updateconfigdelta) | Refer to:<br>[Service](../service/#service) | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| recursion_prevention | List [Keyword] | Refer to:<br>[Service](../service/#service) | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)

diff --git a/docs/odm/models/submission.md b/docs/odm/models/submission.md
@@ -48,6 +48,7 @@
 | generate_alert | Boolean | Should this submission generate an alert? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | groups | List [Keyword] | List of groups related to this scan | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 | ignore_cache | Boolean | Ignore the cached service results? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| ignore_recursion_prevention | Boolean | Should we ignore recursion prevention? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_dynamic_recursion_prevention | Boolean | Should we ignore dynamic recursion prevention? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_filtering | Boolean | Should we ignore filtering services? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_size | Boolean | Ignore the file size limits? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |

diff --git a/docs/odm/models/user_settings.md b/docs/odm/models/user_settings.md
@@ -15,6 +15,7 @@
 | generate_alert | Boolean | Generate an alert? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_cache | Boolean | Ignore service caching? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_dynamic_recursion_prevention | Boolean | Ignore dynamic recursion prevention? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| ignore_recursion_prevention | Boolean | Ignore all service recursion prevention? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_filtering | Boolean | Ignore filtering services? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | malicious | Boolean | Is the file submitted already known to be malicious? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | priority | Integer | Default priority for the submissions | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `1000` |