Re: [Kimchi-devel] [PATCH v6 (BACKEND) 2/5] 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&gt; --- docs/API.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/API.md b/docs/API.md index 04d2d97..d4a1716 100644 --- a/docs/API.md +++ b/docs/API.md @@ -766,3 +766,31 @@ 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: + * Parameters: + * _cap: Filter node device list with given node device capability. + To list Fibre Channel SCSI Host devices, use "_cap=fc_host". + +### 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. + * wwpn: The HBA Word Wide Port Name + Empty if pci device is not scsi_host.