RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
go-ceph/docs/api-status.md

99 lines
3.1 KiB
Markdown
Raw Normal View History

docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
<!-- GENERATED FILE: DO NOT EDIT DIRECTLY -->
# go-ceph API Stability
## Package: cephfs
docs: add SelectFilesystem to api status Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-02-11 14:43:22 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
MountInfo.SelectFilesystem | v0.20.0 | v0.22.0 |
docs: fix version numbers of recently added APIs Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-03-20 17:58:12 +00:00
MountInfo.MakeDirs | v0.21.0 | v0.23.0 |
contrib/apiage: Do not leave empty sections for packages in markdown For those packages without any preview/deprecated APIs we used to include a header despite any content under it. We could instead mention the state in a meaningful sentence. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-08-06 09:09:18 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: cephfs/admin
docs: Update status for subvolume and snapshot metadata APIs Following APIs are being added as preview APIs: FSAdmin.GetMetadata FSAdmin.SetMetadata FSAdmin.RemoveMetadata FSAdmin.ForceRemoveMetadata FSAdmin.ListMetadata FSAdmin.GetSnapshotMetadata FSAdmin.SetSnapshotMetadata FSAdmin.RemoveSnapshotMetadata FSAdmin.ForceRemoveSnapshotMetadata FSAdmin.ListSnapshotMetadata Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2023-01-20 07:22:03 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
FSAdmin.GetMetadata | v0.20.0 | v0.22.0 |
FSAdmin.SetMetadata | v0.20.0 | v0.22.0 |
FSAdmin.RemoveMetadata | v0.20.0 | v0.22.0 |
FSAdmin.ForceRemoveMetadata | v0.20.0 | v0.22.0 |
FSAdmin.ListMetadata | v0.20.0 | v0.22.0 |
FSAdmin.GetSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.SetSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.RemoveSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.ForceRemoveSnapshotMetadata | v0.20.0 | v0.22.0 |
FSAdmin.ListSnapshotMetadata | v0.20.0 | v0.22.0 |
docs: fix version numbers of recently added APIs Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-03-20 17:58:12 +00:00
FSAdmin.PinSubVolume | v0.21.0 | v0.23.0 |
FSAdmin.PinSubVolumeGroup | v0.21.0 | v0.23.0 |
FSAdmin.FetchVolumeInfo | v0.21.0 | v0.23.0 |
cephfs admin: mark general mgr module funcs as deprecated The versions in cluster/admin/manager should be used instead. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-01-30 16:29:08 +00:00
cephfs admin: deprecate the New function The New function created a rados connection object but did not expose it via a public api, making it impossible to deterministically sever / clean up the connection. This commit assumes that the patch will be merged prior to the go-ceph v0.21 release so that we can plan to remove the function three versions later (v0.24). I chose three versions so that it is one release longer than our typical stabilization period as this function has been around for a while. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-03-20 18:01:44 +00:00
### Deprecated APIs
Name | Deprecated in Version | Expected Removal Version |
---- | --------------------- | ------------------------ |
New | v0.21.0 | v0.24.0 |
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: rados
rados: Make IOContext.RequiresAlignment stable Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-12-05 11:59:59 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
rados: implement binding for rados_write_op_cmpext This commit implements binding for rados_write_op_cmpext RADOS Write operation. Includes a unit test. Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2021-09-27 12:08:50 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: rbd
rbd: implement live migration functions Signed-off-by: Omid Yoosefi <omidyoosefi@ibm.com>
2022-12-14 20:37:36 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
docs: fix api versions for new rbd migration apis As of d6bf51115d8f1075f1dc12887a41274b5dd196f0 we've tried to make API stability less burdensome on contributors by putting in placeholder values in the status files. However, we haven't used it much yet. This change executes `make api-fix-versions` in order to convert the placeholder versions into real version numbers - both for the real reason of tracking the values and also for a more real world test of the apiage feature. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-01-11 14:50:58 +00:00
MigrationPrepare | v0.20.0 | v0.22.0 |
MigrationPrepareImport | v0.20.0 | v0.22.0 |
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 |
docs: fix version numbers of recently added APIs Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-03-20 17:58:12 +00:00
SiteMirrorImageStatus.UnmarshalDescriptionJSON | v0.21.0 | v0.23.0 |
SiteMirrorImageStatus.DescriptionReplayStatus | v0.21.0 | v0.23.0 |
rbd: Add mirror peer site API components **Description:** Added some API components of mirror peer site Fixes: #486 Signed-off-by: Nikhil-Ladha <nikhilladha1999@gmail.com>
2023-03-23 05:36:43 +00:00
AddMirrorPeerSite | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
RemoveMirrorPeerSite | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
GetAttributesMirrorPeerSite | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
SetAttributesMirrorPeerSite | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
ListMirrorPeerSite | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
SetMirrorPeerSiteClientName | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
SetMirrorPeerSiteName | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
SetMirrorPeerSiteDirection | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
rbd: implement live migration functions Signed-off-by: Omid Yoosefi <omidyoosefi@ibm.com>
2022-12-14 20:37:36 +00:00
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
### Deprecated APIs
Name | Deprecated in Version | Expected Removal Version |
---- | --------------------- | ------------------------ |
MirrorImageGlobalStatusIter.Close | v0.11.0 | |
Image.Open | v0.2.0 | |
Snapshot.Set | v0.10.0 | |
## Package: rbd/admin
contrib/apiage: Do not leave empty sections for packages in markdown For those packages without any preview/deprecated APIs we used to include a header despite any content under it. We could instead mention the state in a meaningful sentence. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-08-06 09:09:18 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
## Package: rgw/admin
rgw: add ListBucketsWithStat api Add api stability. Signed-off-by: moti <motaharesdq@gmail.com>
2023-01-20 05:51:00 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
docs: fix api versions for new ListBucketWithStat API This change executes `make api-fix-versions` in order to convert the placeholder versions into real version numbers. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2023-02-14 06:14:39 +00:00
API.ListBucketsWithStat | v0.20.0 | v0.22.0 |
docs: add initial copies of the api-status.json & markdown doc The file api-status.json is designed to track changes to the go-ceph APIs, especially the 'deprecated' and 'preview' apis. It also stores lists of stable apis so that we can see if something new but not explicitly stable appears. The api-status.md file is actually meant to be read by users of go-ceph so to help make decisions about the use of new preview apis or deprecated apis. It is generated from api-status.json. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-27 18:30:27 +00:00
docs: add common/admin/manager to API docs These APIs already existed, and were considered stable in cephfs/admin before getting moved. I initially was going to mark them preview but then realized that cephfs/admin depends on them and having them marked preview with the ceph_preview tag would break cephfs/admin. Due to the above, I think an exception to the policy is warranted here as there is not much new except the package itself. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-01-25 21:07:45 +00:00
## Package: common/admin/manager
contrib/apiage: Do not leave empty sections for packages in markdown For those packages without any preview/deprecated APIs we used to include a header despite any content under it. We could instead mention the state in a meaningful sentence. Signed-off-by: Anoop C S <anoopcs@cryptolab.net>
2022-08-06 09:09:18 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
common/log: add missing api-status entries Signed-off-by: Sven Anderson <sven@redhat.com>
2022-04-11 21:10:38 +00:00
## Package: common/log
go-ceph: change mature preview APIs to stable Signed-off-by: Sven Anderson <sven@redhat.com>
2022-08-16 11:19:18 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.
common/log: add missing api-status entries Signed-off-by: Sven Anderson <sven@redhat.com>
2022-04-11 21:10:38 +00:00
docs: add API statuses for nfs admin api Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-05-17 14:49:12 +00:00
## Package: common/admin/nfs
docs: fix common/admin/nfs section of api-status.md It now reports "No Preview/Deprecated APIs found. All APIs are considered stable." rather than leaving a blank section. Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-01-11 14:49:47 +00:00
No Preview/Deprecated APIs found. All APIs are considered stable.