platformhubgithubconnections

package
v2.122.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetRepositories

func GetRepositories(client newclient.Client, connectionID string) ([]*githubconnections.Repository, error)

GetRepositories returns the GitHub repositories reachable through the given connection.

Types

type ConnectionDetails

type ConnectionDetails struct {
	ID                  string                                 `json:"Id"`
	Status              githubconnections.ConnectionStatus     `json:"Status"`
	StatusUserMessage   string                                 `json:"StatusUserMessage,omitempty"`
	Installation        *githubconnections.Installation        `json:"Installation,omitempty"`
	Repositories        []*githubconnections.Repository        `json:"Repositories"`
	UnknownRepositories []*githubconnections.UnknownRepository `json:"UnknownRepositories"`
}

ConnectionDetails represents a single Platform Hub GitHub App connection, including the repositories it grants access to which githubconnections.Connection doesn't include.

func GetByID

func GetByID(client newclient.Client, id string) (*ConnectionDetails, error)

GetByID returns the Platform Hub GitHub App connection with the given ID, along with the repositories it grants access to.

type ConnectionsQuery

type ConnectionsQuery struct {
	Skip int `uri:"skip" json:"skip"`
	Take int `uri:"take" json:"take"`
}

ConnectionsQuery represents the query parameters for listing connections. Both skip and take are required.

type ConnectionsQueryResult

type ConnectionsQueryResult struct {
	Connections   []*githubconnections.Connection `json:"Connections"`
	ItemsPerPage  int                             `json:"ItemsPerPage"`
	NumberOfPages int                             `json:"NumberOfPages"`
	TotalResults  int                             `json:"TotalResults"`
}

ConnectionsQueryResult is a paginated collection of Platform Hub GitHub App connections.

func List

func List(client newclient.Client, skip int, take int) (*ConnectionsQueryResult, error)

List returns a single page of Platform Hub GitHub App connections.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL