Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK Validate docs: 1.31.6 #1594

Closed
wants to merge 1 commit into from
Closed

SDK Validate docs: 1.31.6 #1594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/concepts/demisto-sdk-validate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,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<number>. | Integration display names should end with 'v<number>' 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', 'feedIncremental', 'feedReputation'} | 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: {'feedReputation', 'longRunning', 'feedIncremental'} | 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 @@ -345,9 +345,11 @@ Validate will run all the validations with error codes "BA100", "BA101", "BA102"
| RM113 | Validate that non of the readme lines contains the disallowed copyright section keywords. | Content in the Cortex marketplace is licensed under the MIT license. | |
| RM114 | Validate README images used in README exist. | Missing images are not shown in rendered markdown | |
## `RN`: Release Note
| Code | Description | Rationale | Autofixable |
|--------|-----------------------------------------------------------|----------------------------------------------------------------------------------|---------------|
| RN103 | Validate that the pack contains a full release note file. | Meaningful, complete documentations make it easier for users to use the content. | |
| Code | Description | Rationale | Autofixable |
|--------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|---------------|
| RN103 | Validate that the pack contains a full release note file. | Meaningful, complete documentations make it easier for users to use the content. | |
| RN108 | Validate that a new pack doesn't have a RN, | New Packs doesn't require release notes since they don't have any updates. | |
| RN114 | Validate the existence of content types in the first-level headers (####) and the content items in second-level headers (#####). | Providing documentation with accurate information and avoiding confusion. | |
## `RP`: Reputation (Incident Type)
| Code | Description | Rationale | Autofixable |
|--------|------------------------------------------------------------------------|-------------------------------------------------------------|---------------|
Expand Down
Loading