From 5dfb392fe0ebeb234f99e96b5f1639767b06d447 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Wed, 25 Jun 2025 12:14:36 +0800 Subject: [PATCH] mgr/dashboard: Fix inline markup warning in API documentation 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 (cherry picked from commit 5f1dc9af57b0398c33226410f801d16feed823f2) --- src/pybind/mgr/dashboard/controllers/nfs.py | 2 +- src/pybind/mgr/dashboard/openapi.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/pybind/mgr/dashboard/controllers/nfs.py b/src/pybind/mgr/dashboard/controllers/nfs.py index 36b88d76b165c..8264a9ac27708 100644 --- a/src/pybind/mgr/dashboard/controllers/nfs.py +++ b/src/pybind/mgr/dashboard/controllers/nfs.py @@ -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 = [] diff --git a/src/pybind/mgr/dashboard/openapi.yaml b/src/pybind/mgr/dashboard/openapi.yaml index 9a01318057723..ac0dc298368d5 100644 --- a/src/pybind/mgr/dashboard/openapi.yaml +++ b/src/pybind/mgr/dashboard/openapi.yaml @@ -7268,7 +7268,7 @@ paths: trace. security: - jwt: [] - summary: List all NFS-Ganesha exports + summary: List all or cluster specific NFS-Ganesha exports tags: - NFS-Ganesha post: -- 2.39.5