Pipeline: Release 4.5.0.stable25 documentation

CybercentreCanada · May 13, 2024 · 4fe8eac · 4fe8eac
1 parent 3c1bb9b
commit 4fe8eac
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/docs/odm/models/config.md b/docs/odm/models/config.md
@@ -133,7 +133,7 @@
 | :--- | :--- | :--- | :--- | :--- |
 | field | Keyword | Field to apply `pattern` to | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | pattern | Keyword | Regex pattern for auto-prop assignment | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
-| type | Enum | Type of property assignment on pattern match<br>Values:<br>`"access", "classification", "group", "multi_group", "remove_role", "role", "type"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| type | Enum | Type of property assignment on pattern match<br>Values:<br>`"access", "api_daily_quota", "api_quota", "classification", "group", "multi_group", "remove_role", "role", "submission_daily_quota", "submission_quota", "type"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | value | List [Keyword] | Assigned property value | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 
 
@@ -210,7 +210,7 @@
 | :--- | :--- | :--- | :--- | :--- |
 | field | Keyword | Field to apply `pattern` to | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | pattern | Keyword | Regex pattern for auto-prop assignment | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
-| type | Enum | Type of property assignment on pattern match<br>Values:<br>`"access", "classification", "group", "multi_group", "remove_role", "role", "type"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| type | Enum | Type of property assignment on pattern match<br>Values:<br>`"access", "api_daily_quota", "api_quota", "classification", "group", "multi_group", "remove_role", "role", "submission_daily_quota", "submission_quota", "type"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | value | List [Keyword] | Assigned property value | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 
 
@@ -791,6 +791,7 @@
 | banner | Mapping [String, Keyword] | Banner message display on the main page (format: {<language_code>: message}) | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | banner_level | Enum | Banner message level<br>Values:<br>`"error", "info", "success", "warning"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `info` |
 | debug | Boolean | Enable debugging? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
+| default_quotas | [Quotas](/assemblyline4_docs/odm/models/config/#quotas) | Default API quotas values | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [Quotas](/assemblyline4_docs/odm/models/config/#quotas) for more details. |
 | discover_url | Keyword | Discover URL | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | download_encoding | Enum | Which encoding will be used for downloads?<br>Values:<br>`"cart", "raw"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `cart` |
 | email | Email | Assemblyline admins email address | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
@@ -947,6 +948,18 @@
 | url | Keyword | URL of the upstream source's lookup service. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 
 
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+### Quotas
+> Default API and submission quota values for the system
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| concurrent_api_calls | Integer | Maximum concurrent API Calls can be running for a user. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `10` |
+| concurrent_submissions | Integer | Maximum concurrent Submission can be running for a user. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `5` |
+| daily_api_calls | Integer | Maximum daily API calls a user can issue. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `0` |
+| daily_submissions | Integer | Maximum daily submission a user can do. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `0` |
+
+
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 ### Statistics
 > Statistics

diff --git a/docs/odm/models/user.md b/docs/odm/models/user.md
@@ -5,7 +5,8 @@
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
 | agrees_with_tos | Date | Date the user agree with terms of service | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
-| api_quota | Integer | Maximum number of concurrent API requests | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `10` |
+| api_quota | Integer | None | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| api_daily_quota | Integer | None | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | apikeys | Mapping [String, [ApiKey](/assemblyline4_docs/odm/models/user/#apikey)] | Mapping of API keys | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [ApiKey](/assemblyline4_docs/odm/models/user/#apikey) for more details. |
 | apps | Mapping [String, [Apps](/assemblyline4_docs/odm/models/user/#apps)] | Applications with access to the account | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [Apps](/assemblyline4_docs/odm/models/user/#apps) for more details. |
 | can_impersonate | Boolean | Allowed to query on behalf of others? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
@@ -17,7 +18,8 @@
 | name | Keyword | Full name of the user | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | otp_sk | Keyword | Secret key to generate one time passwords | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | password | Keyword | BCrypt hash of the user's password | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
-| submission_quota | Integer | Maximum number of concurrent submissions | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `5` |
+| submission_quota | Integer | None | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| submission_daily_quota | Integer | None | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | type | List [Enum] | Type of user | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `['user']` |
 | roles | List [Enum] | Default roles for user | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 | security_tokens | Mapping [String, Keyword] | Map of security tokens | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `{}` |