API Documentation needs update

Description

This affects all versions of TrueNAS.

The API Documentation does not list a description of the return parameters and leaves the end user guessing. Some parameters are obvious and some are not.

Example: Run `midclt call disk.query | jq` and you have a lot of data returned. But what does all that data mean exactly? In this incidence what do the following values represent: subsystem, number, multipath_name, multipath_member, transfermode, and bus. The other values look obvious however those should also have a description of the returned values.

This is not a BUG, however Jira would not allow me to enter an enhancement, so Kris recommended I try tghe Bug route to get it documented.

Problem/Justification

None

Impact

None

Activity

Show:

Bug Clerk October 10, 2024 at 1:58 PM

This issue has now been closed. Comments made after this point may not be viewed by the TrueNAS Teams. Please open a new issue if you have found a problem or need to re-engage with the TrueNAS Engineering Teams.

Bug Clerk October 10, 2024 at 1:58 PM

Thank you for submitting this issue! A significant update to the API documentation is queued for inclusion in 25.04, which may address your concerns. If at that time you still find the return parameter documentation inadequate, you can raise a suggestion via the category on the TrueNAS community forum.

Bug Clerk October 9, 2024 at 5:08 PM

Thank you for submitting this TrueNAS Bug Report! So that we can quickly investigate your issue, please attach a Debug file and any other information related to this issue through our secure and private upload service below. Debug files can be generated in the UI by navigating to System -> Advanced -> Save Debug.

https://ixsystems.atlassian.net/servicedesk/customer/portal/15/group/37/create/153