github

Documentation

Overview

Package github implements AnswerHub provider

Index

• func Register(f func(provider interface{}) error)
• type Provider
  • func (provider *Provider) Search(ctx context.Context, args map[string]interface{}) ([]map[string]interface{}, error)
• type SRIRepository
• type SRITMatches
• type SRItems
• type SearchResult

Functions

func Register

func Register(f func(provider interface{}) error)

Register registers the provider

Types

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider represents the provider

func (*Provider) Search

func (provider *Provider) Search(ctx context.Context, args map[string]interface{}) ([]map[string]interface{}, error)

Search makes a search

type SRIRepository

type SRIRepository struct {
	Fullname    string `json:"full_name"`
	Description string `json:"description"`
}

SRIRepository represent the structure of the search result items repository

type SRITMatches

type SRITMatches struct {
	Fragment string `json:"fragment"`
}

SRITMatches represent the structure of the search result items text matches field

type SRItems

type SRItems struct {
	Name        string         `json:"name"`
	Path        string         `json:"path"`
	HTMLUrl     string         `json:"html_url"`
	Repository  *SRIRepository `json:"repository"`
	TextMatches []*SRITMatches `json:"text_matches"`
}

SRItems represent the structure of the search result items

type SearchResult

type SearchResult struct {
	TotalCount        int        `json:"total_count"`
	IncompleteResults bool       `json:"incomplete_results"`
	Items             []*SRItems `json:"items"`
}

SearchResult represent the structure of the search result