Update API section of Guide
In our old doc (https://github.com/freenas/freenas-docs/blob/angulargui/userguide/api.rst) we give simple and complex example scripts that need to be updated. If you could also provide a brief description of how the FreeNAS API has changed since the old REST 1.0 docs that would be great.
#3 Updated by Waqar Ahmed about 1 year ago
- Status changed from In Progress to Blocked
- Reason for Blocked set to Need additional information from Author
Hello Samantha. Could you please let me know if you would like me to update the api.rst file with the updated info about api 2 and the examples using api 2 ? Thank you
#6 Updated by Waqar Ahmed about 1 year ago
Samantha, could you please have a look - https://github.com/freenas/freenas-docs/pull/167 ?
The examples haven't been updated as I discussed this with William, we concluded that the API v2 is not feature complete yet. So it wouldn't make sense to advocate it's usage for production purposes as not all the features are present. Instead for now, I have added a note related to API 2 and also mentioned that it's not feature complete yet. Please have a look and kindly let me know if you would like me to make amends. Thank you
#10 Updated by Samantha Bonham about 1 year ago
I reviewed the master PR [https://github.com/freenas/freenas-docs/pull/167/files#submit-review] and requested changes.
#17 Updated by Samantha Bonham about 1 year ago
Hi Waqar. I missed one issue: WebSockets <https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API>__ doesn't have any backticks.
It should be: `WebSockets <https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API>`__. Can you please fix?
- Subject changed from We need to update the old FreeNAS api docs to reflect our current API (REST 2.0 and websockets) to Update API section of Guide
- Status changed from In Progress to Ready for Testing
- Needs Doc changed from Yes to No
- Needs Merging changed from Yes to No
Please check two things to confirm in the new GUI Guide then Test Passed
in Pull 210 (New GUI)
on 124 the line stops "must be valid for a FreeBSD user" in the guide "must be valid for a FreeBSD user account"
and on line 224 it doesn't look like def has a space before it - but I could be wrong