rgw/admin: Generate API documentation for the new methods

ceph · Mar 17, 2022 · cfecd00 · cfecd00
1 parent b0b5622
commit cfecd00
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 36 deletions.
diff --git a/docs/api-status.json b/docs/api-status.json
@@ -1776,6 +1776,24 @@
         "comment": "LinkBucket will link a bucket to a specified user\nunlinking the bucket from any previous user\n PREVIEW\n",
         "added_in_version": "v0.15.0",
         "expected_stable_version": "v0.17.0"
+      },
+      {
+        "name": "API.CreateSubuser",
+        "comment": "CreateSubuser - https://docs.ceph.com/en/latest/radosgw/adminops/#create-subuser\n PREVIEW\n",
+        "added_in_version": "v0.14.0",
+        "expected_stable_version": "v0.17.0"
+      },
+      {
+        "name": "API.RemoveSubuser",
+        "comment": "RemoveSubuser - https://docs.ceph.com/en/latest/radosgw/adminops/#remove-subuser\n PREVIEW\n",
+        "added_in_version": "v0.14.0",
+        "expected_stable_version": "v0.17.0"
+      },
+      {
+        "name": "API.ModifySubuser",
+        "comment": "ModifySubuser - https://docs.ceph.com/en/latest/radosgw/adminops/#modify-subuser\n PREVIEW\n",
+        "added_in_version": "v0.14.0",
+        "expected_stable_version": "v0.17.0"
       }
     ],
     "stable_api": [
@@ -1883,4 +1901,4 @@
       }
     ]
   }
-}
+}
diff --git a/docs/api-status.md b/docs/api-status.md
@@ -8,57 +8,59 @@
 
 ### 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 | 
+Name | Deprecated in Version | Expected Removal Version |
+---- | --------------------- | ------------------------ |
+FSAdmin.EnableModule | v0.14.0 | v0.16.0 |
+FSAdmin.DisableModule | v0.14.0 | v0.16.0 |
 
 ## Package: rados
 
 ### Preview APIs
 
-Name | Added in Version | Expected Stable Version | 
----- | ---------------- | ----------------------- | 
-ReadOp.Read | v0.14.0 | v0.16.0 | 
-WriteOp.Remove | v0.14.0 | v0.16.0 | 
-ReadOp.AssertVersion | v0.14.0 | v0.16.0 | 
-WriteOp.AssertVersion | v0.14.0 | v0.16.0 | 
-WriteOp.SetXattr | v0.14.0 | v0.16.0 | 
-ReadOpOmapGetValsByKeysStep.Next | v0.14.0 | v0.16.0 | 
-ReadOp.GetOmapValuesByKeys | v0.14.0 | v0.16.0 | 
-IOContext.Watch | v0.14.0 | v0.16.0 | 
-IOContext.WatchWithTimeout | v0.14.0 | v0.16.0 | 
-Watcher.ID | v0.14.0 | v0.16.0 | 
-Watcher.Events | v0.14.0 | v0.16.0 | 
-Watcher.Errors | v0.14.0 | v0.16.0 | 
-Watcher.Check | v0.14.0 | v0.16.0 | 
-Watcher.Delete | v0.14.0 | v0.16.0 | 
-IOContext.Notify | v0.14.0 | v0.16.0 | 
-IOContext.NotifyWithTimeout | v0.14.0 | v0.16.0 | 
-NotifyEvent.Ack | v0.14.0 | v0.16.0 | 
-Conn.WatcherFlush | v0.14.0 | v0.16.0 | 
-IOContext.SetLocator | v0.15.0 | v0.17.0 | 
+Name | Added in Version | Expected Stable Version |
+---- | ---------------- | ----------------------- |
+ReadOp.Read | v0.14.0 | v0.16.0 |
+WriteOp.Remove | v0.14.0 | v0.16.0 |
+ReadOp.AssertVersion | v0.14.0 | v0.16.0 |
+WriteOp.AssertVersion | v0.14.0 | v0.16.0 |
+WriteOp.SetXattr | v0.14.0 | v0.16.0 |
+ReadOpOmapGetValsByKeysStep.Next | v0.14.0 | v0.16.0 |
+ReadOp.GetOmapValuesByKeys | v0.14.0 | v0.16.0 |
+IOContext.Watch | v0.14.0 | v0.16.0 |
+IOContext.WatchWithTimeout | v0.14.0 | v0.16.0 |
+Watcher.ID | v0.14.0 | v0.16.0 |
+Watcher.Events | v0.14.0 | v0.16.0 |
+Watcher.Errors | v0.14.0 | v0.16.0 |
+Watcher.Check | v0.14.0 | v0.16.0 |
+Watcher.Delete | v0.14.0 | v0.16.0 |
+IOContext.Notify | v0.14.0 | v0.16.0 |
+IOContext.NotifyWithTimeout | v0.14.0 | v0.16.0 |
+NotifyEvent.Ack | v0.14.0 | v0.16.0 |
+Conn.WatcherFlush | v0.14.0 | v0.16.0 |
+IOContext.SetLocator | v0.15.0 | v0.17.0 |
 
 ## 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 |  | 
+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.UnlinkBucket | v0.15.0 | v0.17.0 | 
-API.LinkBucket | v0.15.0 | v0.17.0 | 
+Name | Added in Version | Expected Stable Version |
+---- | ---------------- | ----------------------- |
+API.UnlinkBucket | v0.15.0 | v0.17.0 |
+API.LinkBucket | v0.15.0 | v0.17.0 |
+API.CreateSubuser | v0.15.0 | v0.17.0 |
+API.RemoveSubuser | v0.15.0 | v0.17.0 |
+API.ModifySubuser | v0.15.0 | v0.17.0 |
 
 ## Package: common/admin/manager
-