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: update api doc (#24496)

Browse Source
This commit is contained in:
屈轩
2026-03-19 11:01:11 +08:00
committed by GitHub
parent 17d3e9f0fb
commit abf2c17ef3
3 changed files with 149 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/swagger/swagger_compute.yaml
+105 -17
View File
@@ -5074,6 +5074,8 @@ definitions:
value:
type: string
x-go-name: Value
value_from:
$ref: '#/definitions/ContainerValueSource'
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
ContainerLifecyle:
@@ -5530,6 +5532,22 @@ definitions:
x-go-name: Timeout
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
ContainerValueSource:
properties:
credential:
$ref: '#/definitions/ContainerValueSourceCredential'
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
ContainerValueSourceCredential:
properties:
id:
type: string
x-go-name: Id
key:
type: string
x-go-name: Key
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
ContainerVolumeMount:
properties:
ceph_fs:
@@ -5672,6 +5690,8 @@ definitions:
type: string
type: object
x-go-name: PathMap
upper_config:
$ref: '#/definitions/PostOverlayUpperConfig'
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
ContainerVolumeMountDiskPostOverlay:
@@ -5697,6 +5717,10 @@ definitions:
type: string
type: array
x-go-name: HostLowerDir
host_upper_dir:
description: 宿主机上层目录
type: string
x-go-name: HostUpperDir
image:
$ref: '#/definitions/ContainerVolumeMountDiskPostImageOverlay'
type: object
@@ -8696,6 +8720,12 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
DiskConfig:
properties:
auto_delete:
description: |-
是否跟随主机删除而自动删除
默认跟随主机创建的磁盘为 true
type: boolean
x-go-name: AutoDelete
auto_reset:
description: 关机后自动重置磁盘
type: boolean
@@ -8904,6 +8934,12 @@ definitions:
user:rd: op
type: object
x-go-name: Metadata
auto_delete:
description: |-
是否跟随主机删除而自动删除
默认跟随主机创建的磁盘为 true
type: boolean
x-go-name: AutoDelete
auto_reset:
description: 关机后自动重置磁盘
type: boolean
@@ -9760,6 +9796,12 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
DiskUpdateInput:
properties:
auto_delete:
description: |-
是否跟随主机删除而自动删除
默认跟随主机创建的磁盘为 true
type: boolean
x-go-name: AutoDelete
auto_reset:
description: 关机自动重置
type: boolean
@@ -15756,10 +15798,16 @@ definitions:
example: 4d3c8979-9dd0-439b-8d78-36fe1ab1666c
type: string
x-go-name: ManagerProjectId
network_id:
type: string
x-go-name: NetworkId
network_index:
format: int64
type: integer
x-go-name: NetworkIndex
network_name:
type: string
x-go-name: NetworkName
project:
description: |-
资源归属项目的名称（向后兼容别名）
@@ -18533,11 +18581,11 @@ definitions:
description: 内存文件路径
type: string
x-go-name: MemoryFilePath
memory_size_mb:
memory_size_kb:
description: 内存文件大小
format: int64
type: integer
x-go-name: MemorySizeMB
x-go-name: MemorySizeKB
metadata:
additionalProperties:
type: string
@@ -18629,12 +18677,12 @@ definitions:
type: object
x-go-name: ServerMetadata
size:
description: 主机快照大小
description: 主机快照大小, B
format: int64
type: integer
x-go-name: Size
size_mb:
description: 主机快照磁盘容量和
description: 主机快照大小, MiB
format: int64
type: integer
x-go-name: SizeMb
@@ -18678,6 +18726,11 @@ definitions:
format: date-time
type: string
x-go-name: UpdatedAt
virtual_size_mb:
description: 主机磁盘大小, MiB
format: int64
type: integer
x-go-name: VirtualSizeMb
with_memory:
description: 是否保存内存
type: boolean
@@ -29876,6 +29929,24 @@ definitions:
x-go-name: UpdatedAt
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
PostOverlayUpperConfig:
properties:
disk:
$ref: '#/definitions/PostOverlayUpperConfigDisk'
type:
$ref: '#/definitions/PostOverlayUpperConfigType'
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
PostOverlayUpperConfigDisk:
properties:
sub_path:
type: string
x-go-name: SubPath
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis
PostOverlayUpperConfigType:
type: string
x-go-package: yunion.io/x/onecloud/pkg/apis
PostpaidExpireInput:
properties:
duration:
@@ -30891,6 +30962,12 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
SBackupDiskConfig:
properties:
auto_delete:
description: |-
是否跟随主机删除而自动删除
默认跟随主机创建的磁盘为 true
type: boolean
x-go-name: AutoDelete
auto_reset:
description: 关机后自动重置磁盘
type: boolean
@@ -40136,7 +40213,7 @@ definitions:
type: string
x-go-name: Name
size:
description: 快照大小
description: 快照大小, MiB
format: int64
type: integer
x-go-name: Size
@@ -40152,6 +40229,11 @@ definitions:
description: 存储类型
type: string
x-go-name: StorageType
virtual_size:
description: 磁盘大小, MiB
format: int64
type: integer
x-go-name: VirtualSize
type: object
x-go-package: yunion.io/x/onecloud/pkg/apis/compute
SimpleSnapshotPolicy:
@@ -101645,18 +101727,18 @@ paths:
name: refresh
type: boolean
x-go-name: Refresh
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
- description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
responses:
"200":
$ref: '#/responses/models_GetQuotaOutput'
@@ -115011,6 +115093,12 @@ paths:
name: type
type: string
x-go-name: Type
- in: query
items:
type: string
name: resource_id
type: array
x-go-name: ResourceId
responses:
"200":
$ref: '#/responses/snapshotpolicy_ListItemFilterOutput'
@@ -126240,18 +126328,18 @@ paths:
name: refresh
type: boolean
x-go-name: Refresh
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
- description: 配额所属范围，可能值为projects和domains，分别代表项目的配额和域的配额
in: path
name: scope
required: true
type: string
x-go-name: Scope
- description: 指定项目或者域的ID
in: path
name: scopeId
required: true
type: string
x-go-name: ScopeId
responses:
"200":
$ref: '#/responses/models_GetZoneQuotaOutput'
docs/swagger/swagger_identity.yaml
+11
View File
@@ -172,6 +172,10 @@ definitions:
x-go-package: yunion.io/x/onecloud/pkg/apis/identity
CredentialUpdateInput:
properties:
blob:
description: 更新 blob 内容（明文，服务端加密后写入 encrypted_blob）
type: string
x-go-name: Blob
description:
description: 资源描述
type: string
@@ -180,6 +184,13 @@ definitions:
description: enabled
type: boolean
x-go-name: Enabled
encrypted_blob:
description: 由 ValidateUpdateData 在提供 blob 时填充，不允许客户端直接传入
type: string
x-go-name: EncryptedBlob
key_hash:
type: string
x-go-name: KeyHash
name:
description: 资源名称
type: string
docs/swagger/swagger_monitor.yaml
+33
View File
@@ -73,6 +73,9 @@ definitions:
description: 没有收到监控指标时将当前报警状态设置为对应的状态
type: string
x-go-name: NoDataState
reason:
type: string
x-go-name: Reason
settings:
$ref: '#/definitions/AlertSetting'
used_by:
@@ -592,6 +595,9 @@ definitions:
x-go-name: ProjectOrganizations
project_tags:
$ref: '#/definitions/TTagSetList'
reason:
type: string
x-go-name: Reason
refresh:
type: string
x-go-name: Refresh
@@ -1266,6 +1272,9 @@ definitions:
description: 资源描述信息
type: string
x-go-name: Description
disable_notify_recovery:
type: boolean
x-go-name: DisableNotifyRecovery
domain_id:
description: 域Id
type: string
@@ -1576,6 +1585,10 @@ definitions:
description: 没有收到监控指标时将当前报警状态设置为对应的状态
type: string
x-go-name: NoDataState
reason:
description: 报警原因
type: string
x-go-name: Reason
settings:
$ref: '#/definitions/AlertSetting'
type: object
@@ -1604,6 +1617,10 @@ definitions:
description:
type: string
x-go-name: Description
disable_notify_recovery:
description: 为 true 时不发送恢复通知（OK）
type: boolean
x-go-name: DisableNotifyRecovery
domain_id:
type: string
x-go-name: DomainId
@@ -1661,6 +1678,9 @@ definitions:
project_id:
type: string
x-go-name: ProjectId
reason:
type: string
x-go-name: Reason
recipients:
description: 通知接受者
items:
@@ -1750,6 +1770,9 @@ definitions:
description: 资源描述信息
type: string
x-go-name: Description
disable_notify_recovery:
type: boolean
x-go-name: DisableNotifyRecovery
domain_id:
description: 域Id
type: string
@@ -3019,6 +3042,9 @@ definitions:
description: Period of querying metrics
type: string
x-go-name: Period
reason:
type: string
x-go-name: Reason
settings:
$ref: '#/definitions/AlertSetting'
threshold:
@@ -3376,6 +3402,9 @@ definitions:
description: 查询指标周期
type: string
x-go-name: Period
reason:
type: string
x-go-name: Reason
recipients:
description: 通知接受者
type: string
@@ -3682,6 +3711,10 @@ definitions:
description: 查询指标周期
type: string
x-go-name: Period
reason:
description: 报警原因
type: string
x-go-name: Reason
recipients:
description: 通知接受者
type: string