v1alpha2

package
v0.7.33 Latest Latest
Warning

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

 Go to latest Published: Sep 21, 2024 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Overview

Package core 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 CatalogData 

type CatalogData struct {
	// Compatibility One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
	Compatibility []CatalogDataCompatibility `json:"compatibility"`

	// ContentClass 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.
	Class CatalogDataContentClass `json:"class,omitempty"`

	// PatternCaveats Specific stipulations to consider and known behaviors to be aware of when using this design.
	PatternCaveats string `json:"pattern_caveats"`

	// PatternInfo Purpose of the design along with its intended and unintended uses.
	PatternInfo string `json:"pattern_info"`

	// PublishedVersion Tracks the specific content version that has been made available in the Catalog.
	PublishedVersion *string `json:"publishedVersion,omitempty"`

	// SnapshotURL Contains reference to the dark and light mode snapshots of the design.
	SnapshotURL []string `json:"snapshotURL,omitempty"`

	// Type Categorization of the type of design or operational flow depicted in this design.
	Type CatalogDataType `json:"type"`
}

CatalogData defines model for catalog_data.

type CatalogDataCompatibility 

type CatalogDataCompatibility string

CatalogDataCompatibility defines model for CatalogData.Compatibility. 

const (
	Kubernetes CatalogDataCompatibility = "kubernetes"
)

Defines values for CatalogDataCompatibility.

type CatalogDataContentClass 

type CatalogDataContentClass string

CatalogDataContentClass 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 CatalogDataContentClass = "community"
	Official  CatalogDataContentClass = "official"
	Verified  CatalogDataContentClass = "verified"
)

Defines values for CatalogDataContentClass.

type CatalogDataType 

type CatalogDataType string

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

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

Defines values for CatalogDataType.

type ClonePatternJSONBody 

type ClonePatternJSONBody struct {
	Name string `json:"name"`
}

ClonePatternJSONBody defines parameters for ClonePattern.

type ClonePatternJSONRequestBody 

type ClonePatternJSONRequestBody ClonePatternJSONBody

ClonePatternJSONRequestBody defines body for ClonePattern for application/json ContentType.

type DeletePatternModel 

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

DeletePatternModel defines model for deletePatternModel.

type DeletePatternsJSONBody 

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

DeletePatternsJSONBody defines parameters for DeletePatterns.

type DeletePatternsJSONRequestBody 

type DeletePatternsJSONRequestBody DeletePatternsJSONBody

DeletePatternsJSONRequestBody defines body for DeletePatterns for application/json ContentType.

type DesignShare 

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

DesignShare defines model for designShare.

type GetPatternResourcesParams 

type GetPatternResourcesParams struct {
	// Page Get reponses by page
	Page *Page `form:"page,omitempty" json:"page,omitempty"`

	// PageSize Get reponses by pageSize
	PageSize *PageSize `form:"page_size,omitempty" json:"page_size,omitempty"`

	// Search Get responses that match search param value
	Search *Search `form:"search,omitempty" json:"search,omitempty"`

	// Order Get ordered responses
	Order *Order `form:"order,omitempty" json:"order,omitempty"`

	// Namespace Namespace
	Namespace *Namespace `form:"namespace,omitempty" json:"namespace,omitempty"`

	// Type Type
	Type *Type `form:"type,omitempty" json:"type,omitempty"`

	// OamType OAM type
	OamType *OamType `form:"oamType,omitempty" json:"oamType,omitempty"`

	// Name Name of the resource
	Name *Name `form:"name,omitempty" json:"name,omitempty"`
}

GetPatternResourcesParams defines parameters for GetPatternResources.

type GetPatternsParams 

type GetPatternsParams struct {
	// Page Get reponses by page
	Page *Page `form:"page,omitempty" json:"page,omitempty"`

	// PageSize Get reponses by pageSize
	PageSize *PageSize `form:"page_size,omitempty" json:"page_size,omitempty"`

	// Search Get responses that match search param value
	Search *Search `form:"search,omitempty" json:"search,omitempty"`

	// Order Get ordered responses
	Order *Order `form:"order,omitempty" json:"order,omitempty"`
}

GetPatternsParams defines parameters for GetPatterns.

type HandleShareJSONBody 

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

HandleShareJSONBody defines parameters for HandleShare.

type HandleShareJSONRequestBody 

