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

78 lines
1.9 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
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: cephfs/admin
cephfs/admin: add CloneStatus.GetFailure() In case cloning failed, Ceph Mgr returns an additional attribute in the response. The "failed" attribute contains an errno (as string?!) and a description. It is useful for applications using go-ceph to report the error back to the user. As the CloneStatus is on the same level as the CloneFailure object in the response, keeping strictly to the CephFS Mgr API would break compatibility. Instead, a new CloneStatus.GetFailure() method has been introduced, returning a CloneFailure type (or nil) object with details about the failure. Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-05-30 07:51:22 +00:00
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
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 |
---- | --------------------- | ------------------------ |
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 |
---- | ---------------- | ----------------------- |
rados: Implement rados_set_alloc_hint2 Signed-off-by: Quentin Devos <4972091+Okhoshi@users.noreply.github.com>
2022-06-17 16:57:36 +00:00
IOContext.SetAllocationHint | v0.17.0 | v0.19.0 |
WriteOp.SetAllocationHint | v0.17.0 | v0.19.0 |
doc: update API status docs Update API status docs to reflect the new preview API calls: Alignment and RequiresAlignment Signed-off-by: Daniel M. Lambea <dmlambea@tenerife.es>
2022-07-20 11:32:06 +00:00
IOContext.Alignment | v0.17.0 | v0.19.0 |
IOContext.RequiresAlignment | v0.17.0 | v0.19.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
cephfs/admin: add CloneStatus.GetFailure() In case cloning failed, Ceph Mgr returns an additional attribute in the response. The "failed" attribute contains an errno (as string?!) and a description. It is useful for applications using go-ceph to report the error back to the user. As the CloneStatus is on the same level as the CloneFailure object in the response, keeping strictly to the CephFS Mgr API would break compatibility. Instead, a new CloneStatus.GetFailure() method has been introduced, returning a CloneFailure type (or nil) object with details about the failure. Signed-off-by: Niels de Vos <ndevos@redhat.com>
2022-05-30 07:51:22 +00:00
### Preview APIs
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
### 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
### 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: Update API status
2022-07-27 11:01:47 +00:00
API.ListUsersBuckets | v0.17.0 | v0.19.0 |
API.ListUsersBucketsWithStat | v0.17.0 | v0.19.0 |
API.CreateKey | v0.17.0 | v0.19.0 |
API.RemoveKey | v0.17.0 | v0.19.0 |
API.SetIndividualBucketQuota | v0.17.0 | v0.19.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
### Preview APIs
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
go-ceph: change mature preview APIs to stable Signed-off-by: Sven Anderson <sven@redhat.com>
2022-08-16 11:19:18 +00:00