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

Fix for GetList Unmarshalling Issue #630

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

anwalsh
Copy link

@anwalsh anwalsh commented May 31, 2023

Currently the GetList() function for IssueLinkTypes in OnPremise and Cloud fails to return the JSON document from the API. This is because it expects a top level array of subdocuments and not a top level document containing an array of subdocuments. I have corrected this behavior and revised the tests to ensure the behavior is correct. I have also tested this behavior against my own Jira OnPremise and Cloud instances.

What type of PR is this?

  • bug

What this PR does / why we need it:

As currently implemented GetList() does not return the expected list of IssueLinkTypes. Instead, the function call returns an empty list and an error if probed deeply enough. All tests pass against the unit tests which further cause confusion. However, directly calling the endpoint and verifying the output we can discern that the function expects a different JSON document shape than that which is returned (see the test mock of the output). This PR addresses the above behavior for tests, onpremise, and Cloud. It also hopes to verify the v2 push for each of these functions - but I'd like feedback on that from a Maintainer before I call it "good".

Which issue(s) this PR fixes:

NA - I didn't file an issue - apologies if that is incorrect, I'll be sure to redress that if we prefer that method.

Fixes #
OnPremise and Cloud unmarshalling for IssueLinkTypes array.

Special notes for your reviewer:

I'd like to be more involved with the project if I may. However, I'd likely need some guidance especially around the goals/nongoals specifically to do with the push for v2 and vision. I was wondering if there might be any mentorship ability or a channel/communication medium for one to leverage for ad hoc questions to assist in ramping/working on the project?

Additional documentation e.g., usage docs, etc.:

I had a previous PR up but I did something odd with git while trying to clean up my commits - apologies for that error.

Thank you!

Currently the GetList() function for IssueLinkTypes in OnPremise and
Cloud fails to return the JSON document from the API. This is because it
expects a top level array of subdocuments and not a top level document
containing an array of subdocuments. I have corrected this behavior and
revised the tests to ensure the behavior is correct. I have also tested
this behavior against my own Jira OnPremise and Cloud instances.
Currently the GetList() function for IssueLinkTypes in OnPremise and
Cloud fails to return the JSON document from the API. This is because it
expects a top level array of subdocuments and not a top level document
containing an array of subdocuments. I have corrected this behavior and
revised the tests to ensure the behavior is correct. I have also tested
this behavior against my own Jira OnPremise and Cloud instances.
@andygrunwald
Copy link
Owner

Thanks @anwalsh for this pr.
I am currently short on time for open-source contributions due to other/private obligations. This means the review of this PR can take a bit. Thanks for contributing to open source and thanks for understanding.

@anwalsh
Copy link
Author

anwalsh commented Jun 14, 2023

@andygrunwald no worries! I have something to fix it appears as the checks failed so I will take a look and see what I've messed up and get that sorted!

@anwalsh
Copy link
Author

anwalsh commented Jun 14, 2023

It seems to be a label only which isn't something I am not comfortable assigning - don't want to muddy the project inadvertently.

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

Successfully merging this pull request may close these issues.

None yet

2 participants