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

feat: Support schema discovery for CustomFields #99

Open
jeffgeorge opened this issue Dec 10, 2024 · 1 comment
Open

feat: Support schema discovery for CustomFields #99

jeffgeorge opened this issue Dec 10, 2024 · 1 comment

Comments

@jeffgeorge
Copy link

To me (and likely others) Jira data without Custom Fields is not incredibly useful, and it appears based on investigation there is presently no way through configuration alone to use this tap to pull Custom Fields.

Specifically, I've looked through the following:

I came to the same conclusion as Jean-Baptiste in the first Discussion Thread, that the only option is to maintain a fork, and add your customfield definitions to the issueStream class yourself, but I would vastly prefer not having to fork this tap entirely as it appears to still be maintained.

Assuming this research is all accurate, what's the plan for how to implement intentional support for arbitrary customfields? I'm happy to jump in and help build this, but I'd like some kind of direction of what the maintainers had in mind, specifically based on the comment in #90.

Assuming the research is not accurate, we need to update documentation to explain how to define your customfields properly, and possibly also document how to exclude customfields you don't care about so it doesn't pollute the execution log with warnings.

@jeffgeorge
Copy link
Author

In looking through other modules, I found that @edgarrmondragon's tap-zendesk handles this by adding the optional additional_parameters param to the user_fields property in the stream definition. This results in being able to define custom schema in the meltano.yml like this:

    schema:
      users:
        user_fields:
          type: object
          properties:
            test_custom_field:
              type: [string, "null"]
            test_pii_field:
              type: [integer, "null"]

...which would be perfect for the use-case I'd like to see solved.

I tried adding additional_properties=True to the bottom of the fields property definition, and then defined a customfield like this:

    schema:
      issues:
        fields:
          type: object
          properties:
            customfield_10001: # "Story Points" (float)
              type: [number, "null"]

But it didn't work: no (new) errors / warnings, and no new field created. This feels like the right track, though it wouldn't clean up the spam of warnings to the log.

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

No branches or pull requests

1 participant