issues

Documentation

Overview

Lists the issues reported in a single file mentioned by the user

Lists the issues reported in the whole project

Index

• type FileIssuesListParams
• type FileIssuesListRequest
  • func (f FileIssuesListRequest) Do(ctx context.Context, client IGQLClient) ([]issues.Issue, error)
• type FileIssuesResponse
• type IGQLClient
• type IssuesListParams
• type IssuesListRequest
  • func (i IssuesListRequest) Do(ctx context.Context, client IGQLClient) ([]issues.Issue, error)
• type IssuesListResponse

Types

type FileIssuesListParams

type FileIssuesListParams struct {
	Owner    string
	RepoName string
	Provider string
	FilePath string
	Limit    int
}

type FileIssuesListRequest

type FileIssuesListRequest struct {
	Params FileIssuesListParams
}

Request struct

func (FileIssuesListRequest) Do

func (f FileIssuesListRequest) Do(ctx context.Context, client IGQLClient) ([]issues.Issue, error)

type FileIssuesResponse

type FileIssuesResponse struct {
	Repository struct {
		Issues struct {
			Edges []struct {
				Node struct {
					Occurrences struct {
						Edges []struct {
							Node struct {
								Path      string `json:"path"`
								BeginLine int    `json:"beginLine"`
								EndLine   int    `json:"endLine"`
								Issue     struct {
									Title         string `json:"title"`
									Shortcode     string `json:"shortcode"`
									Category      string `json:"category"`
									IsRecommended bool   `json:"isRecommended"`
									Analyzer      struct {
										Name      string `json:"name"`
										Shortcode string `json:"shortcode"`
									} `json:"analyzer"`
								} `json:"issue"`
							} `json:"node"`
						} `json:"edges"`
					} `json:"occurrences"`
				} `json:"node"`
			} `json:"edges"`
		} `json:"issues"`
	} `json:"repository"`
}

Response struct

type IGQLClient

type IGQLClient interface {
	GQL() *graphql.Client
	GetToken() string
}

GraphQL client interface

type IssuesListParams

type IssuesListParams struct {
	Owner    string
	RepoName string
	Provider string
	Limit    int
}

type IssuesListRequest

type IssuesListRequest struct {
	Params IssuesListParams
}

func (IssuesListRequest) Do

func (i IssuesListRequest) Do(ctx context.Context, client IGQLClient) ([]issues.Issue, error)

type IssuesListResponse

type IssuesListResponse struct {
	Repository struct {
		Issues struct {
			Edges []struct {
				Node struct {
					Occurrences struct {
						Edges []struct {
							Node struct {
								Path      string `json:"path"`
								BeginLine int    `json:"beginLine"`
								EndLine   int    `json:"endLine"`
								Issue     struct {
									Title         string `json:"title"`
									Shortcode     string `json:"shortcode"`
									Category      string `json:"category"`
									IsRecommended bool   `json:"isRecommended"`
									Analyzer      struct {
										Name      string `json:"name"`
										Shortcode string `json:"shortcode"`
									} `json:"analyzer"`
								} `json:"issue"`
							} `json:"node"`
						} `json:"edges"`
					} `json:"occurrences"`
				} `json:"node"`
			} `json:"edges"`
		} `json:"issues"`
	} `json:"repository"`
}