v1beta1

package
v0.7.11 Latest Latest
Warning

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

 Go to latest Published: Jul 29, 2024 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

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

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

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

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

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Component 

type Component struct {
	// Kind The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.
	Kind string `json:"kind" yaml:"kind"`

	// Schema JSON schema of the object as defined by the registrant.
	Schema string `json:"schema" yaml:"schema"`

	// Version Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.
	Version string `json:"version" yaml:"version"`
}

type ComponentDefinition 

type ComponentDefinition struct {
	// Component Component and it's properties.
	Component     `json:"component" yaml:"component"`
	Configuration map[string]interface{} `json:"configuration" yaml:"configuration"`

	// Description A written representation of the purpose and characteristics of the component.
	Description string `json:"description" yaml:"description"`

	// DisplayName Name of the component in human-readible format.
	DisplayName string `json:"displayName" yaml:"displayName"`

	// Format Format specifies the format used in the `component.schema` field. JSON is the default.
	Format ComponentDefinitionFormat `json:"format" yaml:"format"`

	// Id Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
	Id *uuid.UUID `json:"id" yaml:"id"`

	// Metadata Metadata contains additional information associated with the component.
	Metadata *ComponentDefinition_Metadata `json:"metadata,omitempty"`

	// Model Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models
	Model ModelDefinition `json:"model"`

	// SchemaVersion Specifies the version of the schema to which the component definition conforms.
	SchemaVersion string `json:"schemaVersion" yaml:"schemaVersion"`

	// Version Version of the component definition.
	Version string `json:"version" yaml:"version"`
}

ComponentDefinition Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components

type ComponentDefinitionFormat 

type ComponentDefinitionFormat string

ComponentDefinitionFormat Format specifies the format used in the `component.schema` field. JSON is the default. 

const (
	CUE  ComponentDefinitionFormat = "CUE"
	JSON ComponentDefinitionFormat = "JSON"
)

Defines values for ComponentDefinitionFormat.

type ComponentDefinitionMetadataShape 

type ComponentDefinitionMetadataShape string

ComponentDefinitionMetadataShape Shape of the component used for UI representation. 

const (
	Barrel               ComponentDefinitionMetadataShape = "barrel"
	BottomRoundRectangle ComponentDefinitionMetadataShape = "bottom-round-rectangle"
	ConcaveHexagon       ComponentDefinitionMetadataShape = "concave-hexagon"
	CutRectangle         ComponentDefinitionMetadataShape = "cut-rectangle"
	Diamond              ComponentDefinitionMetadataShape = "diamond"
	Ellipse              ComponentDefinitionMetadataShape = "ellipse"
	Heptagon             ComponentDefinitionMetadataShape = "heptagon"
	Hexagon              ComponentDefinitionMetadataShape = "hexagon"
	Octagon              ComponentDefinitionMetadataShape = "octagon"
	Pentagon             ComponentDefinitionMetadataShape = "pentagon"
	Rectangle            ComponentDefinitionMetadataShape = "rectangle"
	Rhomboid             ComponentDefinitionMetadataShape = "rhomboid"
	RoundDiamond         ComponentDefinitionMetadataShape = "round-diamond"
	RoundHeptagon        ComponentDefinitionMetadataShape = "round-heptagon"
	RoundHexagon         ComponentDefinitionMetadataShape = "round-hexagon"
	RoundOctagon         ComponentDefinitionMetadataShape = "round-octagon"
	RoundPentagon        ComponentDefinitionMetadataShape = "round-pentagon"
	RoundRectangle       ComponentDefinitionMetadataShape = "round-rectangle"
	RoundTag             ComponentDefinitionMetadataShape = "round-tag"
	RoundTriangle        ComponentDefinitionMetadataShape = "round-triangle"
	Star                 ComponentDefinitionMetadataShape = "star"
	Tag                  ComponentDefinitionMetadataShape = "tag"
	Triangle             ComponentDefinitionMetadataShape = "triangle"
	Vee                  ComponentDefinitionMetadataShape = "vee"
)

Defines values for ComponentDefinitionMetadataShape.

type ComponentDefinitionModelStatus 

