Skip to content

Commit

Permalink
docs: Remove references to invalid error APIs
Browse files Browse the repository at this point in the history
Following APIs have been replaced with more generic cephError type to
jointly indicate the source and error.

cephFSError.Error
cephFSError.ErrorCode
radosError.Error
radosError.ErrorCode
rbdError.Error
rbdError.ErrorCode

Therefore remove corresponding entries from API docs.

Signed-off-by: Anoop C S <[email protected]>
  • Loading branch information
anoopcs9 committed Oct 14, 2024
1 parent 6d772a6 commit ec982c2
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions docs/api-status.json
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,6 @@
"name": "Directory.RewindDir",
"comment": "RewindDir sets the directory stream to the beginning of the directory.\n\nImplements:\n void ceph_rewinddir(struct ceph_mount_info *cmount, struct ceph_dir_result *dirp);\n"
},
{
"name": "cephFSError.Error",
"comment": "Error returns the error string for the cephFSError type.\n"
},
{
"name": "cephFSError.ErrorCode"
},
{
"name": "MountInfo.Open",
"comment": "Open a file at the given path. The flags are the same os flags as\na local open call. Mode is the same mode bits as a local open call.\n\nImplements:\n int ceph_open(struct ceph_mount_info *cmount, const char *path, int flags, mode_t mode);\n"
Expand Down Expand Up @@ -748,13 +741,6 @@
"name": "Conn.GetPoolByID",
"comment": "GetPoolByID returns the name of a pool by a given ID.\n"
},
{
"name": "radosError.Error",
"comment": "Error returns the error string for the radosError type.\n"
},
{
"name": "radosError.ErrorCode"
},
{
"name": "IOContext.Pointer",
"comment": "Pointer returns a pointer reference to an internal structure.\nThis function should NOT be used outside of go-ceph itself.\n"
Expand Down Expand Up @@ -1210,12 +1196,6 @@
"name": "Image.EncryptionLoad",
"comment": "EncryptionLoad enables IO on an open encrypted image\n\nImplements:\n int rbd_encryption_load(rbd_image_t image,\n rbd_encryption_format_t format,\n rbd_encryption_options_t opts,\n size_t opts_size);\n"
},
{
"name": "rbdError.Error"
},
{
"name": "rbdError.ErrorCode"
},
{
"name": "FeatureSetFromNames",
"comment": "FeatureSetFromNames returns a FeatureSet built from flag bits corresponding\nto the provided feature names.\n"
Expand Down Expand Up @@ -2376,4 +2356,4 @@
}
]
}
}
}

0 comments on commit ec982c2

Please sign in to comment.