]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
mgr/dashboard: Fix inline markup warning in API documentation
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:51:19 +0000 (22:51 +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 e170054b444cbcad59fec33ca967c03802dd01fd..bc98f2503edb8179ab2c7a2aff2c709cf00e3f8b 100644 (file)
@@ -114,7 +114,7 @@ class NFSGaneshaExports(RESTController):
         export['fsal'] = schema_fsal_info
         return export
 
-    @EndpointDoc("List all or cluster specific NFS-Ganesha exports ",
+    @EndpointDoc("List all or cluster specific NFS-Ganesha exports",
                  responses={200: [EXPORT_SCHEMA]})
     def list(self, cluster_id=None) -> List[Dict[str, Any]]:
         exports = []
index df071682e26fecc35d0416df11cb91a492c5762a..799e7bb9d58030ac90d377bd033a086b2a39ed7c 100755 (executable)
@@ -7681,7 +7681,7 @@ paths:
             trace.
       security:
       - jwt: []
-      summary: 'List all or cluster specific NFS-Ganesha exports '
+      summary: List all or cluster specific NFS-Ganesha exports
       tags:
       - NFS-Ganesha
     post: