Allow API endpoints to determine default boolean option values

filter.go

@@ -38,7 +38,7 @@ type Filter struct {
 
 // GetMyFiltersQueryOptions specifies the optional parameters for the Get My Filters method
 type GetMyFiltersQueryOptions struct {
-	IncludeFavourites bool   `url:"includeFavourites,omitempty"`
+	IncludeFavourites *bool  `url:"includeFavourites,omitempty"`
 	Expand            string `url:"expand,omitempty"`
 }
 

issue.go

@@ -34,9 +34,9 @@ type IssueService struct {
 
 // UpdateQueryOptions specifies the optional parameters to the Edit issue
 type UpdateQueryOptions struct {
-	NotifyUsers            bool `url:"notifyUsers,omitempty"`
-	OverrideScreenSecurity bool `url:"overrideScreenSecurity,omitempty"`
-	OverrideEditableFlag   bool `url:"overrideEditableFlag,omitempty"`
+	NotifyUsers            *bool `url:"notifyUsers,omitempty"`
+	OverrideScreenSecurity *bool  `url:"overrideScreenSecurity,omitempty"`
+	OverrideEditableFlag   *bool  `url:"overrideEditableFlag,omitempty"`
 }
 
 // Issue represents a Jira issue.
@@ -544,8 +544,8 @@ type GetQueryOptions struct {
 	// Properties is the list of properties to return for the issue. By default no properties are returned.
 	Properties string `url:"properties,omitempty"`
 	// FieldsByKeys if true then fields in issues will be referenced by keys instead of ids
-	FieldsByKeys  bool   `url:"fieldsByKeys,omitempty"`
-	UpdateHistory bool   `url:"updateHistory,omitempty"`
+	FieldsByKeys  *bool  `url:"fieldsByKeys,omitempty"`
+	UpdateHistory *bool  `url:"updateHistory,omitempty"`
 	ProjectKeys   string `url:"projectKeys,omitempty"`
 }
 
@@ -558,12 +558,12 @@ type GetWorklogsQueryOptions struct {
 }
 
 type AddWorklogQueryOptions struct {
-	NotifyUsers          bool   `url:"notifyUsers,omitempty"`
+	NotifyUsers          *bool  `url:"notifyUsers,omitempty"`
 	AdjustEstimate       string `url:"adjustEstimate,omitempty"`
 	NewEstimate          string `url:"newEstimate,omitempty"`
 	ReduceBy             string `url:"reduceBy,omitempty"`
 	Expand               string `url:"expand,omitempty"`
-	OverrideEditableFlag bool   `url:"overrideEditableFlag,omitempty"`
+	OverrideEditableFlag *bool  `url:"overrideEditableFlag,omitempty"`
 }
 
 // CustomFields represents custom fields of Jira

jira_test.go

@@ -293,6 +293,51 @@ func TestClient_NewRequest_EmptyBody(t *testing.T) {
 	}
 }
 
+// Tests that addOptions correctly serialises *bools, which are used to convey the desired value of
+// options that default to true on the API endpoint if a value is not specified in the request:
+//
+// | Option value | Expected outcome               |
+// | ------------ | ------------------------------ |
+// | *true        | opt=true in request            |
+// | *false       | opt=false in request           |
+// | nil          | Determined by the API endpoint |
+func Test_addOptions_Bool_Pointer(t *testing.T) {
+	apiEndpoint := "rest/api/2/issue/123"
+
+	for _, test := range []struct {
+		Description string
+		Opts        *UpdateQueryOptions
+		Expected    string
+	}{
+		{
+			Description: "*bool implicitly nil",
+			Opts:        &UpdateQueryOptions{},
+			Expected:    "",
+		},
+		{
+			Description: "*bool explicitly nil",
+			Opts:        &UpdateQueryOptions{NotifyUsers: nil},
+			Expected:    "",
+		},
+		{
+			Description: "*bool explicitly true",
+			Opts:        &UpdateQueryOptions{NotifyUsers: Bool(true)},
+			Expected:    "?notifyUsers=true",
+		},
+		{
+			Description: "*bool explicitly false",
+			Opts:        &UpdateQueryOptions{NotifyUsers: Bool(false)},
+			Expected:    "?notifyUsers=false",
+		},
+	} {
+		t.Run(test.Description, func(t *testing.T) {
+			actual, err := addOptions(apiEndpoint, test.Opts)
+			assert.NoError(t, err)
+			assert.Equal(t, apiEndpoint + test.Expected, actual)
+		})
+	}
+}
+
 func TestClient_NewMultiPartRequest(t *testing.T) {
 	c, err := NewClient(nil, testJiraInstanceURL)
 	if err != nil {