Merge pull request #14383 from ioito/hotfix/qx-api-doc

fix(region): api doc

pkg/apis/compute/zz_generated.model.go

@@ -1129,6 +1129,7 @@ type SGuest struct {
 	// 套餐名称
 	InstanceType     string `json:"instance_type"`
 	SshableLastState *bool  `json:"sshable_last_state,omitempty"`
+	IsDaemon         *bool  `json:"is_daemon,omitempty"`
 }
 
 // SGuestJointsBase is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SGuestJointsBase.
@@ -1675,6 +1676,8 @@ type SLoadbalancerAgent struct {
 	HbLastSeen                time.Time                     `json:"hb_last_seen"`
 	HbTimeout                 int                           `json:"hb_timeout"`
 	Params                    *SLoadbalancerAgentParams     `json:"params"`
+	Networks                  time.Time                     `json:"networks"`
+	LoadbalancerNetworks      time.Time                     `json:"loadbalancer_networks"`
 	Loadbalancers             time.Time                     `json:"loadbalancers"`
 	LoadbalancerListeners     time.Time                     `json:"loadbalancer_listeners"`
 	LoadbalancerListenerRules time.Time                     `json:"loadbalancer_listener_rules"`
@@ -1911,6 +1914,7 @@ type SLoadbalancerNetwork struct {
 	LoadbalancerId string `json:"loadbalancer_id"`
 	NetworkId      string `json:"network_id"`
 	IpAddr         string `json:"ip_addr"`
+	MacAddr        string `json:"mac_addr"`
 }
 
 // SLoadbalancerRateLimiter is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SLoadbalancerRateLimiter.

pkg/apis/identity/zz_generated.model.go

@@ -26,9 +26,13 @@ import (
 // SAssignment is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SAssignment.
 type SAssignment struct {
 	apis.SResourceBase
-	Type      string `json:"type"`
-	ActorId   string `json:"actor_id"`
-	TargetId  string `json:"target_id"`
+	// 关联类型，分为四类：'UserProject','GroupProject','UserDomain','GroupDomain'
+	Type string `json:"type"`
+	// 用户或者用户组ID
+	ActorId string `json:"actor_id"`
+	// 项目或者域ID
+	TargetId string `json:"target_id"`
+	// 角色ID
 	RoleId    string `json:"role_id"`
 	Inherited *bool  `json:"inherited,omitempty"`
 }
@@ -59,11 +63,14 @@ type SCredential struct {
 // SDomain is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SDomain.
 type SDomain struct {
 	apis.SStandaloneResourceBase
-	Extra    *jsonutils.JSONDict `json:"extra"`
-	Enabled  *bool               `json:"enabled,omitempty"`
-	IsDomain *bool               `json:"is_domain,omitempty"`
-	DomainId string              `json:"domain_id"`
-	ParentId string              `json:"parent_id"`
+	// 额外信息
+	Extra *jsonutils.JSONDict `json:"extra"`
+	// 改域是否启用
+	Enabled *bool `json:"enabled,omitempty"`
+	// 是否为域
+	IsDomain *bool  `json:"is_domain,omitempty"`
+	DomainId string `json:"domain_id"`
+	ParentId string `json:"parent_id"`
 }
 
 // SEnabledIdentityBaseResource is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SEnabledIdentityBaseResource.
@@ -113,6 +120,7 @@ type SFernetKey struct {
 // SGroup is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SGroup.
 type SGroup struct {
 	SIdentityBaseResource
+	// 用户组的显示名称
 	Displayname string `json:"displayname"`
 }
 
@@ -120,6 +128,7 @@ type SGroup struct {
 type SIdentityBaseResource struct {
 	apis.SStandaloneResourceBase
 	apis.SDomainizedResourceBase
+	// 额外信息
 	Extra *jsonutils.JSONDict `json:"extra"`
 }
 
@@ -223,8 +232,10 @@ type SPolicy struct {
 // SProject is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SProject.
 type SProject struct {
 	SIdentityBaseResource
+	// 上级项目或域的ID
 	ParentId string `json:"parent_id"`
-	IsDomain *bool  `json:"is_domain,omitempty"`
+	// 该项目是否为域（domain）
+	IsDomain *bool `json:"is_domain,omitempty"`
 }
 
 // SProjectExtended is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SProjectExtended.
@@ -297,18 +308,28 @@ type SServiceCertificate struct {
 type SUser struct {
 	apis.SRecordChecksumResourceBase
 	SEnabledIdentityBaseResource
-	Email           string    `json:"email"`
-	Mobile          string    `json:"mobile"`
-	Displayname     string    `json:"displayname"`
-	LastActiveAt    time.Time `json:"last_active_at"`
-	LastLoginIp     string    `json:"last_login_ip"`
-	LastLoginSource string    `json:"last_login_source"`
-	IsSystemAccount *bool     `json:"is_system_account,omitempty"`
+	// 用户邮箱
+	Email string `json:"email"`
+	// 用户手机号
+	Mobile string `json:"mobile"`
+	// 显示名称，用户登录后显示在右上角菜单入口
+	Displayname string `json:"displayname"`
+	// 上次登录时间
+	LastActiveAt time.Time `json:"last_active_at"`
+	// 上次用户登录IP
+	LastLoginIp string `json:"last_login_ip"`
+	// 上次用户登录方式，可能值有：web（web控制台），cli（命令行climc），API（api）
+	LastLoginSource string `json:"last_login_source"`
+	// 是否为系统账号，系统账号不会检查密码复杂度，默认不在列表显示
+	IsSystemAccount *bool `json:"is_system_account,omitempty"`
 	// deprecated
 	DefaultProjectId string `json:"default_project_id"`
-	AllowWebConsole  *bool  `json:"allow_web_console,omitempty"`
-	EnableMfa        *bool  `json:"enable_mfa,omitempty"`
-	Lang             string `json:"lang"`
+	// 是否允许登录Web控制台，如果是用于API访问的用户，可禁用web控制台登录
+	AllowWebConsole *bool `json:"allow_web_console,omitempty"`
+	// 是否开启MFA
+	EnableMfa *bool `json:"enable_mfa,omitempty"`
+	// 用户的默认语言设置，默认是zh_CN
+	Lang string `json:"lang"`
 }
 
 // SUserOption is an autogenerated struct via yunion.io/x/onecloud/pkg/keystone/models.SUserOption.

pkg/apis/input.go

@@ -348,6 +348,9 @@ type PerformClassMetadataInput map[string]string
 
 type PerformSetClassMetadataInput map[string]string
 
+type GetClassMetadataInput struct {
+}
+
 type GetClassMetadataOutput map[string]string
 
 // 获取资源的元数据输入

pkg/cloudcommon/db/standalone_anon.go

@@ -562,7 +562,7 @@ func (model *SStandaloneAnonResourceBase) PerformSetClassMetadata(ctx context.Co
 	return nil, nil
 }
 
-func (model *SStandaloneAnonResourceBase) GetDetailsClassMetadata(ctx context.Context, userCred mcclient.TokenCredential, input apis.GetClassMetadataOutput) (apis.GetClassMetadataOutput, error) {
+func (model *SStandaloneAnonResourceBase) GetDetailsClassMetadata(ctx context.Context, userCred mcclient.TokenCredential, input apis.GetClassMetadataInput) (apis.GetClassMetadataOutput, error) {
 	return model.GetAllClassMetadata()
 }