Skip to content

Commit

Permalink
SDK Validate docs: 1.31.5 (#1589)
Browse files Browse the repository at this point in the history 
* SDK v1.31.5 Validate docs

* changed approved files path (#1580)

* changed approved files path

* change content branch

* Update create-docs.sh

---------

Co-authored-by: JudithB <[email protected]>
  • Loading branch information
@jbabazadeh
content-bot and jbabazadeh authored Jul 28, 2024
1 parent 7d9a87a commit 9acd32b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
4 changes: 2 additions & 2 deletions content-repo/create-docs.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ mkdir ${REL_IMGS_DIR}
echo "Copying CommonServerPython.py, demistomock.py, approved_tags.json and approved_usecases.json"
cp ${CONTENT_GIT_DIR}/Packs/Base/Scripts/CommonServerPython/CommonServerPython.py .
cp ${CONTENT_GIT_DIR}/Tests/demistomock/demistomock.py .
cp ${CONTENT_GIT_DIR}/Tests/Marketplace/approved_tags.json .
cp ${CONTENT_GIT_DIR}/Tests/Marketplace/approved_usecases.json .
cp ${CONTENT_GIT_DIR}/Config/approved_tags.json .
cp ${CONTENT_GIT_DIR}/Config/approved_usecases.json .

# Removing the DemistoClass import from CommonServerPython.py
sed -i -e '/from DemistoClassApiModule import */d' CommonServerPython.py
Expand Down
10 changes: 8 additions & 2 deletions docs/concepts/demisto-sdk-validate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ Validate will run all the validations with error codes "BA100", "BA101", "BA102"
| BC111 | Ensure that no new *required* arguments are added to an existing script. | Adding a new required argument or changing a non-required one to required without specifying a default value breaks backward compatibility. | |
| BC112 | Ensure that no parameters are removed from an existing integration. | Removed parameters can cause errors if the parameter is needed by the server of integration code. | |
| BC113 | Validate that no incident types were removed and no incident fields were changed. | We want to ensure no breaking changes are made to existing mappers so customers won't lose data between pack updates. | |
| BC114 | Ensure a pre-defined list of fields wasn't removed or modified in the integration yml. | We wish to keep our behavior between different versions of the content item so we wish to enforce backwards compatibility breaking. | |
## `CL`: Classifier
| Code | Description | Rationale | Autofixable |
|--------|---------------------------------------------------------------|-------------------------------------------------------------------------------------------|---------------|
Expand Down Expand Up @@ -235,7 +236,7 @@ Validate will run all the validations with error codes "BA100", "BA101", "BA102"
| IN121 | Validate that fetch integration has the required params in the right format. | Malformed or missing parameters can lead to errors or incomplete data. For more details, see https://xsoar.pan.dev/docs/integrations/fetching-incidents | |
| IN122 | Validate that all existing params are in the right format for feed params. | Malformed or missing parameters can lead to errors or incomplete data. For more details, see https://xsoar.pan.dev/docs/integrations/feeds | |
| IN123 | Checks if integration display name is versioned correctly, e.g.: ends with v&lt;number&gt;. | Integration display names should end with 'v&lt;number&gt;' for version clarity and consistency. | Yes |
| IN124 | Validate that a param is not hidden if it can not be hidden. | Hiding these parameters can lead to confusion and may prevent the integration from working as expected. Only the following parameters may be hidden: {'longRunning', 'feedReputation', 'feedIncremental'} | Yes |
| IN124 | Validate that a param is not hidden if it can not be hidden. | Hiding these parameters can lead to confusion and may prevent the integration from working as expected. Only the following parameters may be hidden: {'longRunning', 'feedIncremental', 'feedReputation'} | Yes |
| IN125 | Validate that the max_fetch param has a defaultvalue | To maintain optimal load in the platform, the maximal number of incidents per fetch is limited. For more details, see https://xsoar.pan.dev/docs/integrations/fetching-incidents#fetch-limit | Yes |
| IN126 | Validate that a fetch integration is not missing the first_fetch & max_fetch params. | 'first_fetch' and 'max_fetch' parameters in fetch integrations ensure correct incident retrieval. Their absence or incorrect format can lead to errors or inconsistencies. For more details, see https://xsoar.pan.dev/docs/integrations/fetching-incidents#first-run | |
| IN127 | Validate that a deprecated integration display name ends with (Deprecated). | Deprecated integrations should end with (Deprecated) in the display name to clearly indicate their status. This prevents inadvertent use of unsupported integrations. For more details, see https://xsoar.pan.dev/docs/reference/articles/deprecation-process-and-hidden-packs#how-to-deprecate-an-integration | Yes |
Expand Down Expand Up @@ -324,6 +325,7 @@ Validate will run all the validations with error codes "BA100", "BA101", "BA102"
| PB119 | Validates that all inputs used are defined. | Inputs that are used but not provided to a playbook is probably an oversight. | |
| PB122 | Validate whether branches of built-in conditional tasks are handled properly. | Ensures the playbook logic is complete. | |
| PB123 | Checks whether an ask conditional has unhandled reply options. | Checks whether an ask conditional has unhandled reply options. | |
| PB124 | Make sure that all conditional tasks contains at least 2 next tasks. | Ensure we don't miss unhandled cases in our playbook. | |
| PB125 | Validates that a condition task doesn't has only a default next-task. | Validates that a condition task doesn't has only a default next-task. | |
| PB126 | Ensure that conditional tasks have an execution path besides for the default. | We want to ensure that conditional tasks have more than path which is not the default one o/w it make no sense to have such. | |
## `PR`: Parsing Rule
Expand Down Expand Up @@ -358,4 +360,8 @@ Validate will run all the validations with error codes "BA100", "BA101", "BA102"
| SC100 | Checks if script name is versioned correctly, e.g.: ends with V&lt;number&gt;. | This standardization ensures consistency across content items. | Yes |
| SC105 | Checks that script arguments do not container the word incident in core packs | Server has a feature where the word 'incident' in the system can be replaced by any other keyword of the user's choice. To ensure compatibility with this feature, we should make sure that command names, command arguments, and script arguments in core pack integrations and scripts do not use the word 'incident'. This helps maintain the flexibility of the system and prevents potential issues caused by keyword replacement. | |
| SC106 | Checks that the script runas is not equal to DBotRole | For security reasons, the `runas` field should not be set to DBotRole. | |
| SC109 | Validate that there are no scripts with the same type and the same name. | Duplicate names cause confusion and unpredictable behaviors. | |
| SC109 | Validate that there are no scripts with the same type and the same name. | Duplicate names cause confusion and unpredictable behaviors. | |
## `ST`: Structure
| Code | Description | Rationale | Autofixable |
|--------|------------------------------------------------|---------------------------------------------|---------------|
| ST110 | Validate that the scheme's structure is valid. | Maintain valid structure for content items. | |
6 changes: 3 additions & 3 deletions docs/packs/packs-format.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ The following fields are populated in the pack metadata:
| `url` | `String` | The URL to which users should refer to in case of support needed regarding the pack. Usually is the organization support URL or the developer GitHub repository. If left empty the default support site presented to users will be the [Live Community](https://live.paloaltonetworks.com/t5/cortex-xsoar-discussions/bd-p/Cortex_XSOAR_Discussions) site.|
| `videos` | `String` | The Youtube video link of the pack.|
| `email` | `String` | The email address to which users should reach out to for support regarding the pack. |
| `categories` | `List` | The use case categories which are implemented in the pack, usually set by the integration. The list of approved categories can be found [here](https://github.com/demisto/content/blob/master/Tests/Marketplace/approved_categories.json).|
| `tags` | `List` | Tags to be attached to the pack on Cortex XSOAR marketplace. The list of approved tags can be found [here](https://github.com/demisto/content/blob/master/Tests/Marketplace/approved_tags.json). |
| `categories` | `List` | The use case categories which are implemented in the pack, usually set by the integration. The list of approved categories can be found [here](https://github.com/demisto/content/blob/master/Config/approved_categories.json).|
| `tags` | `List` | Tags to be attached to the pack on Cortex XSOAR marketplace. The list of approved tags can be found [here](https://github.com/demisto/content/blob/master/Config/approved_tags.json). |
| `created` | `String` | Pack creation time in ISO 8601 format - YYYY-MM-DDTHH:mm:ssZ, e.g. 2020-01-25T10:00:00Z |
| `useCases` | `List` | Use cases implemented by the pack. The list of approved use cases can be found [here](https://github.com/demisto/content/blob/master/Tests/Marketplace/approved_usecases.json). |
| `useCases` | `List` | Use cases implemented by the pack. The list of approved use cases can be found [here](https://github.com/demisto/content/blob/master/Config/approved_usecases.json). |
| `keywords` | `List` | List of strings by which the pack can be found in Cortex XSOAR marketplace. |
| `marketplaces` | `List` | List of marketplaces in which the pack can be found. Possible values are `xsoar` (XSOAR 6 and XSOAR 8), `xsoar_on_prem` (XSOAR 6), `xsoar_saas` (XSOAR 8), `marketplacev2` (XSIAM) and `xpanse` (XPANSE). |
| `hidden` | `Boolean` | (Optional) Whether to hide the pack from Marketplace. Updates to this pack will not be published to Marketplace and the pack cannot be installed. |
Expand Down

0 comments on commit 9acd32b

Please sign in to comment.