RepoMirrors/go-ceph
1
0
Fork 0
mirror of https://github.com/ceph/go-ceph synced 2025-02-26 07:30:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update api-status for new mirroring image replay status funcs

Browse Source 
Signed-off-by: John Mulligan <jmulligan@redhat.com>
This commit is contained in:
John Mulligan 2023-03-06 15:34:35 -05:00 committed by mergify[bot]
parent ab7955a236
commit 2270166490
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api-status.json
View File

@ -1786,6 +1786,18 @@
"comment": "MigrationStatus retrieve status of a live migration\nfor the specified image.\n\nImplements:\n int rbd_migration_status(rados_ioctx_t ioctx,\n const char *image_name,\n rbd_image_migration_status_t *status,\n size_t status_size);\n",
"added_in_version": "v0.20.0",
"expected_stable_version": "v0.22.0"
},
{
"name": "SiteMirrorImageStatus.UnmarshalDescriptionJSON",
"comment": "UnmarshalDescriptionJSON parses an embedded JSON string that may be found in\nthe description of the SiteMirrorImageStatus. It will store the result in\nthe value pointed to by v. If no embedded JSON string is found an\nErrNotExist error is returned. An error may also be returned if the contents\ncan not be parsed.\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
},
{
"name": "SiteMirrorImageStatus.DescriptionReplayStatus",
"comment": "DescriptionReplayStatus parses a MirrorDescriptionReplayStatus result out of\nthe image status description field if available. If the embedded status JSON\nis not found or fails to parse and error will be returned.\n",
"added_in_version": "$NEXT_RELEASE",
"expected_stable_version": "$NEXT_RELEASE_STABLE"
}
]
},

2
docs/api-status.md
View File

@ -44,6 +44,8 @@ MigrationExecute | v0.20.0 | v0.22.0 |
MigrationCommit | v0.20.0 | v0.22.0 |
MigrationAbort | v0.20.0 | v0.22.0 |
MigrationStatus | v0.20.0 | v0.22.0 |
SiteMirrorImageStatus.UnmarshalDescriptionJSON | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
SiteMirrorImageStatus.DescriptionReplayStatus | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
### Deprecated APIs