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

50 lines
1.2 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
## Package: cephfs/admin
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
### Deprecated APIs
Name | Deprecated in Version | Expected Removal Version |
---- | --------------------- | ------------------------ |
FSAdmin.EnableModule | v0.14.0 | v0.16.0 |
FSAdmin.DisableModule | v0.14.0 | v0.16.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: 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
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
WriteOp.CmpExt | v0.12.0 | v0.14.0 |
rados: implement binding for rados_read_op_read This commit implements binding for rados_read_op_read RADOS Read operation. Includes a unit test. Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2021-12-03 09:14:58 +00:00
ReadOp.Read | v0.14.0 | v0.16.0 |
rados: implement binding for rados_write_op_remove This commit implements binding for rados_write_op_remove RADOS Write operation. Includes a unit test. Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-01-27 13:32:35 +00:00
WriteOp.Remove | v0.14.0 | v0.16.0 |
rados: implement binding for rados_{read,write}_op_assert_version This commit implements binding for rados_read_op_assert_version RADOS Read operation as well as rados_write_op_assert_version RADOS Write operation. Includes unit tests for both. Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-01-27 15:19:20 +00:00
ReadOp.AssertVersion | v0.14.0 | v0.16.0 |
WriteOp.AssertVersion | v0.14.0 | v0.16.0 |
rados: implement binding for rados_write_op_setxattr This commit implements binding for rados_write_op_setxattr RADOS Write operation. Includes a unit test. Signed-off-by: Robert Vasek <robert.vasek@cern.ch>
2022-01-26 21:48:41 +00:00
WriteOp.SetXattr | v0.14.0 | v0.16.0 |
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
### 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
## Package: rgw/admin
### Preview APIs
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
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
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