fix: [CODE-2134]: replace include_description with exclude_description param (#2808)

app/api/controller/githook/post_receive.go

@@ -225,6 +225,8 @@ func (c *Controller) suggestPullRequest(
 		States: []enum.PullReqState{enum.PullReqStateOpen},
 		Order:  enum.OrderAsc,
 		Sort:   enum.PullReqSortCreated,
+		// don't care about the PR description, omit it from the response
+		ExcludeDescription: true,
 	})
 	if err != nil {
 		log.Ctx(ctx).Warn().Err(err).Msgf(

app/api/controller/pullreq/controller.go

@@ -288,14 +288,15 @@ func (c *Controller) checkIfAlreadyExists(ctx context.Context,
 	targetRepoID, sourceRepoID int64, targetBranch, sourceBranch string,
 ) error {
 	existing, err := c.pullreqStore.List(ctx, &types.PullReqFilter{
-		SourceRepoID: sourceRepoID,
-		SourceBranch: sourceBranch,
-		TargetRepoID: targetRepoID,
-		TargetBranch: targetBranch,
-		States:       []enum.PullReqState{enum.PullReqStateOpen},
-		Size:         1,
-		Sort:         enum.PullReqSortNumber,
-		Order:        enum.OrderAsc,
+		SourceRepoID:       sourceRepoID,
+		SourceBranch:       sourceBranch,
+		TargetRepoID:       targetRepoID,
+		TargetBranch:       targetBranch,
+		States:             []enum.PullReqState{enum.PullReqStateOpen},
+		Size:               1,
+		Sort:               enum.PullReqSortNumber,
+		Order:              enum.OrderAsc,
+		ExcludeDescription: true,
 	})
 	if err != nil {
 		return fmt.Errorf("failed to get existing pull requests: %w", err)

app/api/openapi/pullreq.go

@@ -378,11 +378,11 @@ var QueryParameterValueID = openapi3.ParameterOrRef{
 	},
 }
 
-var queryParameterIncludeDescription = openapi3.ParameterOrRef{
+var queryParameterExcludeDescription = openapi3.ParameterOrRef{
 	Parameter: &openapi3.Parameter{
-		Name:        request.QueryParamIncludeDescription,
+		Name:        request.QueryParamExcludeDescription,
 		In:          openapi3.ParameterInQuery,
-		Description: ptr.String("By providing this parameter the description would be included in the response."),
+		Description: ptr.String("By providing this parameter the description would be excluded from the response."),
 		Required:    ptr.Bool(false),
 		Schema: &openapi3.SchemaOrRef{
 			Schema: &openapi3.Schema{
@@ -494,7 +494,7 @@ func pullReqOperations(reflector *openapi3.Reflector) {
 		queryParameterQueryPullRequest, queryParameterCreatedByPullRequest,
 		queryParameterOrder, queryParameterSortPullRequest,
 		queryParameterCreatedLt, queryParameterCreatedGt, queryParameterUpdatedLt, queryParameterUpdatedGt,
-		queryParameterIncludeDescription,
+		queryParameterExcludeDescription,
 		QueryParameterPage, QueryParameterLimit,
 		QueryParameterLabelID, QueryParameterValueID,
 		queryParameterAuthorID, queryParameterCommenterID, queryParameterMentionedID,

app/api/openapi/space.go

@@ -595,7 +595,7 @@ func spaceOperations(reflector *openapi3.Reflector) {
 		queryParameterSourceBranchPullRequest, queryParameterTargetBranchPullRequest,
 		queryParameterQueryPullRequest, queryParameterCreatedByPullRequest,
 		queryParameterCreatedLt, queryParameterCreatedGt, queryParameterUpdatedLt,
-		queryParameterIncludeDescription, queryParameterIncludeSubspaces,
+		queryParameterExcludeDescription, queryParameterIncludeSubspaces,
 		QueryParameterLimit,
 		QueryParameterLabelID, QueryParameterValueID,
 		queryParameterAuthorID, queryParameterCommenterID, queryParameterMentionedID,

app/api/request/pullreq.go

@@ -34,7 +34,7 @@ const (
 	QueryParamReviewerID         = "reviewer_id"
 	QueryParamReviewDecision     = "review_decision"
 	QueryParamMentionedID        = "mentioned_id"
-	QueryParamIncludeDescription = "include_description"
+	QueryParamExcludeDescription = "exclude_description"
 )
 
 func GetPullReqNumberFromPath(r *http.Request) (int64, error) {
@@ -125,7 +125,7 @@ func ParsePullReqFilter(r *http.Request) (*types.PullReqFilter, error) {
 		return nil, fmt.Errorf("encountered error parsing pr edited filter: %w", err)
 	}
 
-	includeDescription, err := QueryParamAsBoolOrDefault(r, QueryParamIncludeDescription, false)
+	excludeDescription, err := QueryParamAsBoolOrDefault(r, QueryParamExcludeDescription, false)
 	if err != nil {
 		return nil, fmt.Errorf("encountered error parsing include description filter: %w", err)
 	}
@@ -173,7 +173,7 @@ func ParsePullReqFilter(r *http.Request) (*types.PullReqFilter, error) {
 		ReviewerID:         reviewerID,
 		ReviewDecisions:    reviewDecisions,
 		MentionedID:        mentionedID,
-		IncludeDescription: includeDescription,
+		ExcludeDescription: excludeDescription,
 		CreatedFilter:      createdFilter,
 		UpdatedFilter:      updatedFilter,
 		EditedFilter:       editedFilter,

app/store/database/pullreq.go

@@ -556,9 +556,9 @@ func (s *PullReqStore) Stream(ctx context.Context, opts *types.PullReqFilter) (<
 func (s *PullReqStore) listQuery(opts *types.PullReqFilter) squirrel.SelectBuilder {
 	var stmt squirrel.SelectBuilder
 
-	columns := pullReqColumnsNoDescription
-	if opts.IncludeDescription {
-		columns = pullReqColumns
+	columns := pullReqColumns
+	if opts.ExcludeDescription {
+		columns = pullReqColumnsNoDescription
 	}
 
 	if len(opts.LabelID) > 0 || len(opts.ValueID) > 0 || opts.CommenterID > 0 || opts.MentionedID > 0 {

types/pullreq.go

@@ -163,7 +163,7 @@ type PullReqFilter struct {
 	ReviewerID         int64                        `json:"reviewer_id"`
 	ReviewDecisions    []enum.PullReqReviewDecision `json:"review_decisions"`
 	MentionedID        int64                        `json:"mentioned_id"`
-	IncludeDescription bool                         `json:"include_description"`
+	ExcludeDescription bool                         `json:"exclude_description"`
 	CreatedFilter
 	UpdatedFilter
 	EditedFilter