type ComponentDefinitionModelStatus string

ComponentDefinitionModelStatus Status of model, including: - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status. - maintenance: model is unavailable for a period of time. - enabled: model is available for use for all users of this Meshery Server. - ignored: model is unavailable for use for all users of this Meshery Server. 

const (
	ComponentDefinitionModelStatusDuplicate ComponentDefinitionModelStatus = "duplicate"
	ComponentDefinitionModelStatusEnabled   ComponentDefinitionModelStatus = "enabled"
	ComponentDefinitionModelStatusIgnored   ComponentDefinitionModelStatus = "ignored"
)

Defines values for ComponentDefinitionModelStatus.

type ComponentDefinition_Metadata 

type ComponentDefinition_Metadata struct {
	// Capabilities Meshery manages components in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. ComponentDefinitions may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
	Capabilities *map[string]interface{} `json:"capabilities" yaml:"capabilities"`

	// Genealogy Genealogy represents the various representational states of the component.
	Genealogy *string `json:"genealogy" yaml:"genealogy"`

	// IsAnnotation Identifies whether the component is semantically meaningful or not; identifies whether the component should be treated as deployable entity or is for purposes of logical representation.
	IsAnnotation *bool `json:"isAnnotation" yaml:"isAnnotation"`

	// PrimaryColor Primary color of the component used for UI representation.
	PrimaryColor string `json:"primaryColor" yaml:"primaryColor"`

	// Published 'published' controls whether the component should be registered in Meshery Registry. When the same 'published' property in Models, is set to 'false', the Model property takes precedence with all Entities in the Model not being registered.
	Published *bool `json:"published" yaml:"published"`

	// SecondaryColor Secondary color of the component used for UI representation.
	SecondaryColor *string `json:"secondaryColor" yaml:"secondaryColor"`

	// Shape Shape of the component used for UI representation.
	Shape ComponentDefinitionMetadataShape `json:"shape" yaml:"shape"`

	// SvgColor Colored SVG of the component used for UI representation on light background.
	SvgColor string `json:"svgColor" yaml:"svgColor"`

	// SvgComplete Complete SVG of the component used for UI representation, often inclusive of background.
	SvgComplete *string `json:"svgComplete" yaml:"svgComplete"`

	// SvgWhite White SVG of the component used for UI representation on dark background.
	SvgWhite             string                 `json:"svgWhite" yaml:"svgWhite"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

ComponentDefinition_Metadata Metadata contains additional information associated with the component.

func (ComponentDefinition_Metadata) Get 

func (a ComponentDefinition_Metadata) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for ComponentDefinition_Metadata. Returns the specified element and whether it was found

func (ComponentDefinition_Metadata) MarshalJSON 

func (a ComponentDefinition_Metadata) MarshalJSON() ([]byte, error)

Override default JSON handling for ComponentDefinition_Metadata to handle AdditionalProperties

func (*ComponentDefinition_Metadata) Set 

func (a *ComponentDefinition_Metadata) Set(fieldName string, value interface{})

Setter for additional properties for ComponentDefinition_Metadata

func (*ComponentDefinition_Metadata) UnmarshalJSON 

func (a *ComponentDefinition_Metadata) UnmarshalJSON(b []byte) error

Override default JSON handling for ComponentDefinition_Metadata to handle AdditionalProperties

type DeletePatternModel 

type DeletePatternModel struct {
	ID   externalRef1.Id   `db:"id" json:"id"`
	Name externalRef1.Text `json:"name,omitempty"`
}

DeletePatternModel defines model for deletePatternModel.

type DesignShare 

type DesignShare struct {
	ContentType string              `json:"content_type"`
	Emails      externalRef1.Emails `json:"emails"`
	ID          externalRef1.Id     `db:"id" json:"id"`
	Share       bool                `json:"share"`
}

DesignShare defines model for designShare.

type Environment 

type Environment struct {
	ID        externalRef2.EnvironmentId `db:"id" json:"id"`
	CreatedAt externalRef2.Time          `json:"created_at,omitempty"`

	// DeletedAt SQL null Timestamp to handle null values of time.
	DeletedAt      externalRef2.NullTime       `json:"deleted_at,omitempty"`
	Description    externalRef2.Text           `json:"description,omitempty"`
	Name           externalRef2.Text           `json:"name,omitempty"`
	OrganizationId externalRef2.OrganizationId `db:"org_id" json:"org_id"`
	Owner          externalRef2.Text           `json:"owner,omitempty"`
	UpdatedAt      externalRef2.Time           `json:"updated_at,omitempty"`
}

Environment defines model for environment.

type EnvironmentConnectionMapping 

type EnvironmentConnectionMapping struct {
	ID           externalRef2.EnvironmentId `db:"id" json:"id"`
	ConnectionId uuid.UUID                  `db:"connection_id" json:"connection_id"`
	CreatedAt    externalRef2.Time          `json:"created_at,omitempty"`

	// DeletedAt SQL null Timestamp to handle null values of time.
	DeletedAt     externalRef2.NullTime `json:"deleted_at,omitempty"`
	EnvironmentId uuid.UUID             `db:"environment_id" json:"environment_id"`
	UpdatedAt     externalRef2.Time     `json:"updated_at,omitempty"`
}

EnvironmentConnectionMapping defines model for environmentConnectionMapping.

type EnvironmentPage 

type EnvironmentPage struct {
	Environments []Environment       `json:"environments,omitempty"`
	Page         externalRef2.Number `json:"page,omitempty"`
	PageSize     externalRef2.Number `json:"page_size,omitempty"`
	TotalCount   externalRef2.Number `json:"total_count,omitempty"`
}

EnvironmentPage defines model for environmentPage.

type EnvironmentPayload 

type EnvironmentPayload struct {
	// OrgId Organization ID
	OrgId       string            `json:"organization_id"`
	Description externalRef2.Text `json:"description,omitempty"`
	Name        externalRef2.Text `json:"name"`
}

EnvironmentPayload defines model for environmentPayload.

type MesheryPattern 

type MesheryPattern struct {
	CatalogData *v1alpha2.CatalogData  `json:"catalog_data,omitempty" yaml:"catalog_data"`
	CreatedAt   externalRef1.Time      `json:"created_at,omitempty"`
	UserID      externalRef1.Id        `db:"user_id" json:"user_id"`
	Location    externalRef1.MapObject `json:"location,omitempty"`
	Name        externalRef1.Text      `json:"name,omitempty"`

	// PatternFile Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
	PatternFile *PatternFile      `json:"pattern_file,omitempty" yaml:"pattern_file"`
	UpdatedAt   externalRef1.Time `json:"updated_at,omitempty"`
	ID          externalRef1.Id   `db:"id" json:"id"`
	Visibility  externalRef1.Text `json:"visibility,omitempty"`
}

MesheryPattern defines model for mesheryPattern.

type MesheryPatternCatalogDataClass 

type MesheryPatternCatalogDataClass string

MesheryPatternCatalogDataClass Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. 

const (
	Community MesheryPatternCatalogDataClass = "community"
	Official  MesheryPatternCatalogDataClass = "official"
	Verified  MesheryPatternCatalogDataClass = "verified"
)

Defines values for MesheryPatternCatalogDataClass.

type MesheryPatternCatalogDataCompatibility 

type MesheryPatternCatalogDataCompatibility string

MesheryPatternCatalogDataCompatibility defines model for MesheryPattern.CatalogData.Compatibility. 

const (
	Kubernetes MesheryPatternCatalogDataCompatibility = "kubernetes"
)

Defines values for MesheryPatternCatalogDataCompatibility.

type MesheryPatternCatalogDataType 

type MesheryPatternCatalogDataType string

MesheryPatternCatalogDataType Categorization of the type of design or operational flow depicted in this design. 

const (
	Deployment        MesheryPatternCatalogDataType = "Deployment"
	Observability     MesheryPatternCatalogDataType = "Observability"
	Resiliency        MesheryPatternCatalogDataType = "Resiliency"
	Scaling           MesheryPatternCatalogDataType = "Scaling"
	Security          MesheryPatternCatalogDataType = "Security"
	TrafficManagement MesheryPatternCatalogDataType = "Traffic-management"
	Troubleshooting   MesheryPatternCatalogDataType = "Troubleshooting"
	Workloads         MesheryPatternCatalogDataType = "Workloads"
)

Defines values for MesheryPatternCatalogDataType.

type MesheryPatternDeleteRequestBody 

type MesheryPatternDeleteRequestBody struct {
	Patterns *[]DeletePatternModel `json:"patterns,omitempty"`
}

MesheryPatternDeleteRequestBody defines model for mesheryPatternDeleteRequestBody.

type MesheryPatternPage 

type MesheryPatternPage struct {
	Page       int               `json:"page,omitempty"`
	PageSize   int               `json:"page_size,omitempty"`
	Patterns   *[]MesheryPattern `json:"patterns,omitempty"`
	ResultType string            `json:"resultType,omitempty"`
	TotalCount int               `json:"total_count,omitempty"`
}

MesheryPatternPage defines model for mesheryPatternPage.

type MesheryPatternRequestBody 

type MesheryPatternRequestBody struct {
	Path        externalRef1.Text     `json:"path,omitempty"`
	PatternData *MesheryPattern       `json:"pattern_data,omitempty"`
	Save        *bool                 `json:"save,omitempty"`
	Url         externalRef1.Endpoint `json:"url,omitempty"`
}

MesheryPatternRequestBody defines model for mesheryPatternRequestBody.

type MesheryPatternResource 

type MesheryPatternResource struct {
	CreatedAt externalRef1.Time `json:"created_at,omitempty"`
	Deleted   *bool             `json:"deleted,omitempty"`
	ID        externalRef1.Id   `db:"id" json:"id"`
	Name      externalRef1.Text `json:"name,omitempty"`
	Namepace  externalRef1.Text `json:"namepace,omitempty"`
	OamType   externalRef1.Text `json:"oam_type,omitempty"`
	Type      externalRef1.Text `json:"type,omitempty"`
	UpdatedAt externalRef1.Time `json:"updated_at,omitempty"`
	UserID    externalRef1.Id   `db:"user_id" json:"user_id"`
}

MesheryPatternResource defines model for mesheryPatternResource.

type MesheryPatternResourcePage 

type MesheryPatternResourcePage struct {
	Page       int                       `json:"page,omitempty"`
	PageSize   int                       `json:"page_size,omitempty"`
	Resources  *[]MesheryPatternResource `json:"resources,omitempty"`
	ResultType string                    `json:"resultType,omitempty"`
	TotalCount int                       `json:"total_count,omitempty"`
}

MesheryPatternResourcePage defines model for mesheryPatternResourcePage.

type Model 

type Model struct {
	// Version Version of the model as defined by the registrant.
	Version string `json:"version" yaml:"version"`
}

type ModelDefinition 

type ModelDefinition struct {
	// Category Category of the model.
	Category string `json:"category" yaml:"category"`

	// Description Description of the model.
	Description *string `json:"description" yaml:"description"`

	// DisplayName Human-readable name for the model.
	DisplayName *string `json:"displayName" yaml:"displayName"`

	// Metadata Metadata containing additional information associated with the model.
	Metadata *ModelDefinition_Metadata `json:"metadata,omitempty"`

	// Model Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31)
	Model *Model `json:"model,omitempty" yaml:"model"`

	// Name The unique name for the model within the scope of a registrant.
	Name       string                 `json:"name" yaml:"name"`
	Registrant map[string]interface{} `json:"registrant" yaml:"registrant"`

	// SchemaVersion Specifies the version of the schema used for the definition.
	SchemaVersion *string `json:"schemaVersion" yaml:"schemaVersion"`

	// Status Status of model, including:
	// - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
	// - maintenance: model is unavailable for a period of time.
	// - enabled: model is available for use for all users of this Meshery Server.
	// - ignored: model is unavailable for use for all users of this Meshery Server.
	Status *ModelDefinitionStatus `json:"status" yaml:"status"`

	// SubCategory Sub-category of the model.
	SubCategory *string `json:"subCategory" yaml:"subCategory"`

	// Version Version of the model definition.
	Version string `json:"version" yaml:"version"`
}

ModelDefinition Meshery Models serve as a portable unit of packaging to define managed entities, their relationships, and capabilities.

type ModelDefinitionStatus 

type ModelDefinitionStatus string

ModelDefinitionStatus Status of model, including: - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status. - maintenance: model is unavailable for a period of time. - enabled: model is available for use for all users of this Meshery Server. - ignored: model is unavailable for use for all users of this Meshery Server. 

const (
	ModelDefinitionStatusDuplicate ModelDefinitionStatus = "duplicate"
	ModelDefinitionStatusEnabled   ModelDefinitionStatus = "enabled"
	ModelDefinitionStatusIgnored   ModelDefinitionStatus = "ignored"
)

Defines values for ModelDefinitionStatus.

type ModelDefinition_Metadata 

type ModelDefinition_Metadata struct {
	// IsAnnotation Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
	IsAnnotation *bool `json:"isAnnotation" yaml:"isAnnotation"`

	// PrimaryColor Primary color associated with the model.
	PrimaryColor *string `json:"primaryColor" yaml:"primaryColor"`

	// SecondaryColor Secondary color associated with the model.
	SecondaryColor *string `json:"secondaryColor" yaml:"secondaryColor"`

	// SvgColor SVG representation of the model in colored format.
	SvgColor *string `json:"svgColor" yaml:"svgColor"`

	// SvgComplete SVG representation of the complete model.
	SvgComplete *string `json:"svgComplete" yaml:"svgComplete"`

	// SvgWhite SVG representation of the model in white color.
	SvgWhite             *string                `json:"svgWhite" yaml:"svgWhite"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

ModelDefinition_Metadata Metadata containing additional information associated with the model.

func (ModelDefinition_Metadata) Get 

func (a ModelDefinition_Metadata) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for ModelDefinition_Metadata. Returns the specified element and whether it was found

func (ModelDefinition_Metadata) MarshalJSON 

func (a ModelDefinition_Metadata) MarshalJSON() ([]byte, error)

Override default JSON handling for ModelDefinition_Metadata to handle AdditionalProperties

func (*ModelDefinition_Metadata) Set 

func (a *ModelDefinition_Metadata) Set(fieldName string, value interface{})

Setter for additional properties for ModelDefinition_Metadata

func (*ModelDefinition_Metadata) UnmarshalJSON 

func (a *ModelDefinition_Metadata) UnmarshalJSON(b []byte) error

Override default JSON handling for ModelDefinition_Metadata to handle AdditionalProperties

type PatternFile 

type PatternFile struct {
	Id externalRef1.Id `json:"id,omitempty" yaml:"id,omitempty"`

	// Components List of component declarations
	Components []ComponentDefinition `json:"components" yaml:"components"`

	// Name Name of the design; a descriptive, but concise title for the design document.
	Name string `json:"name" yaml:"name"`

	// Preferences Design-level preferences
	Preferences *struct {
		// Layers List of available layers
		Layers []string `json:"layers"`
	} `json:"preferences,omitempty"`

	// Relationships List of relationships between components
	Relationships []v1alpha3.RelationshipDefinition `json:"relationships" yaml:"relationships"`

	// SchemaVersion Specifies the version of the schema to which the design conforms.
	SchemaVersion string `json:"schemaVersion" yaml:"schemaVersion"`

	// Version Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.
	Version string `json:"version" yaml:"version"`
}

func (*PatternFile) ConvertFrom 

func (p *PatternFile) ConvertFrom(pattern models.Hub) error

The pattern file indicated by "pattern" is converted to the version to which *PatternFile belongs or simply the package version of the .go file. "pattern" parameter acts as the source and the "p" the destination.

func (*PatternFile) ConvertTo 

func (p *PatternFile) ConvertTo(pattern models.Hub) error

The pattern file indicated by "p", is converted to the version pointed by "pattern", the version of the patternFile which implements the Hub interface indicates the version the conversion will happen. Only one version of the resource (patternfile in this case) should implement the Hub interface. "pattern" parameter acts as the destination and "p" the source.

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.