opensource/cloudpods
3
0
Fork 0
mirror of https://github.com/yunionio/cloudpods.git synced 2026-08-29 03:51:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): update swagger api (#22599)

Browse Source
This commit is contained in:
屈轩
2025-05-26 10:51:19 +08:00
committed by GitHub
parent b879705eb3
commit 52839ca149
24 changed files with 7376 additions and 6245 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/swagger/swagger_cloudevent.yaml
+11 -7
View File
@@ -414,6 +414,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- description: 指定查询的权限范围，可能值为project, domain or system
in: query
name: scope
@@ -489,13 +494,7 @@ paths:
name: providers
type: array
x-go-name: Providers
- description: |-
列出指定云平台品牌的资源，一般来说brand和provider相同，除了以上支持的provider之外，还支持以下band
Brand | Provider | 说明 |
----------|----------|------------|
DStack | ZStack | 滴滴云私有云 |
in: query
- in: query
items:
type: string
name: brands
@@ -860,6 +859,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
docs/swagger/swagger_cloudid.yaml
+30
View File
@@ -1854,6 +1854,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -2827,6 +2832,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -3573,6 +3583,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -4399,6 +4414,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -5358,6 +5378,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -6129,6 +6154,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
docs/swagger/swagger_compute.yaml
+3101 -709
View File
File diff suppressed because it is too large Load Diff
docs/swagger/swagger_identity.yaml
+85
View File
@@ -4419,6 +4419,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -4990,6 +4995,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -5575,6 +5585,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -6124,6 +6139,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -6843,6 +6863,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -7804,6 +7829,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -8423,6 +8453,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -9216,6 +9251,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -9974,6 +10014,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -10704,6 +10749,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -11231,6 +11281,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- in: query
items:
type: string
@@ -11517,6 +11572,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -12271,6 +12331,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
responses:
"200":
$ref: '#/responses/scope_resource_ListItemFilterOutput'
@@ -12539,6 +12604,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -13058,6 +13128,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -13652,6 +13727,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -14186,6 +14266,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
docs/swagger/swagger_image.yaml
+62
View File
@@ -777,6 +777,50 @@ definitions:
x-go-name: UpdatedAt
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/image
ImageUpdateInput:
properties:
description:
description: 资源描述
type: string
x-go-name: Description
is_data:
description: 是否是数据盘镜像
type: boolean
x-go-name: IsData
is_standard:
description: 是否是标准镜像
type: boolean
x-go-name: IsStandard
min_disk:
description: 最小系统盘要求
format: int32
type: integer
x-go-name: MinDiskMB
min_ram:
description: 最小内存要求
format: int32
type: integer
x-go-name: MinRamMB
name:
description: 资源名称
type: string
x-go-name: Name
progress:
format: float
type: number
x-go-name: Progress
properties:
additionalProperties:
type: string
description: 镜像属性
type: object
x-go-name: Properties
protected:
description: 是否有删除保护
type: boolean
x-go-name: Protected
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/image
ImageUpdateStatusInput:
properties:
reason:
@@ -1238,6 +1282,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -2252,6 +2301,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -2583,6 +2637,14 @@ paths:
required: true
type: string
x-go-name: Id
- in: body
name: body
schema:
properties:
image:
$ref: '#/definitions/ImageUpdateInput'
type: object
x-go-name: Body
responses:
"200":
$ref: '#/responses/image_ValidateUpdateDataOutput'
docs/swagger/swagger_monitor.yaml
+3810 -3777
View File
File diff suppressed because it is too large Load Diff
docs/swagger/swagger_notify.yaml
+231 -1748
View File
File diff suppressed because it is too large Load Diff
docs/swagger/swagger_yunionconf.yaml
+15
View File
@@ -549,6 +549,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- in: query
name: namespace_id
type: string
@@ -841,6 +846,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- $ref: '#/definitions/TTagSet'
description: 通过标签过滤（包含这些标签）
in: query
@@ -1569,6 +1579,11 @@ paths:
name: show_fail_reason
type: boolean
x-go-name: ShowFailReason
- description: 是否返回状态统计信息，默认为False
in: query
name: summary_stats
type: boolean
x-go-name: SummaryStats
- in: query
items:
type: string
pkg/apis/compute/zz_generated.model.go
+3
View File
@@ -141,6 +141,7 @@ type SBucket struct {
SizeBytesLimit int64 `json:"size_bytes_limit"`
ObjectCntLimit int `json:"object_cnt_limit"`
AccessUrls jsonutils.JSONObject `json:"access_urls"`
EnablePerfMon bool `json:"enable_perf_mon"`
}
// SCDNDomain is an autogenerated struct via yunion.io/x/onecloud/pkg/compute/models.SCDNDomain.
@@ -610,6 +611,8 @@ type SDnsRecord struct {
DnsValue string `json:"dns_value"`
TTL int64 `json:"ttl"`
MxPriority int64 `json:"mx_priority"`
// cloudflare 特有
Proxied *bool `json:"proxied,omitempty"`
// 解析线路类型
PolicyType string `json:"policy_type"`
// 解析线路
pkg/monitor/models/alertdashboard.go
+2
View File
@@ -31,6 +31,8 @@ import (
"yunion.io/x/onecloud/pkg/util/stringutils2"
)
// +onecloud:swagger-gen-model-singular=alertdashboard
// +onecloud:swagger-gen-model-plural=alertdashboard
type SAlertDashBoardManager struct {
db.SEnabledResourceBaseManager
db.SStatusStandaloneResourceBaseManager
pkg/monitor/models/alertdashboard_panel.go
+2
View File
@@ -25,6 +25,8 @@ var (
AlertDashBoardPanelManager *SAlertDashboardPanelManager
)
// +onecloud:swagger-gen-model-singular=alertdashboardpanel
// +onecloud:swagger-gen-model-plural=alertdashboardpanels
type SAlertDashboardPanelManager struct {
db.SJointResourceBaseManager
}
pkg/monitor/models/alertpannel.go
+2
View File
@@ -49,6 +49,8 @@ func init() {
AlertPanelManager.SetVirtualObject(AlertPanelManager)
}
// +onecloud:swagger-gen-model-singular=alertpanel
// +onecloud:swagger-gen-model-plural=alertpanels
type SAlertPanelManager struct {
db.SStatusStandaloneResourceBaseManager
db.SScopedResourceBaseManager
pkg/monitor/models/alertrecord.go
+2
View File
@@ -40,6 +40,8 @@ var (
AlertRecordManager *SAlertRecordManager
)
// +onecloud:swagger-gen-model-singular=alertrecord
// +onecloud:swagger-gen-model-plural=alertrecords
type SAlertRecordManager struct {
db.SEnabledResourceBaseManager
db.SStandaloneAnonResourceBaseManager
pkg/monitor/models/alertresource.go
+2
View File
@@ -58,6 +58,8 @@ func GetAlertResourceManager() *SAlertResourceManager {
return alertResourceManager
}
// +onecloud:swagger-gen-model-singular=alertresource
// +onecloud:swagger-gen-model-plural=alertresources
type SAlertResourceManager struct {
db.SStandaloneResourceBaseManager
}
pkg/monitor/models/commonalert.go
+2
View File
@@ -87,6 +87,8 @@ type ISubscriptionManager interface {
DeleteAlert(alert *SCommonAlert)
}
// +onecloud:swagger-gen-model-singular=commonalert
// +onecloud:swagger-gen-model-plural=commonalerts
type SCommonAlertManager struct {
SAlertManager
subscriptionManager ISubscriptionManager
pkg/monitor/models/datasource.go
+2
View File
@@ -71,6 +71,8 @@ func init() {
DataSourceManager.SetVirtualObject(DataSourceManager)
}
// +onecloud:swagger-gen-model-singular=datasource
// +onecloud:swagger-gen-model-plural=datasources
type SDataSourceManager struct {
db.SStandaloneResourceBaseManager
}
pkg/monitor/models/meteralert.go
+2
View File
@@ -54,6 +54,8 @@ type IMeterAlertDriver interface {
ToAlertCreateInput(input monitor.MeterAlertCreateInput, allAccountIds []string, level string) monitor.AlertCreateInput
}
// +onecloud:swagger-gen-model-singular=meteralert
// +onecloud:swagger-gen-model-plural=meteralerts
type SMeterAlertManager struct {
SV1AlertManager
pkg/monitor/models/metric.go
+2
View File
@@ -54,6 +54,8 @@ func init() {
registry.RegisterService(MetricMeasurementManager)
}
// +onecloud:swagger-gen-model-singular=metricmeasurement
// +onecloud:swagger-gen-model-plural=metricmeasurements
type SMetricMeasurementManager struct {
db.SEnabledResourceBaseManager
db.SStatusStandaloneResourceBaseManager
pkg/monitor/models/metric_field.go
+2
View File
@@ -32,6 +32,8 @@ import (
"yunion.io/x/onecloud/pkg/util/stringutils2"
)
// +onecloud:swagger-gen-model-singular=metricfield
// +onecloud:swagger-gen-model-plural=metricfields
type SMetricFieldManager struct {
db.SEnabledResourceBaseManager
db.SStatusStandaloneResourceBaseManager
pkg/monitor/models/migration_alert.go
+2
View File
@@ -48,6 +48,8 @@ func GetMigrationAlertManager() *SMigrationAlertManager {
return migrationAlertMan
}
// +onecloud:swagger-gen-model-singular=migrationalert
// +onecloud:swagger-gen-model-plural=migrationalerts
type SMigrationAlertManager struct {
SAlertManager
}
pkg/monitor/models/monitor_resource.go
+2
View File
@@ -92,6 +92,8 @@ func (manager *SMonitorResourceManager) GetModelSets() *MonitorResModelSets {
return manager.monitorResModelSets
}
// +onecloud:swagger-gen-model-singular=monitorresource
// +onecloud:swagger-gen-model-plural=monitorresources
type SMonitorResourceManager struct {
db.SVirtualResourceBaseManager
db.SEnabledResourceBaseManager
pkg/monitor/models/monitor_resource_alert.go
+2
View File
@@ -47,6 +47,8 @@ func init() {
MonitorResourceAlertManager.SetVirtualObject(MonitorResourceAlertManager)
}
// +onecloud:swagger-gen-model-singular=monitorresourcealert
// +onecloud:swagger-gen-model-plural=monitorresourcealerts
type SMonitorResourceAlertManager struct {
db.SJointResourceBaseManager
SMonitorScopedResourceManager
pkg/monitor/models/nodealert.go
+2
View File
@@ -55,6 +55,8 @@ type SV1AlertManager struct {
SAlertManager
}
// +onecloud:swagger-gen-model-singular=nodealert
// +onecloud:swagger-gen-model-plural=nodealerts
type SNodeAlertManager struct {
SCommonAlertManager
}
pkg/monitor/models/notification.go
-4
View File
@@ -45,10 +45,6 @@ type SNotificationManager struct {
db.SVirtualResourceBaseManager
}
type SAlertNotificationStateManager struct {
db.SStandaloneResourceBaseManager
}
func NewNotificationManager() *SNotificationManager {
man := &SNotificationManager{
SVirtualResourceBaseManager: db.NewVirtualResourceBaseManager(