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

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>
This commit is contained in:
John Mulligan 2021-09-27 14:30:27 -04:00 committed by mergify[bot]
parent 7ce34854e1
commit 3f32efcf56
2 changed files with 1708 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1677
docs/api-status.json Normal file
View File

File diff suppressed because it is too large Load Diff

31
docs/api-status.md Normal file
View File

@ -0,0 +1,31 @@
<!-- GENERATED FILE: DO NOT EDIT DIRECTLY -->
# go-ceph API Stability
## Package: cephfs
## Package: cephfs/admin
## Package: rados
## 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
Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
API.AddUserCap | v0.12.0 | v0.13.0 |
API.RemoveUserCap | v0.12.0 | v0.13.0 |