go-jira icon indicating copy to clipboard operation
go-jira copied to clipboard

BREAKING CHANGE: Use create request body instead of custom parameters

Open Fank opened this issue 2 years ago • 0 comments

Description

Please describe what does this Pull Request fix or add?.

atm the use of custom fields is impossible, because the value could only be a string, so a field with type option-with-child which requires a { "value": "foo" } as value wont work. By allowing such change, the struct needed to changed so it would be a breaking change anyway. While doing that i also removed all parameters which are a "part" of the struct and put them together.

Information that is useful here:

  • The What: What is your change doing?

Allowing to transfer more complex custom field values

  • The Why: Why is your change useful/needed? What is your use case? (this helps us to understand the real world better)

Currently only the value string can be used, but more complex structure is needed to for custom fields. And the request struct type which was given is not the same which is mentioned in the jira docs, so i changed the field structure to match it again.

  • Type of change: Things like Bugfix, New feature, Code quality improvements, Dependency upgrade, Documentation, ...

New feature Code quality improvements

  • Breaking change: Yes or no? Backward compatible?

Yes, no backward compatibility

  • Related to an issue: Does this fix or close an issue? Or is related in any kind?

Not directly, maybe:

  • #417
  • #380
  • Jira Version + Type: Which Jira version and type (on-premise / cloud) you have used?

Cloud

Example:

Let us know how users can use or test this functionality.

// Example code

Checklist

Fank avatar May 30 '22 16:05 Fank