mirror of
https://github.com/gravitl/netmaker.git
synced 2025-10-05 16:57:51 +08:00
Update swagger docs
This commit is contained in:
@@ -11,7 +11,7 @@
|
||||
//
|
||||
// Schemes: https
|
||||
// BasePath: /
|
||||
// Version: 0.15.1
|
||||
// Version: 0.15.2
|
||||
// Host: netmaker.io
|
||||
//
|
||||
// Consumes:
|
||||
@@ -25,3 +25,327 @@
|
||||
//
|
||||
// swagger:meta
|
||||
package controller
|
||||
|
||||
import (
|
||||
serverconfigpkg "github.com/gravitl/netmaker/config"
|
||||
"github.com/gravitl/netmaker/logic/acls"
|
||||
"github.com/gravitl/netmaker/models"
|
||||
"github.com/gravitl/netmaker/netclient/config"
|
||||
)
|
||||
|
||||
// swagger:parameters getNodeDNS getCustomDNS getDNS
|
||||
type dnsPathParams struct {
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
}
|
||||
|
||||
// swagger:parameters createDNS
|
||||
type dnsParams struct {
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
|
||||
// DNS Entry
|
||||
// in: body
|
||||
Body []models.DNSEntry `json:"body"`
|
||||
}
|
||||
|
||||
// Success
|
||||
// swagger:response dnsResponse
|
||||
type dnsResponse struct {
|
||||
// in: body
|
||||
Body []models.DNSEntry `json:"body"`
|
||||
}
|
||||
|
||||
// swagger:parameters deleteDNS
|
||||
type dnsDeletePathParams struct {
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
|
||||
// Domain
|
||||
// in: path
|
||||
Domain string `json:"domain"`
|
||||
}
|
||||
|
||||
// swagger:response stringJSONResponse
|
||||
type stringJSONResponse struct {
|
||||
// Response
|
||||
// in: body
|
||||
Response string `json:"response"`
|
||||
}
|
||||
|
||||
// swagger:parameters getAllExtClients
|
||||
type getAllClientsRequest struct {
|
||||
// Networks
|
||||
// in:body
|
||||
Networks []string `json:"networks"`
|
||||
}
|
||||
|
||||
// swagger:response extClientSliceResponse
|
||||
type extClientSliceResponse struct {
|
||||
// ExtClients
|
||||
// in: body
|
||||
ExtClients []models.ExtClient `json:"ext_clients"`
|
||||
}
|
||||
|
||||
// swagger:response extClientResponse
|
||||
type extClientResponse struct {
|
||||
// ExtClient
|
||||
// in: body
|
||||
ExtClient models.ExtClient `json:"ext_client"`
|
||||
}
|
||||
|
||||
// swagger:response successResponse
|
||||
type successResponse struct {
|
||||
// Success Response
|
||||
// in: body
|
||||
SuccessResponse models.SuccessResponse `json:"success_response"`
|
||||
}
|
||||
|
||||
// swagger:parameters getExtClient getExtClientConf updateExtClient deleteExtClient
|
||||
type extClientPathParams struct {
|
||||
// Client ID
|
||||
// in: path
|
||||
ClientID string `json:"clientid"`
|
||||
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
}
|
||||
|
||||
// swagger:parameters updateExtClient
|
||||
type extClientBodyParam struct {
|
||||
// ExtClient
|
||||
// in: body
|
||||
ExtClient models.ExtClient `json:"ext_client"`
|
||||
}
|
||||
|
||||
// swagger:parameters getNetworkExtClients
|
||||
type extClientNetworkPathParam struct {
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
}
|
||||
|
||||
// swagger:parameters createExtClient
|
||||
type createExtClientPathParams struct {
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
|
||||
// Node ID
|
||||
// in: path
|
||||
NodeID string `json:"node"`
|
||||
|
||||
// Custom ExtClient
|
||||
// in: body
|
||||
CustomExtClient models.CustomExtClient `json:"custom_ext_client"`
|
||||
}
|
||||
|
||||
// swagger:parameters getNode updateNode deleteNode createRelay deleteRelay createEgressGateway deleteEgressGateway createIngressGateway deleteIngressGateway uncordonNode
|
||||
type networkNodePathParams struct {
|
||||
// Network
|
||||
// in: path
|
||||
Network string `json:"network"`
|
||||
|
||||
// Node ID
|
||||
// in: path
|
||||
NodeID string `json:"nodeid"`
|
||||
}
|
||||
|
||||
// swagger:response byteArrayResponse
|
||||
type byteArrayResponse struct {
|
||||
// in: body
|
||||
ByteArray []byte `json:"byte_array"`
|
||||
}
|
||||
|
||||
// swagger:parameters getNetworks
|
||||
type headerNetworks struct {
|
||||
// name: networks
|
||||
// in: header
|
||||
Networks []string `json:"networks"`
|
||||
}
|
||||
|
||||
// swagger:response getNetworksSliceResponse
|
||||
type getNetworksSliceResponse struct {
|
||||
// Networks
|
||||
// in: body
|
||||
Networks []models.Network `json:"networks"`
|
||||
}
|
||||
|
||||
// swagger:parameters createNetwork updateNetwork
|
||||
type networkBodyParam struct {
|
||||
// Network
|
||||
// in: body
|
||||
Network models.Network `json:"network"`
|
||||
}
|
||||
|
||||
// swagger:parameters updateNetwork getNetwork updateNetwork updateNetworkNodeLimit deleteNetwork keyUpdate createAccessKey getAccessKeys deleteAccessKey updateNetworkACL getNetworkACL
|
||||
type networkPathParam struct {
|
||||
// Network Name
|
||||
// in: path
|
||||
NetworkName string `json:"networkname"`
|
||||
}
|
||||
|
||||
// swagger:parameters deleteAccessKey
|
||||
type networkAccessKeyNamePathParam struct {
|
||||
// Access Key Name
|
||||
// in: path
|
||||
AccessKeyName string `json:"access_key_name"`
|
||||
}
|
||||
|
||||
// swagger:response networkBodyResponse
|
||||
type networkBodyResponse struct {
|
||||
// Network
|
||||
// in: body
|
||||
Network models.Network `json:"network"`
|
||||
}
|
||||
|
||||
// swagger:parameters createAccessKey
|
||||
type accessKeyBodyParam struct {
|
||||
// Access Key
|
||||
// in: body
|
||||
AccessKey models.AccessKey `json:"access_key"`
|
||||
}
|
||||
|
||||
// swagger:response accessKeyBodyResponse
|
||||
type accessKeyBodyResponse struct {
|
||||
// Access Key
|
||||
// in: body
|
||||
AccessKey models.AccessKey `json:"access_key"`
|
||||
}
|
||||
|
||||
// swagger:response accessKeySliceBodyResponse
|
||||
type accessKeySliceBodyResponse struct {
|
||||
// Access Keys
|
||||
// in: body
|
||||
AccessKey []models.AccessKey `json:"access_key"`
|
||||
}
|
||||
|
||||
// swagger:parameters updateNetworkACL getNetworkACL
|
||||
type aclContainerBodyParam struct {
|
||||
// ACL Container
|
||||
// in: body
|
||||
ACLContainer acls.ACLContainer `json:"acl_container"`
|
||||
}
|
||||
|
||||
// swagger:response aclContainerResponse
|
||||
type aclContainerResponse struct {
|
||||
// ACL Container
|
||||
// in: body
|
||||
ACLContainer acls.ACLContainer `json:"acl_container"`
|
||||
}
|
||||
|
||||
// swagger:response nodeSliceResponse
|
||||
type nodeSliceResponse struct {
|
||||
// Nodes
|
||||
// in: body
|
||||
Nodes []models.Node `json:"nodes"`
|
||||
}
|
||||
|
||||
// swagger:response nodeResponse
|
||||
type nodeResponse struct {
|
||||
// Node
|
||||
// in: body
|
||||
Node models.Node `json:"node"`
|
||||
}
|
||||
|
||||
// swagger:parameters updateNode deleteNode
|
||||
type nodeBodyParam struct {
|
||||
// Node
|
||||
// in: body
|
||||
Node models.Node `json:"node"`
|
||||
}
|
||||
|
||||
// swagger:parameters createRelay
|
||||
type relayRequestBodyParam struct {
|
||||
// Relay Request
|
||||
// in: body
|
||||
RelayRequest models.RelayRequest `json:"relay_request"`
|
||||
}
|
||||
|
||||
// swagger:parameters createEgressGateway
|
||||
type egressGatewayBodyParam struct {
|
||||
// Egress Gateway Request
|
||||
// in: body
|
||||
EgressGatewayRequest models.EgressGatewayRequest `json:"egress_gateway_request"`
|
||||
}
|
||||
|
||||
// swagger:parameters authenticate
|
||||
type authParamBodyParam struct {
|
||||
// AuthParams
|
||||
// in: body
|
||||
AuthParams models.AuthParams `json:"auth_params"`
|
||||
}
|
||||
|
||||
// swagger:response serverConfigResponse
|
||||
type serverConfigResponse struct {
|
||||
// Server Config
|
||||
// in: body
|
||||
ServerConfig serverconfigpkg.ServerConfig `json:"server_config"`
|
||||
}
|
||||
|
||||
// swagger:response nodeGetResponse
|
||||
type nodeGetResponse struct {
|
||||
// Node Get
|
||||
// in: body
|
||||
NodeGet models.NodeGet `json:"node_get"`
|
||||
}
|
||||
|
||||
// swagger:response nodeLastModifiedResponse
|
||||
type nodeLastModifiedResponse struct {
|
||||
// Node Last Modified
|
||||
// in: body
|
||||
NodesLastModified int64 `json:"nodes_last_modified"`
|
||||
}
|
||||
|
||||
// swagger:parameters register
|
||||
type registerRequestBodyParam struct {
|
||||
// Register Request
|
||||
// in: body
|
||||
RegisterRequest config.RegisterRequest `json:"register_request"`
|
||||
}
|
||||
|
||||
// swagger:response registerResponse
|
||||
type registerResponse struct {
|
||||
// Register Response
|
||||
// in: body
|
||||
RegisterResponse config.RegisterResponse `json:"register_response"`
|
||||
}
|
||||
|
||||
// swagger:response boolResponse
|
||||
type boolResponse struct {
|
||||
// Boolean Response
|
||||
// in: body
|
||||
BoolResponse bool `json:"bool_response"`
|
||||
}
|
||||
|
||||
// swagger:parameters createAdmin updateUser updateUserNetworks createUser
|
||||
type userBodyParam struct {
|
||||
// User
|
||||
// in: body
|
||||
User models.User `json:"user"`
|
||||
}
|
||||
|
||||
// swagger:response userBodyResponse
|
||||
type userBodyResponse struct {
|
||||
// User
|
||||
// in: body
|
||||
User models.User `json:"user"`
|
||||
}
|
||||
|
||||
// swagger:parameters authenticateUser
|
||||
type userAuthBodyParam struct {
|
||||
// User Auth Params
|
||||
// in: body
|
||||
UserAuthParams models.UserAuthParams `json:"user_auth_params"`
|
||||
}
|
||||
|
||||
// swagger:parameters updateUser updateUserNetworks updateUserAdm createUser deleteUser getUser
|
||||
type usernamePathParam struct {
|
||||
// Username
|
||||
// in: path
|
||||
Username string `json:"username"`
|
||||
}
|
||||
|
Reference in New Issue
Block a user