From 5f1dc9af57b0398c33226410f801d16feed823f2 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 --- 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 e170054b444cb..bc98f2503edb8 100644 --- a/src/pybind/mgr/dashboard/controllers/nfs.py +++ b/src/pybind/mgr/dashboard/controllers/nfs.py @@ -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 = [] diff --git a/src/pybind/mgr/dashboard/openapi.yaml b/src/pybind/mgr/dashboard/openapi.yaml index b193aa45f67fa..708d4feabfa5f 100755 --- a/src/pybind/mgr/dashboard/openapi.yaml +++ b/src/pybind/mgr/dashboard/openapi.yaml @@ -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: -- 2.39.5