github

package
v1.3.116 Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package github provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Code

type Code = string

Code defines model for code.

type CoreMeshkitError400

type CoreMeshkitError400 = core.MeshkitError

CoreMeshkitError400 A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.

type CoreMeshkitError403

type CoreMeshkitError403 = core.MeshkitError

CoreMeshkitError403 A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.

type CoreMeshkitError404

type CoreMeshkitError404 = core.MeshkitError

CoreMeshkitError404 A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.

type CoreMeshkitError409 added in v1.3.71

type CoreMeshkitError409 = core.MeshkitError

CoreMeshkitError409 A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.

type CoreMeshkitError500

type CoreMeshkitError500 = core.MeshkitError

CoreMeshkitError500 A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.

type CoreMeshkitError502

type CoreMeshkitError502 = core.MeshkitError

CoreMeshkitError502 A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.

type Flow

type Flow string

Flow defines model for flow.

const (
	FlowAuthorize Flow = "authorize"
	FlowInstall   Flow = "install"
)

Defines values for Flow.

type GithubConnectionMetadata

type GithubConnectionMetadata struct {
	// InstallationId The installation the connection wizard opens on; always one of `installations`.
	InstallationId *string `json:"installationId,omitempty" yaml:"installationId,omitempty"`

	// Installations The verified installations - those GitHub listed for the owner's GitHub account at the last authorization. Absent on a connection that predates verification (which must be re-authorized); an empty set is never stored.
	Installations *[]GithubInstallation `json:"installations,omitempty" yaml:"installations,omitempty"`

	// InstallationsVerifiedAt When `installations` was last verified with GitHub.
	InstallationsVerifiedAt *time.Time `json:"installationsVerifiedAt,omitempty" yaml:"installationsVerifiedAt,omitempty"`

	// SnapshotPaths Per-repository snapshot path preferences.
	SnapshotPaths *[]map[string]string `json:"snapshotPaths,omitempty" yaml:"snapshotPaths,omitempty"`
}

GithubConnectionMetadata Metadata of a `kind: github` connection, as Meshery Cloud writes it. `installations`, `installationId` and `installationsVerifiedAt` are server-written: a connection edit can neither set nor erase them (see `updateConnection`).

type GithubInstallation

type GithubInstallation struct {
	// Account Login of the account the App is installed on.
	Account *string `json:"account,omitempty" yaml:"account,omitempty"`

	// AccountType Type of the account the App is installed on, as GitHub names it.
	AccountType *GithubInstallationAccountType `json:"accountType,omitempty" yaml:"accountType,omitempty"`

	// Id GitHub App installation id.
	ID string `json:"id" yaml:"id"`
}

GithubInstallation One verified GitHub App installation.

type GithubInstallationAccountType

type GithubInstallationAccountType string

GithubInstallationAccountType Type of the account the App is installed on, as GitHub names it.

const (
	Organization GithubInstallationAccountType = "Organization"
	User         GithubInstallationAccountType = "User"
)

Defines values for GithubInstallationAccountType.

type GithubInstallationId

type GithubInstallationId = string

GithubInstallationId defines model for githubInstallationId.

type GithubInstallationRepositoryPage

type GithubInstallationRepositoryPage map[string]interface{}

GithubInstallationRepositoryPage One page of GitHub's `GET /installation/repositories` answer, passed through as GitHub returns it (`total_count`, `repositories`).

type GithubRepositoryTree

type GithubRepositoryTree = []GithubRepositoryTreeItem

GithubRepositoryTree One page of a repository's file tree.

type GithubRepositoryTreeItem

type GithubRepositoryTreeItem struct {
	// Children The items under a directory, each shaped as a `GithubRepositoryTreeItem`.
	Children *[]map[string]interface{} `json:"children,omitempty" yaml:"children,omitempty"`

	// Entry GitHub's tree entry for the item, passed through as GitHub returns it.
	Entry *map[string]interface{} `json:"entry,omitempty" yaml:"entry,omitempty"`

	// Id A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
	ID *core.Uuid `json:"id,omitempty" yaml:"id,omitempty"`

	// Label Display name of the file or directory.
	Label *string `json:"label,omitempty" yaml:"label,omitempty"`

	// Type Kind of the tree item, such as a file or a directory.
	Type *string `json:"type,omitempty" yaml:"type,omitempty"`
}

GithubRepositoryTreeItem One file or directory of a repository's file tree, with its children.

type GithubSetupAction

type GithubSetupAction string

GithubSetupAction defines model for githubSetupAction.

const (
	GithubSetupActionInstall GithubSetupAction = "install"
	GithubSetupActionRequest GithubSetupAction = "request"
	GithubSetupActionUpdate  GithubSetupAction = "update"
)

Defines values for GithubSetupAction.

type GithubWorkflowInstallPayload

type GithubWorkflowInstallPayload struct {
	// Repositories Repositories as `<owner>/<repo>`.
	Repositories []string `json:"repositories" yaml:"repositories"`
}

GithubWorkflowInstallPayload The repositories to commit the Kanvas workflow into.

type GithubWorkflowInstallResponse

type GithubWorkflowInstallResponse = []map[string]GithubWorkflowInstallResult

GithubWorkflowInstallResponse One single-key entry per requested repository, keyed by `<owner>/<repo>`.

type GithubWorkflowInstallResult

type GithubWorkflowInstallResult struct {
	// Code HTTP-style status of the repository's outcome; `400` for a malformed repository identifier.
	Code *int `json:"code,omitempty" yaml:"code,omitempty"`

	// Description The outcome, in words.
	Description *string `json:"description,omitempty" yaml:"description,omitempty"`
}

GithubWorkflowInstallResult The outcome of committing the workflow into one repository.

type GithubWorkflowVerification

type GithubWorkflowVerification struct {
	// Error Why the repository cannot take the workflow.
	Error *string `json:"error,omitempty" yaml:"error,omitempty"`

	// FileUrl URL of the workflow file already present.
	FileUrl *string `json:"fileUrl,omitempty" yaml:"fileUrl,omitempty"`

	// Status `ok` when no workflow is present; `error` when one is (`fileUrl` names it) or the check failed (`error` says why).
	Status GithubWorkflowVerificationStatus `json:"status" yaml:"status"`
}

GithubWorkflowVerification Whether the Kanvas workflow is already present in a repository.

type GithubWorkflowVerificationStatus

type GithubWorkflowVerificationStatus string

GithubWorkflowVerificationStatus `ok` when no workflow is present; `error` when one is (`fileUrl` names it) or the check failed (`error` says why).

Defines values for GithubWorkflowVerificationStatus.

type IgnoredInstallationId

type IgnoredInstallationId = string

IgnoredInstallationId defines model for ignoredInstallationId.

type InstallationIdQuery

type InstallationIdQuery = string

InstallationIdQuery defines model for installationIdQuery.

type Owner

type Owner = string

Owner defines model for owner.

type Page

type Page = int

Page defines model for page.

type PageSize

type PageSize = int

PageSize defines model for pageSize.

type Repo

type Repo = string

Repo defines model for repo.

type RepositoryName

type RepositoryName = string

RepositoryName defines model for repositoryName.

type RepositoryRef added in v1.3.71

type RepositoryRef = string

RepositoryRef defines model for repositoryRef.

type State

type State = string

State defines model for state.

Jump to

Keyboard shortcuts

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