type HandleShareJSONRequestBody HandleShareJSONBody

HandleShareJSONRequestBody defines body for HandleShare for application/json ContentType.

type Id 

type Id = string

Id defines model for id.

type MesheryPattern 

type MesheryPattern struct {
	CatalogData *CatalogData   `json:"catalog_data,omitempty"`
	CreatedAt   core.Time      `json:"created_at,omitempty"`
	ID          core.Id        `db:"id" json:"id"`
	Location    core.MapObject `json:"location,omitempty"`
	Name        core.Text      `json:"name,omitempty"`

	// PatternFile Schema for design  in v1Beta1
	PatternFile *PatternFile `json:"pattern_file,omitempty"`
	UpdatedAt   core.Time    `json:"updated_at,omitempty"`
	UserID      core.Id      `db:"user_id" json:"user_id"`
	Visibility  core.Text    `json:"visibility,omitempty"`
}

MesheryPattern defines model for mesheryPattern.

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        core.Text       `json:"path,omitempty"`
	PatternData *MesheryPattern `json:"pattern_data,omitempty"`
	Save        *bool           `json:"save,omitempty"`
	Url         core.Text       `json:"url,omitempty"`
}

MesheryPatternRequestBody defines model for mesheryPatternRequestBody.

type MesheryPatternResource 

type MesheryPatternResource struct {
	CreatedAt core.Time `json:"created_at,omitempty"`
	Deleted   *bool     `json:"deleted,omitempty"`
	ID        core.Id   `db:"id" json:"id"`
	Name      core.Text `json:"name,omitempty"`
	Namepace  core.Text `json:"namepace,omitempty"`
	OamType   core.Text `json:"oam_type,omitempty"`
	Type      core.Text `json:"type,omitempty"`
	UpdatedAt core.Time `json:"updated_at,omitempty"`
	UserID    core.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 Name 

type Name = string

Name defines model for name.

type Namespace 

type Namespace = string

Namespace defines model for namespace.

type OamType 

type OamType = string

OamType defines model for oamType.

type Order 

type Order = string

Order defines model for order.

type Page 

type Page = string

Page defines model for page.

type PageSize 

type PageSize = string

PageSize defines model for page_size.

type PatternFile 

type PatternFile struct {
	// Name Name of the design
	Name string `json:"name"`

	PatternID string `yaml:"patternID,omitempty" json:"patternID,omitempty"`

	// Version Version of the design
	Version string `json:"version,omitempty"`

	Vars map[string]interface{} `yaml:"vars,omitempty" json:"vars,omitempty"`

	// Services Map of component IDs/names to their corresponding component declarations
	Services map[string]*Service `json:"services"`
}

Design Schema for design in v1Beta1

func (*PatternFile) Hub added in v0.7.11 

func (p *PatternFile) Hub()
type Search = string

Search defines model for search.

type Service 

type Service struct {
	Annotations  map[string]string      `json:"annotations,omitempty"`
	ApiVersion   string                 `json:"apiVersion,omitempty" yaml:"apiVersion"`
	DependsOn    []string               `json:"dependsOn,omitempty" yaml:"dependsOn"`
	Id           *uuid.UUID             `json:"id,omitempty"`
	IsAnnotation bool                   `json:"isAnnotation,omitempty" yaml:"isAnnotation"`
	Labels       map[string]string      `json:"labels,omitempty"`
	Model        string                 `json:"model,omitempty"`
	Name         string                 `json:"name,omitempty"`
	Namespace    string                 `json:"namespace,omitempty"`
	Settings     map[string]interface{} `json:"settings,omitempty"`
	Traits       map[string]interface{} `json:"traits,omitempty"`
	Type         string                 `json:"type,omitempty"`
	Version      string                 `json:"version,omitempty"`
}

type Type 

type Type = string

Type defines model for type.

type UpsertPatternJSONBody 

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

UpsertPatternJSONBody defines parameters for UpsertPattern.

type UpsertPatternJSONRequestBody 

type UpsertPatternJSONRequestBody UpsertPatternJSONBody

UpsertPatternJSONRequestBody defines body for UpsertPattern for application/json ContentType.

type UpsertPatternResourceJSONRequestBody 

type UpsertPatternResourceJSONRequestBody = MesheryPatternResource

UpsertPatternResourceJSONRequestBody defines body for UpsertPatternResource for application/json ContentType.

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.