]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commit
mgr/dashboard: fix nvmeof api documentation 55804/head
authorNizamudeen A <nia@redhat.com>
Tue, 5 Mar 2024 10:39:25 +0000 (16:09 +0530)
committerNizamudeen A <nia@redhat.com>
Wed, 6 Mar 2024 05:05:00 +0000 (10:35 +0530)
commite87a9f15af52925d8988805b65a9b12c2a88b164
tree7defde24939591920789f02b0f8317923d43752f
parent226117a5ac99486fda8208e6a49db097c6667264
mgr/dashboard: fix nvmeof api documentation

From Aviv:
POST /api/nvmeof/hosts - the description of the command it wrong IMO. It is not about creating a host. It is about allowing a host X to access subsystem Y.
GET /api/nvmeof/hosts/{subsystem_nqn} - also the description is not accurate. The command lists all hosts that are allowed to access this subsystem.
DELETE /api/nvmeof/hosts/{subsystem_nqn}/{host_nqn} - again the description should be changed as above.
POST /api/nvmeof/namespace - bad formatting of the description
GET /api/nvmeof/subsystem - the description is wrong, should say - "List all NVMeoF subsystems". And it shouldn't get any param.
POST /api/nvmeof/subsystem - few issues here. The serial_number, and max_namespaces are optional (we need to mention that). Also it is missing the --enable-ha argument that is also optional.
Some commands are missing: log_level, connection.i

Fixes: https://tracker.ceph.com/issues/64714
Signed-off-by: Nizamudeen A <nia@redhat.com>
src/pybind/mgr/dashboard/controllers/nvmeof.py
src/pybind/mgr/dashboard/openapi.yaml
src/pybind/mgr/dashboard/services/nvmeof_client.py
src/pybind/mgr/dashboard/services/proto/gateway_pb2_grpc.py