api

Documentation

Overview

Package api provides GitHub API client implementations for migration monitoring.

This package defines the GitHubClient interface and its implementation for interacting with GitHub's REST and GraphQL APIs. It supports both legacy migrations and GitHub Enterprise Importer (GEI) migrations.

The package implements rate limiting, error handling, and authentication following GitHub API best practices.

Index

• type APIError
  • func (e *APIError) Error() string
  • func (e *APIError) Unwrap() error
• type GitHubClient
  • func NewGitHubClient(token string, isLegacy bool) (GitHubClient, error)

Types

type APIError

type APIError struct {
	StatusCode int    `json:"status_code"`
	Message    string `json:"message"`
	Err        error  `json:"-"`
}

APIError represents an API error

func (*APIError) Error

func (e *APIError) Error() string

func (*APIError) Unwrap

func (e *APIError) Unwrap() error

type GitHubClient

type GitHubClient interface {
	// ListMigrations returns all migrations for the specified organization
	ListMigrations(ctx context.Context, org string, isLegacy bool) ([]models.Migration, error)
}

GitHubClient defines the interface for GitHub API operations

func NewGitHubClient

func NewGitHubClient(token string, isLegacy bool) (GitHubClient, error)

NewGitHubClient creates a new GitHub API client