Documentation
¶
Overview ¶
This is not autogenerated.
Package user 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.
Code generated by build/generate-golang.js; DO NOT EDIT.
Index ¶
- type Adapter
- type Filter
- type Grafana
- type GrafanaBoard
- type Id
- type LoadTestPreferences
- type Order
- type Page
- type PageSize
- type Panel
- type Preference
- type Prometheus
- type Search
- type SelectedGrafanaConfig
- type Social
- type TeamId
- type User
- type UserRoleNames
- type UserSocials
- type UserStatus
- type UsersPageForAdmin
- type UsersPageForNonAdmin
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Adapter ¶
type Adapter = map[string]interface{}
Adapter Placeholder for Adapter struct definition.
type Grafana ¶
type Grafana struct {
// GrafanaApiKey Grafana API key for the user configuration.
GrafanaApiKey *string `json:"grafanaApiKey,omitempty" yaml:"grafanaApiKey,omitempty"`
// GrafanaUrl Grafana URL for the user configuration.
GrafanaUrl *string `json:"grafanaUrl,omitempty" yaml:"grafanaUrl,omitempty"`
// SelectedBoardsConfigs Selected Grafana board configurations for the user.
SelectedBoardsConfigs *[]SelectedGrafanaConfig `json:"selectedBoardsConfigs,omitempty" yaml:"selectedBoardsConfigs,omitempty"`
}
Grafana defines model for Grafana.
type GrafanaBoard ¶
type GrafanaBoard = map[string]interface{}
GrafanaBoard Placeholder for GrafanaBoard definition (define fields as needed)
type Id ¶
type Id = openapi_types.UUID
Id A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. Id defines model for id.
type LoadTestPreferences ¶
type LoadTestPreferences struct {
// C Concurrent requests
C *int `json:"c,omitempty" yaml:"c,omitempty"`
// Gen Load generator
Gen *string `json:"gen,omitempty" yaml:"gen,omitempty"`
// Qps Queries per second
Qps *int `json:"qps,omitempty" yaml:"qps,omitempty"`
// T Duration
T *string `json:"t,omitempty" yaml:"t,omitempty"`
}
LoadTestPreferences defines model for LoadTestPreferences.
type Panel ¶
type Panel = map[string]interface{}
Panel Grafana panel structure imported from github.com/grafana-tools/sdk
type Preference ¶
type Preference struct {
// AnonymousPerfResults The anonymous perf results of the preference.
AnonymousPerfResults bool `json:"anonymousPerfResults" yaml:"anonymousPerfResults"`
// AnonymousUsageStats The anonymous usage stats of the preference.
AnonymousUsageStats bool `json:"anonymousUsageStats" yaml:"anonymousUsageStats"`
// DashboardPreferences The dashboard preferences of the preference.
DashboardPreferences map[string]interface{} `json:"dashboardPreferences" yaml:"dashboardPreferences"`
Grafana *Grafana `json:"grafana,omitempty" yaml:"grafana,omitempty"`
LoadTestPrefs *LoadTestPreferences `json:"loadTestPrefs,omitempty" yaml:"loadTestPrefs,omitempty"`
// MeshAdapters The mesh adapters of the preference.
MeshAdapters *[]Adapter `json:"meshAdapters,omitempty" yaml:"meshAdapters,omitempty"`
Prometheus *Prometheus `json:"prometheus,omitempty" yaml:"prometheus,omitempty"`
// RemoteProviderPreferences The remote provider preferences of the preference.
RemoteProviderPreferences map[string]interface{} `json:"remoteProviderPreferences" yaml:"remoteProviderPreferences"`
// SelectedOrganizationId ID of the associated selectedOrganization.
SelectedOrganizationId openapi_types.UUID `json:"selectedOrganizationId" yaml:"selectedOrganizationId"`
// SelectedWorkspaceForOrganizations The selected workspace for organizations of the preference.
SelectedWorkspaceForOrganizations map[string]string `json:"selectedWorkspaceForOrganizations" yaml:"selectedWorkspaceForOrganizations"`
// UpdatedAt Timestamp of when the resource was last updated.
UpdatedAt time.Time `json:"updatedAt" yaml:"updatedAt"`
// UsersExtensionPreferences The users extension preferences of the preference.
UsersExtensionPreferences map[string]interface{} `json:"usersExtensionPreferences" yaml:"usersExtensionPreferences"`
}
Preference defines model for Preference.
func (*Preference) Scan ¶
func (p *Preference) Scan(src interface{}) error
Scan implements sql.Scanner for JSONB retrieval.
type Prometheus ¶
type Prometheus struct {
// PrometheusUrl The prometheus URL of the prometheus.
PrometheusUrl *string `json:"prometheusUrl,omitempty" yaml:"prometheusUrl,omitempty"`
// SelectedPrometheusBoardsConfigs The selected prometheus boards configs of the prometheus.
SelectedPrometheusBoardsConfigs *[]SelectedGrafanaConfig `json:"selectedPrometheusBoardsConfigs,omitempty" yaml:"selectedPrometheusBoardsConfigs,omitempty"`
}
Prometheus defines model for Prometheus.
type SelectedGrafanaConfig ¶
type SelectedGrafanaConfig struct {
// Board Placeholder for GrafanaBoard definition (define fields as needed)
Board *GrafanaBoard `json:"board,omitempty" yaml:"board,omitempty"`
// Panels Panels selected for the Grafana board configuration.
Panels *[]Panel `json:"panels,omitempty" yaml:"panels,omitempty"`
// TemplateVars Template variables applied to the selected Grafana board configuration.
TemplateVars *[]string `json:"templateVars,omitempty" yaml:"templateVars,omitempty"`
}
SelectedGrafanaConfig defines model for SelectedGrafanaConfig.
type Social ¶
type Social struct {
// Link The link of the social.
Link string `json:"link" yaml:"link"`
// Site The site of the social.
Site string `json:"site" yaml:"site"`
}
Social Various online profiles associated with the user account, like GitHub, LinkedIn, X, and so on.
type User ¶
type User struct {
AcceptedTermsAt core.Time `db:"accepted_terms_at" json:"acceptedTermsAt" yaml:"acceptedTermsAt,omitempty"`
// AvatarUrl URL to user's avatar image
AvatarUrl *string `db:"avatar_url" json:"avatarUrl" yaml:"avatarUrl"`
// Bio User's biography or description
Bio *string `db:"bio" json:"bio" yaml:"bio"`
// Country User's country information stored as JSONB
Country core.Map `db:"country" json:"country" yaml:"country"`
CreatedAt core.Time `db:"created_at" json:"createdAt" yaml:"createdAt"`
// DeletedAt Timestamp when the user record was soft-deleted (null if not deleted)
DeletedAt *core.NullTime `db:"deleted_at" json:"deletedAt" yaml:"deletedAt"`
// Email User's email address
Email openapi_types.Email `db:"email" json:"email" yaml:"email"`
FirstLoginTime core.Time `db:"first_login_time" json:"firstLoginTime" yaml:"firstLoginTime,omitempty"`
// FirstName User's first name
FirstName string `db:"first_name" json:"firstName" yaml:"firstName"`
// Id A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
ID core.Uuid `db:"id" json:"id" yaml:"id"`
LastLoginTime core.Time `db:"last_login_time" json:"lastLoginTime" yaml:"lastLoginTime"`
// LastName User's last name
LastName string `db:"last_name" json:"lastName" yaml:"lastName"`
// Organizations Organizations the user belongs to with role information
Organizations *struct {
// OrganizationsWithRoles Organization memberships for the user with their assigned roles.
OrganizationsWithRoles *[]map[string]interface{} `db:"organizations_with_roles" json:"organizationsWithRoles" yaml:"organizationsWithRoles"`
// TotalCount Total number of organization memberships returned for the user.
TotalCount *int `db:"total_count" json:"totalCount" yaml:"totalCount"`
} `db:"organizations" json:"organizations" yaml:"organizations"`
Preferences *Preference `db:"preferences" json:"preferences" yaml:"preferences,omitempty"`
// Provider Authentication provider (e.g., Layer5 Cloud, Twitter, Facebook, Github)
Provider string `db:"provider" json:"provider" yaml:"provider"`
// Region User's region information stored as JSONB
Region core.Map `db:"region" json:"region" yaml:"region"`
// RoleNames List of global roles assigned to the user
RoleNames *[]UserRoleNames `db:"role_names" json:"roleNames" yaml:"roleNames"`
// Socials Various online profiles associated with the user account
Socials *UserSocials `db:"socials" json:"socials" yaml:"socials"`
// Status User account status
Status UserStatus `db:"status" json:"status" yaml:"status"`
// Teams Teams the user belongs to with role information
Teams *struct {
// TeamsWithRoles Team memberships for the user with their assigned roles.
TeamsWithRoles *[]map[string]interface{} `db:"teams_with_roles" json:"teamsWithRoles" yaml:"teamsWithRoles"`
// TotalCount Total number of team memberships returned for the user.
TotalCount *int `db:"total_count" json:"totalCount" yaml:"totalCount"`
} `db:"teams" json:"teams" yaml:"teams"`
UpdatedAt core.Time `db:"updated_at" json:"updatedAt" yaml:"updatedAt"`
// UserId User identifier (username or external ID)
UserId string `db:"user_id" json:"userId" yaml:"userId"`
}
User Represents a user in Layer5 Cloud (Meshery)
func (*User) EventCategory ¶
type UserRoleNames ¶
type UserRoleNames string
UserRoleNames defines model for User.RoleNames.
const ( UserRoleNamesAdmin UserRoleNames = "admin" UserRoleNamesCurator UserRoleNames = "curator" UserRoleNamesMeshmap UserRoleNames = "meshmap" UserRoleNamesOrganizationAdmin UserRoleNames = "organization admin" UserRoleNamesTeamAdmin UserRoleNames = "team admin" UserRoleNamesUser UserRoleNames = "user" UserRoleNamesWorkspaceAdmin UserRoleNames = "workspace admin" UserRoleNamesWorkspaceManager UserRoleNames = "workspace manager" )
Defines values for UserRoleNames.
type UserSocials ¶
type UserSocials []Social
UserSocials User social profiles
func (*UserSocials) Scan ¶
func (us *UserSocials) Scan(value interface{}) error
Scan implements sql.Scanner
type UserStatus ¶
type UserStatus string
UserStatus User account status
const ( Active UserStatus = "active" Anonymous UserStatus = "anonymous" Inactive UserStatus = "inactive" Pending UserStatus = "pending" )
Defines values for UserStatus.
type UsersPageForAdmin ¶
type UsersPageForAdmin struct {
// Data The data of the userspageforadmin.
Data *[]User `json:"data,omitempty" yaml:"data,omitempty"`
// Page Current page number of the result set.
Page *int `json:"page,omitempty" yaml:"page,omitempty"`
// PageSize Number of items per page.
PageSize *int `json:"pageSize,omitempty" yaml:"pageSize,omitempty"`
// TotalCount Total number of items available.
TotalCount *int `json:"totalCount,omitempty" yaml:"totalCount,omitempty"`
}
UsersPageForAdmin Paginated list of users with organization and team role context
type UsersPageForNonAdmin ¶
type UsersPageForNonAdmin struct {
// Data The data of the userspagefornonadmin.
Data *[]User `json:"data,omitempty" yaml:"data,omitempty"`
// Page Current page number of the result set.
Page *int `json:"page,omitempty" yaml:"page,omitempty"`
// PageSize Number of items per page.
PageSize *int `json:"pageSize,omitempty" yaml:"pageSize,omitempty"`
// TotalCount Total number of items available.
TotalCount *int `json:"totalCount,omitempty" yaml:"totalCount,omitempty"`
}
UsersPageForNonAdmin Paginated list of public user records