README
¶
Go module for kdn
Usage:
go get github.com/openkaiden/kdn-api/cli/go@latest
package mypackage
import (
api "github.com/openkaiden/kdn-api/cli/go"
)
var list = api.AgentsList{}
Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.6.0 DO NOT EDIT.
*********************************************************************
- Copyright (C) 2026 Red Hat, Inc. *
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at *
- http://www.apache.org/licenses/LICENSE-2.0 *
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. *
- SPDX-License-Identifier: Apache-2.0 *********************************************************************
Index ¶
- type Error
- type Info
- type ProviderInfo
- type ProviderName
- type ProviderParam
- type ProvidersList
- type RuntimeInfo
- type RuntimesList
- type SecretInfo
- type SecretName
- type SecretService
- type SecretServicesList
- type SecretsList
- type Workspace
- type WorkspaceForward
- type WorkspaceId
- type WorkspacePaths
- type WorkspaceState
- type WorkspaceTimestamps
- type WorkspacesList
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Info ¶
type Info struct {
Agents []string `json:"agents"`
Runtimes []string `json:"runtimes"`
Version string `json:"version"`
}
Info defines model for Info.
type ProviderInfo ¶ added in v0.13.0
type ProviderInfo struct {
Name string `json:"name"`
Params []ProviderParam `json:"params"`
Type string `json:"type"`
}
ProviderInfo defines model for ProviderInfo.
type ProviderName ¶ added in v0.13.0
type ProviderName struct {
Name string `json:"name"`
}
ProviderName defines model for ProviderName.
type ProviderParam ¶ added in v0.13.0
ProviderParam defines model for ProviderParam.
type ProvidersList ¶ added in v0.13.0
type ProvidersList struct {
Items []ProviderInfo `json:"items"`
}
ProvidersList defines model for ProvidersList.
type RuntimeInfo ¶ added in v0.11.0
type RuntimeInfo struct {
Description string `json:"description"`
Local bool `json:"local"`
Name string `json:"name"`
}
RuntimeInfo defines model for RuntimeInfo.
type RuntimesList ¶ added in v0.11.0
type RuntimesList struct {
Items []RuntimeInfo `json:"items"`
}
RuntimesList defines model for RuntimesList.
type SecretInfo ¶ added in v0.4.0
type SecretInfo struct {
Description *string `json:"description,omitempty"`
Envs *[]string `json:"envs,omitempty"`
Header *string `json:"header,omitempty"`
HeaderTemplate *string `json:"headerTemplate,omitempty"`
Hosts *[]string `json:"hosts,omitempty"`
Name string `json:"name"`
Path *string `json:"path,omitempty"`
Type string `json:"type"`
}
SecretInfo defines model for SecretInfo.
type SecretName ¶ added in v0.4.0
type SecretName struct {
Name string `json:"name"`
}
SecretName defines model for SecretName.
type SecretService ¶ added in v0.7.0
type SecretService struct {
Description *string `json:"description,omitempty"`
EnvVars *[]string `json:"envVars,omitempty"`
HeaderName string `json:"headerName"`
HeaderTemplate *string `json:"headerTemplate,omitempty"`
HostPattern string `json:"hostPattern"`
Name string `json:"name"`
}
SecretService defines model for SecretService.
type SecretServicesList ¶ added in v0.7.0
type SecretServicesList struct {
Items []SecretService `json:"items"`
}
SecretServicesList defines model for SecretServicesList.
type SecretsList ¶ added in v0.4.0
type SecretsList struct {
Items []SecretInfo `json:"items"`
}
SecretsList defines model for SecretsList.
type Workspace ¶
type Workspace struct {
Agent string `json:"agent"`
Forwards []WorkspaceForward `json:"forwards"`
Id string `json:"id"`
Model *string `json:"model,omitempty"`
Name string `json:"name"`
Paths WorkspacePaths `json:"paths"`
Project string `json:"project"`
Runtime string `json:"runtime"`
State WorkspaceState `json:"state"`
Timestamps WorkspaceTimestamps `json:"timestamps"`
}
Workspace defines model for Workspace.
type WorkspaceForward ¶ added in v0.10.0
type WorkspaceForward struct {
Bind string `json:"bind"`
Port int `json:"port"`
Target int `json:"target"`
}
WorkspaceForward defines model for WorkspaceForward.
type WorkspaceId ¶
type WorkspaceId struct {
Id string `json:"id"`
}
WorkspaceId defines model for WorkspaceId.
type WorkspacePaths ¶
type WorkspacePaths struct {
Configuration string `json:"configuration"`
Source string `json:"source"`
}
WorkspacePaths defines model for WorkspacePaths.
type WorkspaceState ¶
type WorkspaceState string
WorkspaceState defines model for WorkspaceState.
const ( WorkspaceStateError WorkspaceState = "error" WorkspaceStateRunning WorkspaceState = "running" WorkspaceStateStopped WorkspaceState = "stopped" WorkspaceStateUnknown WorkspaceState = "unknown" )
Defines values for WorkspaceState.
func (WorkspaceState) Valid ¶
func (e WorkspaceState) Valid() bool
Valid indicates whether the value is a known member of the WorkspaceState enum.
type WorkspaceTimestamps ¶ added in v0.9.0
type WorkspaceTimestamps struct {
Created int64 `json:"created"`
Started *int64 `json:"started,omitempty"`
}
WorkspaceTimestamps defines model for WorkspaceTimestamps.
type WorkspacesList ¶
type WorkspacesList struct {
Items []Workspace `json:"items"`
}
WorkspacesList defines model for WorkspacesList.
Source Files