refine api docs

Signed-off-by: hongming <talonwan@yunify.com>
2020-10-22 18:43:14 +08:00
parent 44799ae68a
commit 496db42be6
36 changed files with 1725 additions and 2399 deletions
--- a/pkg/constants/constants.go
+++ b/pkg/constants/constants.go
@@ -32,63 +32,80 @@ const (
 	AdminUserName                 = "admin"
 	IngressControllerPrefix       = "kubesphere-router-"

-	WorkspaceLabelKey              = "kubesphere.io/workspace"
-	NamespaceLabelKey              = "kubesphere.io/namespace"
-	RuntimeLabelKey                = "openpitrix.io/namespace"
-	DisplayNameAnnotationKey       = "kubesphere.io/alias-name"
-	DescriptionAnnotationKey       = "kubesphere.io/description"
-	CreatorAnnotationKey           = "kubesphere.io/creator"
-	UsernameLabelKey               = "kubesphere.io/username"
-	System                         = "system"
-	OpenPitrixRuntimeAnnotationKey = "openpitrix_runtime"
-	WorkspaceAdmin                 = "workspace-admin"
-	ClusterAdmin                   = "cluster-admin"
-	WorkspaceRegular               = "workspace-regular"
-	WorkspaceViewer                = "workspace-viewer"
-	WorkspacesManager              = "workspaces-manager"
-	DevopsOwner                    = "owner"
-	DevopsReporter                 = "reporter"
-	DevOpsProjectLabelKey          = "kubesphere.io/devopsproject"
-	KubefedManagedLabel            = "kubefed.io/managed"
+	WorkspaceLabelKey        = "kubesphere.io/workspace"
+	NamespaceLabelKey        = "kubesphere.io/namespace"
+	DisplayNameAnnotationKey = "kubesphere.io/alias-name"
+	DescriptionAnnotationKey = "kubesphere.io/description"
+	CreatorAnnotationKey     = "kubesphere.io/creator"
+	UsernameLabelKey         = "kubesphere.io/username"
+	DevOpsProjectLabelKey    = "kubesphere.io/devopsproject"
+	KubefedManagedLabel      = "kubefed.io/managed"

 	UserNameHeader = "X-Token-Username"

-	TenantResourcesTag         = "Tenant Resources"
-	IdentityManagementTag      = "Identity Management"
-	AccessManagementTag        = "Access Management"
-	NamespaceResourcesTag      = "Namespace Resources"
-	ClusterResourcesTag        = "Cluster Resources"
-	ComponentStatusTag         = "Component Status"
-	OpenpitrixTag              = "Openpitrix Resources"
-	VerificationTag            = "Verification"
-	RegistryTag                = "Docker Registry"
-	NetworkTopologyTag         = "Network Topology"
-	UserResourcesTag           = "User Resources"
-	DevOpsProjectTag           = "DevOps Project"
-	DevOpsProjectCredentialTag = "DevOps Project Credential"
-	DevOpsProjectMemberTag     = "DevOps Project Member"
-	DevOpsPipelineTag          = "DevOps Pipeline"
-	DevOpsWebhookTag           = "DevOps Webhook"
-	DevOpsJenkinsfileTag       = "DevOps Jenkinsfile"
-	DevOpsScmTag               = "DevOps Scm"
-	KubeSphereMetricsTag       = "KubeSphere Metrics"
-	ClusterMetricsTag          = "Cluster Metrics"
-	NodeMetricsTag             = "Node Metrics"
-	NamespaceMetricsTag        = "Namespace Metrics"
-	PodMetricsTag              = "Pod Metrics"
-	PVCMetricsTag              = "PVC Metrics"
-	ContainerMetricsTag        = "Container Metrics"
-	WorkloadMetricsTag         = "Workload Metrics"
-	WorkspaceMetricsTag        = "Workspace Metrics"
-	ComponentMetricsTag        = "Component Metrics"
-	CustomMetricsTag           = "Custom Metrics"
-	LogQueryTag                = "Log Query"
-	TerminalTag                = "Terminal"
-	EventsQueryTag             = "Events Query"
-	AuditingQueryTag           = "Auditing Query"
+	AuthenticationTag = "Authentication"
+	UserTag           = "User"
+	GroupTag          = "Group"
+
+	WorkspaceMemberTag     = "Workspace Member"
+	DevOpsProjectMemberTag = "DevOps Project Member"
+	NamespaceMemberTag     = "Namespace Member"
+	ClusterMemberTag       = "Cluster Member"
+
+	GlobalRoleTag        = "Global Role"
+	ClusterRoleTag       = "Cluster Role"
+	WorkspaceRoleTag     = "Workspace Role"
+	DevOpsProjectRoleTag = "DevOps Project Role"
+	NamespaceRoleTag     = "Namespace Role"
+
+	OpenpitrixAppInstanceTag = "App Instance"
+	OpenpitrixAppTemplateTag = "App Template"
+	OpenpitrixCategoryTag    = "Category"
+	OpenpitrixAttachmentTag  = "Attachment"
+	OpenpitrixRepositoryTag  = "Repository"
+	OpenpitrixManagementTag  = "App Management"
+
+	DevOpsCredentialTag  = "DevOps Credential"
+	DevOpsPipelineTag    = "DevOps Pipeline"
+	DevOpsWebhookTag     = "DevOps Webhook"
+	DevOpsJenkinsfileTag = "DevOps Jenkinsfile"
+	DevOpsScmTag         = "DevOps Scm"
+	DevOpsJenkinsTag     = "Jenkins"
+
+	ToolboxTag      = "Toolbox"
+	RegistryTag     = "Docker Registry"
+	GitTag          = "Git"
+	TerminalTag     = "Terminal"
+	MultiClusterTag = "Multi-cluster"
+
+	WorkspaceTag     = "Workspace"
+	NamespaceTag     = "Namespace"
+	DevOpsProjectTag = "DevOps Project"
+	UserResourceTag  = "User's Resources"
+
+	NamespaceResourcesTag = "Namespace Resources"
+	ClusterResourcesTag   = "Cluster Resources"
+	ComponentStatusTag    = "Component Status"
+
+	NetworkTopologyTag = "Network Topology"
+
+	KubeSphereMetricsTag = "KubeSphere Metrics"
+	ClusterMetricsTag    = "Cluster Metrics"
+	NodeMetricsTag       = "Node Metrics"
+	NamespaceMetricsTag  = "Namespace Metrics"
+	PodMetricsTag        = "Pod Metrics"
+	PVCMetricsTag        = "PVC Metrics"
+	ContainerMetricsTag  = "Container Metrics"
+	WorkloadMetricsTag   = "Workload Metrics"
+	WorkspaceMetricsTag  = "Workspace Metrics"
+	ComponentMetricsTag  = "Component Metrics"
+	CustomMetricsTag     = "Custom Metrics"
+
+	LogQueryTag      = "Log Query"
+	EventsQueryTag   = "Events Query"
+	AuditingQueryTag = "Auditing Query"
 )

 var (
-	WorkSpaceRoles   = []string{WorkspaceAdmin, WorkspaceRegular, WorkspaceViewer}
 	SystemNamespaces = []string{KubeSphereNamespace, KubeSphereLoggingNamespace, KubeSphereMonitoringNamespace, OpenPitrixNamespace, KubeSystemNamespace, IstioNamespace, KubesphereDevOpsNamespace, PorterNamespace}
 )