[Kimchi-devel] [PATCH V5 2/6] Storagepool SCSI/FC: API.md entries related to host pci devices
This patch modifies the API.md to list get functions provided by
backend.
Signed-off-by: Rodrigo Trujillo <rodrigo.trujillo(a)linux.vnet.ibm.com>
---
docs/API.md | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/docs/API.md b/docs/API.md
index 04d2d97..40d3fdf 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -766,3 +766,32 @@ Contains the host sample data.
* size: The total size of the partition, in bytes
* mountpoint: If the partition is mounted, represents the mountpoint.
Otherwise blank.
+
+### Collection: Devices
+
+**URI:** /host/devices
+
+**Methods:**
+
+* **GET**: Retrieves list of host pci devices (Node Devices).
+ Currently only scsi_host devices are supported:
+ * name: The name of the device.
+ * adapter_type: The capability type of the scsi_host device (fc_host).
+ * wwnn: The HBA Word Wide Node Name.
+ * wwnn: The HBA Word Wide Port Name
+
+### Resource: Device
+
+**URI:** /host/devices/*:name*
+
+**Methods:**
+
+* **GET**: Retrieve information of a single pci device.
+ Currently only scsi_host devices are supported:
+ * name: The name of the device.
+ * adapter_type: The capability type of the scsi_host device (fc_host).
+ Empty if pci device is not scsi_host.
+ * wwnn: The HBA Word Wide Node Name.
+ Empty if pci device is not scsi_host.
+ * wwnn: The HBA Word Wide Port Name
+ Empty if pci device is not scsi_host.
--
1.8.5.3