]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
mgr/dashboard: Fix inline markup warning in API documentation 64270/head
authorKefu Chai <tchaikov@gmail.com>
Wed, 25 Jun 2025 04:14:36 +0000 (12:14 +0800)
committerZac Dover <zac.dover@proton.me>
Mon, 30 Jun 2025 12:55:09 +0000 (22:55 +1000)
Remove trailing space from summary field that was causing Sphinx build
warning.

Sphinx was generating a warning due to malformed inline markup:

```
/home/kefu/dev/ceph/doc/mgr/ceph_api/index.rst:3349: WARNING: Inline strong start-string without end-string.`
```

The openapi directive appears to convert trailing spaces into asterisk
markers, creating unterminated strong markup. This change removes the
trailing space to eliminate the warning and maintain consistency with
other entries in the file.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
(cherry picked from commit 5f1dc9af57b0398c33226410f801d16feed823f2)

src/pybind/mgr/dashboard/controllers/nfs.py
src/pybind/mgr/dashboard/openapi.yaml

index 36b88d76b165cb8bab583ecfac1b53409dd45ae4..8264a9ac2770839a6363ee8ec9cac609e670e415 100644 (file)
@@ -109,7 +109,7 @@ class NFSGaneshaExports(RESTController):
         export['fsal'] = schema_fsal_info
         return export
 
-    @EndpointDoc("List all NFS-Ganesha exports",
+    @EndpointDoc("List all or cluster specific NFS-Ganesha exports",
                  responses={200: [EXPORT_SCHEMA]})
     def list(self) -> List[Dict[str, Any]]:
         exports = []
index 14ad6c9e306c73faf9a152e096995ab552256549..db90141ecc97ead836489b727e30933de02d24c3 100644 (file)
@@ -7209,7 +7209,7 @@ paths:
             trace.
       security:
       - jwt: []
-      summary: List all NFS-Ganesha exports
+      summary: List all or cluster specific NFS-Ganesha exports
       tags:
       - NFS-Ganesha
     post: