Add network topology APIs
Signed-off-by: Zhengyi Lai <zheng1@yunify.com>
This commit is contained in:
Zhengyi Lai
218
pkg/kapis/network/v1alpha2/swagger-doc.go
Normal file
218
pkg/kapis/network/v1alpha2/swagger-doc.go
Normal file
@@ -0,0 +1,218 @@
|
||||
/*
|
||||
Copyright 2020 The KubeSphere authors.
|
||||
|
||||
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.
|
||||
*/
|
||||
|
||||
package v1alpha2
|
||||
|
||||
import (
|
||||
"time"
|
||||
)
|
||||
|
||||
/////////////////////
|
||||
// SWAGGER RESPONSES
|
||||
/////////////////////
|
||||
|
||||
// NoContent: the response is empty
|
||||
type NoContent struct {
|
||||
Status int32 `json:"status"`
|
||||
Reason error `json:"reason"`
|
||||
}
|
||||
|
||||
// BadRequestError: the client request is incorrect
|
||||
type BadRequestError struct {
|
||||
Status int32 `json:"status"`
|
||||
Reason error `json:"reason"`
|
||||
}
|
||||
|
||||
// NotFoundError is the error message that is generated when server could not find
|
||||
// what was requested
|
||||
type NotFoundError struct {
|
||||
Status int32 `json:"status"`
|
||||
Reason error `json:"reason"`
|
||||
}
|
||||
|
||||
// copy from github.com/weaveworks/scope v1.12.0
|
||||
|
||||
// MetadataRow is a row for the metadata table.
|
||||
type MetadataRow struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Value string `json:"value"`
|
||||
Priority float64 `json:"priority,omitempty"`
|
||||
Datatype string `json:"dataType,omitempty"`
|
||||
Truncate int `json:"truncate,omitempty"`
|
||||
}
|
||||
|
||||
// BasicNodeSummary is basic summary information about a Node,
|
||||
// sufficient for rendering links to the node.
|
||||
type BasicNodeSummary struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
LabelMinor string `json:"labelMinor"`
|
||||
Rank string `json:"rank"`
|
||||
Shape string `json:"shape,omitempty"`
|
||||
Tag string `json:"tag,omitempty"`
|
||||
Stack bool `json:"stack,omitempty"`
|
||||
Pseudo bool `json:"pseudo,omitempty"`
|
||||
}
|
||||
|
||||
// Parent is the information needed to build a link to the parent of a Node.
|
||||
type Parent struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
TopologyID string `json:"topologyId"`
|
||||
}
|
||||
|
||||
// Metric is a list of timeseries data with some metadata. Clients must use the
|
||||
// Add method to add values. Metrics are immutable.
|
||||
type Metric struct {
|
||||
Samples []Sample `json:"samples,omitempty"`
|
||||
Min float64 `json:"min"`
|
||||
Max float64 `json:"max"`
|
||||
}
|
||||
|
||||
func (m Metric) first() time.Time { return m.Samples[0].Timestamp }
|
||||
func (m Metric) last() time.Time { return m.Samples[len(m.Samples)-1].Timestamp }
|
||||
|
||||
// Sample is a single datapoint of a metric.
|
||||
type Sample struct {
|
||||
Timestamp time.Time `json:"date"`
|
||||
Value float64 `json:"value"`
|
||||
}
|
||||
|
||||
// MetricRow is a tuple of data used to render a metric as a sparkline and
|
||||
// accoutrements.
|
||||
type MetricRow struct {
|
||||
ID string
|
||||
Label string
|
||||
Format string
|
||||
Group string
|
||||
Value float64
|
||||
ValueEmpty bool
|
||||
Priority float64
|
||||
URL string
|
||||
Metric *Metric
|
||||
}
|
||||
|
||||
// NodeSummaryGroup is a topology-typed group of children for a Node.
|
||||
type NodeSummaryGroup struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Nodes []NodeSummary `json:"nodes"`
|
||||
TopologyID string `json:"topologyId"`
|
||||
Columns []Column `json:"columns"`
|
||||
}
|
||||
|
||||
// Connection is a row in the connections table.
|
||||
type Connection struct {
|
||||
ID string `json:"id"` // ID of this element in the UI. Must be unique for a given ConnectionsSummary.
|
||||
NodeID string `json:"nodeId"` // ID of a node in the topology. Optional, must be set if linkable is true.
|
||||
Label string `json:"label"`
|
||||
LabelMinor string `json:"labelMinor,omitempty"`
|
||||
Metadata []MetadataRow `json:"metadata,omitempty"`
|
||||
}
|
||||
|
||||
// ConnectionsSummary is the table of connection to/form a node
|
||||
type ConnectionsSummary struct {
|
||||
ID string `json:"id"`
|
||||
TopologyID string `json:"topologyId"`
|
||||
Label string `json:"label"`
|
||||
Columns []Column `json:"columns"`
|
||||
Connections []Connection `json:"connections"`
|
||||
}
|
||||
|
||||
// Column is the type for multi-column tables in the UI.
|
||||
type Column struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
DataType string `json:"dataType"`
|
||||
}
|
||||
|
||||
// Row is the type that holds the table data for the UI. Entries map from column ID to cell value.
|
||||
type Row struct {
|
||||
ID string `json:"id"`
|
||||
Entries map[string]string `json:"entries"`
|
||||
}
|
||||
|
||||
// Table is the type for a table in the UI.
|
||||
type Table struct {
|
||||
ID string `json:"id"`
|
||||
Label string `json:"label"`
|
||||
Type string `json:"type"`
|
||||
Columns []Column `json:"columns"`
|
||||
Rows []Row `json:"rows"`
|
||||
TruncationCount int `json:"truncationCount,omitempty"`
|
||||
}
|
||||
|
||||
// StringSet is a sorted set of unique strings. Clients must use the Add
|
||||
// method to add strings.
|
||||
type StringSet []string
|
||||
|
||||
// IDList is a list of string IDs, which are always sorted and unique.
|
||||
type IDList StringSet
|
||||
|
||||
// NodeSummary is summary information about a Node.
|
||||
type NodeSummary struct {
|
||||
BasicNodeSummary
|
||||
Metadata []MetadataRow `json:"metadata,omitempty"`
|
||||
Parents []Parent `json:"parents,omitempty"`
|
||||
Metrics []MetricRow `json:"metrics,omitempty"`
|
||||
Tables []Table `json:"tables,omitempty"`
|
||||
Adjacency IDList `json:"adjacency,omitempty"`
|
||||
}
|
||||
|
||||
type NodeSummaries map[string]NodeSummary
|
||||
|
||||
type APITopology struct {
|
||||
Nodes NodeSummaries `json:"nodes"`
|
||||
}
|
||||
|
||||
// A Control basically describes an RPC
|
||||
type Control struct {
|
||||
ID string `json:"id"`
|
||||
Human string `json:"human"`
|
||||
Icon string `json:"icon"` // from https://fortawesome.github.io/Font-Awesome/cheatsheet/ please
|
||||
Confirmation string `json:"confirmation,omitempty"`
|
||||
Rank int `json:"rank"`
|
||||
}
|
||||
|
||||
// ControlInstance contains a control description, and all the info
|
||||
// needed to execute it.
|
||||
type ControlInstance struct {
|
||||
ProbeID string
|
||||
NodeID string
|
||||
Control Control
|
||||
}
|
||||
|
||||
// Node is the data type that's yielded to the JavaScript layer when
|
||||
// we want deep information about an individual node.
|
||||
type Node struct {
|
||||
NodeSummary
|
||||
Controls []ControlInstance `json:"controls"`
|
||||
Children []NodeSummaryGroup `json:"children,omitempty"`
|
||||
Connections []ConnectionsSummary `json:"connections,omitempty"`
|
||||
}
|
||||
|
||||
type APINode struct {
|
||||
Node Node `json:"node"`
|
||||
}
|
||||
|
||||
type TopologyResponse struct {
|
||||
APITopology
|
||||
}
|
||||
|
||||
type NodeResponse struct {
|
||||
APINode
|
||||
}
|
||||
Reference in New Issue
Block a user