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

PAPP-3712 - accomodate case where JIRA is behind proxy #38

Open
wants to merge 11 commits into
base: next
Choose a base branch
from

Conversation

mctonderski-splunk
Copy link

Please ensure your pull request (PR) adheres to the following guidelines:

  • Please refer to our contributing documentation for any questions on submitting a pull request, link: Contribution Guide

Pull Request Checklist

Please check if your PR fulfills the following requirements:

  • Testing of all the changes has been performed (for bug fixes / features)
  • The manual_readme_content.md has been reviewed and added / updated if needed (for bug fixes / features)
  • Use the following format for the PR description: <App Name>: <PR Type> - <PR Description>
  • Provide release notes as part of the PR submission which describe high level points about the changes for the upcoming GA release.
  • Verify all checks are passing.
  • Do NOT use the next branch of the forked repo. Create separate feature branch for raising the PR.
  • Do NOT submit updates to dependencies unless it fixes an issue.

Pull Request Type

Please check the type of change your PR introduces:

  • New App
  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Documentation
  • Other (please describe):

Security Considerations (REQUIRED)

  • If you are exposing any endpoints using a REST handler,
    please document them in the manual_readme_content.md.
  • If this is a new connector or you are adding new actions
    • Please document in the manual_readme_content.md all methods (eg, OAuth) used to authenticate
      with the service that the connector is integrating with.
    • If any actions are unable to run on SOAR Cloud, please document this in the manual_readme_content.md.
  • Are you introducing any new cryptography modules? If yes, please elaborate their purpose:
  • Are you are accessing the file system? If yes, please verify that you are only accessing paths returned through
    the Vault API.
  • Are you are marking code to be ignored by Semgrep with nosemgrep?
    If yes, please provide justification in an additional comment next to the ignored code.

Release Notes (REQUIRED)

  • Provide release notes as part of the PR submission which describe high level points about the changes for the upcoming GA release.

What is the current behavior? (OPTIONAL)

  • Describe the current behavior that you are modifying.

What is the new behavior? (OPTIONAL)

  • Describe the behavior or changes that are being added by this PR.

Other information (OPTIONAL)

  • Any other information that is important to this PR such as screenshots of how the component looks before and after the change.

Pay close attention to (OPTIONAL)

  • Any specific code change or test case points which must be addressed/reviewed at the time of GA release.

Screenshots (if relevant)


Thanks for contributing!

ivellios
ivellios previously approved these changes Sep 17, 2024
@@ -357,6 +357,8 @@ VARIABLE | REQUIRED | TYPE | DESCRIPTION
**max_tickets** | optional | numeric | Maximum tickets (issues) for scheduled polling
**custom_fields** | optional | string | JSON formatted list of names of custom fields (case-sensitive) to be ingested
**timezone** | required | timezone | Jira instance timezone (used for timezone conversions for querying in ingestion). Refer to README
**custom_field_enumeration** | optional | boolean | Disable Field Enumeration

Choose a reason for hiding this comment

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

"Disable Field Enumeration" as a description for the custom_field_enumeration property is a bit confusing. Can't we just have "Custom Field Enumeration" or even something that is more obvious to end users?

@@ -357,6 +357,8 @@ VARIABLE | REQUIRED | TYPE | DESCRIPTION
**max_tickets** | optional | numeric | Maximum tickets (issues) for scheduled polling
**custom_fields** | optional | string | JSON formatted list of names of custom fields (case-sensitive) to be ingested
**timezone** | required | timezone | Jira instance timezone (used for timezone conversions for querying in ingestion). Refer to README
**custom_field_enumeration** | optional | boolean | Disable Field Enumeration
**internal_address_behind_proxy** | optional | string | URL address of JIRA service behind proxy (To be replaced in order to properly access)

Choose a reason for hiding this comment

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

How about changing the description to: URL address of the JIRA service behind the proxy (to be replaced for proper access)

def _get_custom_fields_for_issue(self, issue_id, action_result):
@staticmethod
def _replace_internal_with_proxy_url(value, internal_address, proxy_address):
# If the value is a string and contains the internal address, replace it with the proxy address

Choose a reason for hiding this comment

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

This comment is not needed as the next line explains what happens

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants