models

package
v0.0.0-...-01abcac Latest Latest
Warning

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

 Go to latest Published: Feb 9, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplicationCreateRequest 

type ApplicationCreateRequest struct {
	ID                  string              `json:"id"`
	Name                string              `json:"name"`
	Version             string              `json:"version"`
	Description         string              `json:"description"`
	Platform            string              `json:"platform"`
	Dependencies        map[string]any      `json:"dependencies"`
	Modules             []ApplicationModule `json:"modules"`
	UIModules           []ApplicationModule `json:"uiModules"`
	ModuleDescriptors   []any               `json:"moduleDescriptors"`
	UIModuleDescriptors []any               `json:"uiModuleDescriptors"`
}

ApplicationCreateRequest represents the payload for creating a new application with modules and descriptors

type ApplicationDescriptor 

type ApplicationDescriptor struct {
	ID          string         `json:"id"`
	Name        string         `json:"name"`
	Version     string         `json:"version"`
	Description string         `json:"description,omitempty"`
	Platform    string         `json:"platform,omitempty"`
	Metadata    map[string]any `json:"metadata,omitempty"`
}

ApplicationDescriptor represents an application descriptor response from the API

type ApplicationModule 

type ApplicationModule struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Version string `json:"version"`
	URL     string `json:"url,omitempty"`
}

ApplicationModule represents a module within an application

type ApplicationUpgradeRequest 

type ApplicationUpgradeRequest struct {
	ApplicationName              string
	NewApplicationID             string
	NewApplicationVersion        string
	NewDependencies              map[string]any
	NewBackendModules            []map[string]any
	NewFrontendModules           []map[string]any
	NewBackendModuleDescriptors  []any
	NewFrontendModuleDescriptors []any
	ShouldBuild                  bool
}

ApplicationUpgradeRequest represents the payload necessary for the upgrading of the running application

type ApplicationsResponse 

type ApplicationsResponse struct {
	ApplicationDescriptors []map[string]any `json:"applicationDescriptors"`
	TotalRecords           int              `json:"totalRecords"`
}

ApplicationsResponse represents the response containing a list of application descriptors

type BackendModule 

type BackendModule struct {
	DeployModule             bool
	UseVault                 bool
	UseOkapiURL              bool
	DisableSystemUser        bool
	LocalDescriptorPath      string
	ModuleName               string
	ModuleVersion            *string
	ModuleExposedServerPort  int
	ModuleExposedDebugPort   int
	ModuleExposedPorts       *nat.PortSet
	ModulePortBindings       *nat.PortMap
	ModuleEnv                map[string]any
	ModuleResources          container.Resources
	ModuleVolumes            []string
	DeploySidecar            bool
	SidecarExposedServerPort int
	SidecarExposedDebugPort  int
	SidecarExposedPorts      *nat.PortSet
	SidecarPortBindings      *nat.PortMap
	PrivatePort              int
}

BackendModule represents configuration for a backend module and its optional sidecar

func NewBackendModule 

func NewBackendModule(action *action.Action, p BackendModuleProperties) (*BackendModule, error)

NewBackendModule creates a new BackendModule instance without sidecar configuration

func NewBackendModuleWithSidecar 

func NewBackendModuleWithSidecar(action *action.Action, p BackendModuleProperties) (*BackendModule, error)

NewBackendModuleWithSidecar creates a new BackendModule instance with sidecar configuration

type BackendModuleProperties 

type BackendModuleProperties struct {
	DeployModule        bool
	DeploySidecar       *bool
	UseVault            bool
	UseOkapiURL         bool
	DisableSystemUser   bool
	LocalDescriptorPath string
	Name                string
	Version             *string
	Port                *int
	PrivatePort         *int
	Env                 map[string]any
	Resources           map[string]any
	Volumes             []string
}

BackendModuleProperties contains the properties needed to construct a BackendModule

type CentralOrderingSetting 

type CentralOrderingSetting struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

CentralOrderingSetting represents a central ordering configuration setting

type CentralOrderingSettingRequest 

type CentralOrderingSettingRequest struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

CentralOrderingSettingRequest represents the payload for creating or updating a central ordering setting

type CentralOrderingSettingsResponse 

type CentralOrderingSettingsResponse struct {
	Settings []CentralOrderingSetting `json:"settings"`
}

CentralOrderingSettingsResponse represents the response containing a list of central ordering settings

type Consortium 

type Consortium struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

Consortium represents a consortium entity

type ConsortiumCreateRequest 

type ConsortiumCreateRequest struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

ConsortiumCreateRequest represents the payload for creating a new consortium

type ConsortiumResponse 

type ConsortiumResponse struct {
	Consortia []Consortium `json:"consortia"`
}

ConsortiumResponse represents the response containing a list of consortia

type ConsortiumTenant 

type ConsortiumTenant struct {
	ID        string `json:"id"`
	Code      string `json:"code"`
	Name      string `json:"name"`
	IsCentral bool   `json:"isCentral"`
}

ConsortiumTenant represents a tenant within a consortium

type ConsortiumTenantCreateRequest 

type ConsortiumTenantCreateRequest struct {
	ID        string `json:"id"`
	Code      string `json:"code"`
	Name      string `json:"name"`
	IsCentral int    `json:"isCentral"`
}

ConsortiumTenantCreateRequest represents the payload for creating a tenant within a consortium

type ConsortiumTenantStatus 

type ConsortiumTenantStatus struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	IsCentral   bool   `json:"isCentral"`
	SetupStatus string `json:"setupStatus"`
}

ConsortiumTenantStatus represents the status of a consortium tenant

type ConsortiumTenantsResponse 

type ConsortiumTenantsResponse struct {
	Tenants []ConsortiumTenant `json:"tenants"`
}

ConsortiumTenantsResponse represents the response containing a list of consortium tenants

type Container 

type Container struct {
	Name          string
	RegistryAuth  string
	Config        *container.Config
	HostConfig    *container.HostConfig
	NetworkConfig *network.NetworkingConfig
	Platform      *v1.Platform
	PullImage     bool
}

Container represents a Docker container configuration with all necessary settings

type Containers 

type Containers struct {
	Modules        *ProxyModulesByRegistry
	BackendModules map[string]BackendModule
	IsManagement   bool
}

Containers represents a collection of container configurations and their associated metadata

type Event 

type Event struct {
	Status         string `json:"status"`
	Error          string `json:"error"`
	Progress       string `json:"progress"`
	ProgressDetail struct {
		Current int `json:"current"`
		Total   int `json:"total"`
	} `json:"progressDetail"`
}

Event represents a Docker container event with status, error, and progress information

type FrontendModule 

type FrontendModule struct {
	DeployModule        bool
	ModuleVersion       *string
	ModuleName          string
	LocalDescriptorPath string
}

FrontendModule represents configuration for a frontend module

type KeycloakCapabilitySet 

type KeycloakCapabilitySet struct {
	ID            string `json:"id"`
	Name          string `json:"name"`
	Description   string `json:"description,omitempty"`
	ApplicationID string `json:"applicationId,omitempty"`
	Resource      string `json:"resource,omitempty"`
	Action        string `json:"action,omitempty"`
}

KeycloakCapabilitySet represents a capability set entity

type KeycloakCapabilitySetRequest 

type KeycloakCapabilitySetRequest struct {
	RoleID           string   `json:"roleId"`
	CapabilitySetIDs []string `json:"capabilitySetIds"`
}

KeycloakCapabilitySetRequest represents the payload for assigning capability sets to a role

type KeycloakCapabilitySetsResponse 

type KeycloakCapabilitySetsResponse struct {
	CapabilitySets []KeycloakCapabilitySet `json:"capabilitySets"`
	TotalCount     int                     `json:"totalRecords,omitempty"`
}

KeycloakCapabilitySetsResponse represents the response containing a list of capability sets

type KeycloakClientInfo 

type KeycloakClientInfo struct {
	ID       string `json:"id"`
	ClientID string `json:"clientId"`
}

KeycloakClientInfo represents basic information about a Keycloak client

type KeycloakClientUpdateRequest 

type KeycloakClientUpdateRequest struct {
	RootURL                      string            `json:"rootUrl"`
	BaseURL                      string            `json:"baseUrl"`
	AdminURL                     string            `json:"adminUrl"`
	RedirectURIs                 []string          `json:"redirectUris"`
	WebOrigins                   []string          `json:"webOrigins"`
	AuthorizationServicesEnabled bool              `json:"authorizationServicesEnabled"`
	ServiceAccountsEnabled       bool              `json:"serviceAccountsEnabled"`
	Attributes                   map[string]string `json:"attributes"`
}

KeycloakClientUpdateRequest represents the payload for updating a Keycloak client configuration

type KeycloakClientsResponse 

type KeycloakClientsResponse []KeycloakClientInfo

KeycloakClientsResponse represents the response containing a list of Keycloak clients

type KeycloakRole 

type KeycloakRole struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}

KeycloakRole represents a Keycloak role entity

type KeycloakRoleCreateRequest 

type KeycloakRoleCreateRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

KeycloakRoleCreateRequest represents the payload for creating a new Keycloak role

type KeycloakRolesResponse 

type KeycloakRolesResponse struct {
	Roles      []KeycloakRole `json:"roles"`
	TotalCount int            `json:"totalRecords,omitempty"`
}

KeycloakRolesResponse represents the response containing a list of Keycloak roles

type KeycloakTokenResponse 

type KeycloakTokenResponse struct {
	AccessToken      string `json:"access_token"`
	ExpiresIn        int    `json:"expires_in,omitempty"`
	RefreshExpiresIn int    `json:"refresh_expires_in,omitempty"`
	TokenType        string `json:"token_type,omitempty"`
	RefreshToken     string `json:"refresh_token,omitempty"`
}

KeycloakTokenResponse represents the OAuth token response from Keycloak

type KeycloakUser 

type KeycloakUser struct {
	ID       string         `json:"id"`
	Username string         `json:"username"`
	Active   bool           `json:"active"`
	Type     string         `json:"type,omitempty"`
	Personal map[string]any `json:"personal,omitempty"`
}

KeycloakUser represents a Keycloak user entity

type KeycloakUserCreateRequest 

type KeycloakUserCreateRequest struct {
	Username string                   `json:"username"`
	Active   bool                     `json:"active"`
	Type     string                   `json:"type"`
	Personal KeycloakUserPersonalInfo `json:"personal"`
}

KeycloakUserCreateRequest represents the payload for creating a new Keycloak user

type KeycloakUserCreateResponse 

type KeycloakUserCreateResponse struct {
	ID string `json:"id"`
}

KeycloakUserCreateResponse represents the response when creating a new Keycloak user

type KeycloakUserPasswordRequest 

type KeycloakUserPasswordRequest struct {
	UserID   string `json:"userId"`
	Username string `json:"username"`
	Password string `json:"password"`
}

KeycloakUserPasswordRequest represents the payload for setting a user's password

type KeycloakUserPersonalInfo 

type KeycloakUserPersonalInfo struct {
	FirstName              string `json:"firstName"`
	LastName               string `json:"lastName"`
	Email                  string `json:"email"`
	PreferredContactTypeID string `json:"preferredContactTypeId"`
}

KeycloakUserPersonalInfo represents personal information for a Keycloak user

type KeycloakUserRoleRequest 

type KeycloakUserRoleRequest struct {
	UserID  string   `json:"userId"`
	RoleIDs []string `json:"roleIds"`
}

KeycloakUserRoleRequest represents the payload for assigning roles to a user

type KeycloakUsersResponse 

type KeycloakUsersResponse struct {
	Users        []KeycloakUser `json:"users"`
	TotalRecords int            `json:"totalRecords,omitempty"`
}

KeycloakUsersResponse represents the response containing a list of Keycloak users

type KongRoute 

type KongRoute struct {
	ID         string   `json:"id"`
	Name       string   `json:"name"`
	Protocols  []string `json:"protocols"`
	Methods    []string `json:"methods"`
	Paths      []string `json:"paths"`
	Expression string   `json:"expression"`
	Tags       []string `json:"tags"`
	Service    struct {
		ID string `json:"id"`
	} `json:"service"`
}

KongRoute represents a Kong API gateway route configuration

type KongRoutesResponse 

type KongRoutesResponse struct {
	Data []KongRoute `json:"data"`
	Next string      `json:"next,omitempty"`
}

KongRoutesResponse represents the response containing a list of Kong routes

type ModuleDiscovery 

type ModuleDiscovery struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Version  string `json:"version"`
	Location string `json:"location"`
}

ModuleDiscovery represents discovery information for a deployed module

type ModuleDiscoveryRequest 

type ModuleDiscoveryRequest struct {
	Discovery []ModuleDiscovery `json:"discovery"`
}

ModuleDiscoveryRequest represents the payload for registering module discovery information

type ModuleDiscoveryResponse 

type ModuleDiscoveryResponse struct {
	Discovery    []ModuleDiscovery `json:"discovery"`
	TotalRecords int               `json:"totalRecords"`
}

ModuleDiscoveryResponse represents the response containing a list of module discovery information

type PackageJSON 

type PackageJSON struct {
	Name            string            `json:"name"`
	Version         string            `json:"version"`
	License         string            `json:"license"`
	Scripts         map[string]string `json:"scripts"`
	Dependencies    map[string]string `json:"dependencies"`
	DevDependencies map[string]string `json:"devDependencies"`
	Resolutions     map[string]string `json:"resolutions"`
}

type ProxyModule 

type ProxyModule struct {
	ID       string              `json:"id"`
	Action   string              `json:"action,omitempty"`
	Metadata ProxyModuleMetadata `json:"-"`
}

ProxyModule represents a proxy module with ID and metadata

type ProxyModuleMetadata 

type ProxyModuleMetadata struct {
	Name        string
	SidecarName string
	Version     *string
}

ProxyModuleMetadata represents proxy module metadata

type ProxyModulesByRegistry 

type ProxyModulesByRegistry struct {
	FolioModules  []*ProxyModule
	EurekaModules []*ProxyModule
}

ProxyModulesByRegistry organizes proxy modules by their registry source

type ProxyModulesResponse 

type ProxyModulesResponse []ProxyModule

ProxyModulesResponse represents the response containing a list of proxy modules from the registry

type RegistryExtract 

type RegistryExtract struct {
	Modules           *ProxyModulesByRegistry
	BackendModules    map[string]BackendModule
	FrontendModules   map[string]FrontendModule
	ModuleDescriptors map[string]any
}

RegistryExtract contains extracted information about modules from registries

type RegistryRequest 

type RegistryRequest struct {
	RegistryName   string
	InstallJsonURL string
	HomeDir        string
	UseRemote      bool
	Metadata       struct {
		FileName string
		Path     string
	}
}

type ReindexJobError 

type ReindexJobError struct {
	Type    string `json:"type"`
	Message string `json:"message,omitempty"`
}

ReindexJobError represents an error that occurred during a reindex job

type ReindexJobResponse 

type ReindexJobResponse struct {
	ID        string            `json:"id"`
	JobStatus string            `json:"jobStatus"`
	Errors    []ReindexJobError `json:"errors,omitempty"`
}

ReindexJobResponse represents the response from a search reindex job operation

type Setting 

type Setting struct {
	ID    string `json:"id,omitempty"`
	Key   string `json:"key"`
	Value string `json:"value"`
}

Setting represents a key-value configuration setting

type SettingsResponse 

type SettingsResponse struct {
	Settings     []Setting `json:"settings"`
	TotalRecords int       `json:"totalRecords,omitempty"`
}

SettingsResponse represents the response containing a list of settings

type SidecarRequest 

type SidecarRequest struct {
	Client           *client.Client
	Containers       *Containers
	Module           *ProxyModule
	BackendModule    BackendModule
	SidecarImage     string
	SidecarResources *container.Resources
}

SidecarRequest contains all the information needed to deploy a sidecar container

type SortedConsortiumTenant 

type SortedConsortiumTenant struct {
	Consortium string
	Name       string
	IsCentral  int
}

SortedConsortiumTenant represents a tenant within a consortium sorted by IsCentral

func (SortedConsortiumTenant) String 

func (c SortedConsortiumTenant) String() string

String returns a formatted string representation of the consortium tenant. If the tenant is central (IsCentral == 1), it appends "(central)" to the name.

type SortedConsortiumTenants 

type SortedConsortiumTenants []*SortedConsortiumTenant

SortedConsortiumTenants represents a collection of consortium tenants sorted by IsCentral

func (SortedConsortiumTenants) String 

func (c SortedConsortiumTenants) String() string

String returns a comma-separated list of tenant names.

type Tenant 

type Tenant struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

Tenant represents a tenant entity in the management system

type TenantCreateRequest 

type TenantCreateRequest struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

TenantCreateRequest represents the payload for creating a new tenant

type TenantEntitlementDTO 

type TenantEntitlementDTO struct {
	ApplicationID string `json:"applicationId"`
	TenantID      string `json:"tenantId"`
}

TenantEntitlementDTO represents a single tenant entitlement

type TenantEntitlementRequest 

type TenantEntitlementRequest struct {
	TenantID     string   `json:"tenantId"`
	Applications []string `json:"applications"`
}

TenantEntitlementRequest represents the payload for creating or removing tenant entitlements

type TenantEntitlementResponse 

type TenantEntitlementResponse struct {
	TotalRecords int                    `json:"totalRecords"`
	FlowID       string                 `json:"flowId"`
	Entitlements []TenantEntitlementDTO `json:"entitlements"`
}

TenantEntitlementResponse represents the response from creating/removing tenant entitlements

type TenantsResponse 

type TenantsResponse struct {
	Tenants []Tenant `json:"tenants"`
}

TenantsResponse represents the response containing a list of tenants

type User 

type User struct {
	ID       string `json:"id"`
	Username string `json:"username"`
	Active   bool   `json:"active"`
	Type     string `json:"type"`
	Personal *struct {
		FirstName              string `json:"firstName"`
		LastName               string `json:"lastName"`
		Email                  string `json:"email"`
		PreferredContactTypeId string `json:"preferredContactTypeId"`
	} `json:"personal,omitempty"`
}

User represents a user entity with personal information

type UserResponse 

type UserResponse struct {
	Users        []User `json:"users"`
	TotalRecords int    `json:"totalRecords"`
}

UserResponse represents the response containing a list of users

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.