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.

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

[QualysV2] Add asset-tag related documentation #26563

Merged

Conversation

samuelFain
Copy link
Contributor

@samuelFain samuelFain commented May 16, 2023

Contributing to Cortex XSOAR Content

Make sure to register your contribution by filling the contribution registration form

The Pull Request will be reviewed only after the contribution registration form is filled.

Status

  • In Progress
  • Ready
  • In Hold - (Reason for hold)

Related Issues

fixes: link to the issue

Description

There are several API endpoints on the Qualys API that can be used in the QualysV2 integration configurations as the SERVER URL parameter.
Due to a recent issue, this PR adds relevant info about making use of the right SERVER URL parameter when using asset-tags commands.

Screenshots

image
image

Minimum version of Cortex XSOAR

  • 6.0.0
  • 6.1.0
  • 6.2.0
  • 6.5.0

Does it break backward compatibility?

  • Yes
    • Further details:
  • No

Must have

  • Tests
  • Documentation

@samuelFain samuelFain changed the title Update asset-tag related info in readme and yml [QualysV2] Update asset-tag related information May 16, 2023
@samuelFain samuelFain changed the title [QualysV2] Update asset-tag related information [QualysV2] Update asset-tag related documentation May 16, 2023
@samuelFain samuelFain changed the title [QualysV2] Update asset-tag related documentation [QualysV2] Add asset-tag related documentation May 16, 2023
@samuelFain samuelFain marked this pull request as ready for review May 17, 2023 07:30
@samuelFain samuelFain self-assigned this May 17, 2023
@samuelFain
Copy link
Contributor Author

@yuvalbenshalom,
Force merge is needed due to a known issue where xsoar_ng_server_ga instance is failing in the build.

Copy link
Contributor

@ShacharKidor ShacharKidor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

@@ -8,6 +8,7 @@ configuration:
name: url
required: true
type: 0
additionalinfo: "When using asset-tag commands, the official documentation recommends that the SERVER URL parameter should be in the following format: `https://qualysapi.<tenant>.apps.qualys.com/<end-point>`. For more details see the integration documentation."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth mentioning the format we usually use - for all the other commands.
Something like - for format assets commands use this format, instead of this format.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there are a few possible Qulays API versions and endpoints, which every user is using based on their needs and tenants I think it will only make it confusing.
This specific API format which allows using asset-tag commands is an anomaly and thats why we should document it.

@ShirleyDenkberg
Copy link
Contributor

@ShacharKidor Looks Good. Doc review completed.

@yuvalbenshalom yuvalbenshalom merged commit 1400ed8 into master May 18, 2023
19 of 20 checks passed
@yuvalbenshalom yuvalbenshalom deleted the feature/no-ref/qualysv2-update-asset-tag-documentation branch May 18, 2023 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants