Project

General

Profile

Bug #34921

Update API section of Guide

Added by Samantha Bonham about 1 year ago. Updated 12 months ago.

Status:
Done
Priority:
No priority
Assignee:
Waqar Ahmed
Category:
Documentation
Target version:
Severity:
Low Medium
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

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.

Associated revisions

Revision 41f1f9b5 (diff)
Added by Waqar Ahmed about 1 year ago

Note for API v2 added
Ticket: #34921

Revision 0048067b (diff)
Added by Dru Lavigne 12 months ago

Fix formatting errors.
Ticket: #34921

Revision 5824f199 (diff)
Added by Dru Lavigne 12 months ago

Matchup formatting with legacy UI version.
Ticket: #34921

History

#1 Updated by William Grzybowski about 1 year ago

  • Assignee changed from William Grzybowski to Waqar Ahmed
  • Target version changed from Backlog to 11.2-RC2

Wawar would you mind tackling this. A brief write up explaining websocket, restful and updating the examples to use REST v2.0.

#2 Updated by Waqar Ahmed about 1 year ago

  • Status changed from Unscreened to In Progress
  • Severity changed from New to Low Medium

#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

#4 Updated by Samantha Bonham about 1 year ago

Hi Waqar,

Yes that sounds great. Please send it as a PR.

#5 Updated by Waqar Ahmed about 1 year ago

  • Status changed from Blocked to In Progress
  • Reason for Blocked deleted (Need additional information from Author)

#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

#8 Updated by William Grzybowski about 1 year ago

Hello, can the PR be looked at, please?

#9 Updated by William Grzybowski about 1 year ago

  • Target version changed from 11.2-RC2 to 11.2-BETA2

#10 Updated by Samantha Bonham about 1 year ago

Hi William,

I reviewed the master PR [https://github.com/freenas/freenas-docs/pull/167/files#submit-review] and requested changes.

#11 Updated by Waqar Ahmed about 1 year ago

Hello, I think you forgot to submit the review ? If I open the PR, I can't see any changes requested. Could you kindly look into it ? Thank you

#12 Updated by Samantha Bonham about 1 year ago

Hi,

Sorry, you should be able to see the review now.

#13 Updated by Waqar Ahmed about 1 year ago

Hello : ) Could you kindly review the PR again ? I have updated it. Many thanks

#14 Updated by Waqar Ahmed about 1 year ago

  • Status changed from In Progress to Ready for Testing

#15 Updated by Dru Lavigne about 1 year ago

  • Status changed from Ready for Testing to In Progress

#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&gt;__ doesn't have any backticks.

It should be: `WebSockets <https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API&gt;`__. Can you please fix?

#18 Updated by Samantha Bonham about 1 year ago

The link is showing up incorrectly in redmine, it should be:  `WebSockets <https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API>`__.

#19 Updated by Samantha Bonham about 1 year ago

"feature complete" should also be "feature-complete" here: "A new API was released with brand 11.1. The previous API is still present and in use because it is feature complete."

#20 Updated by Waqar Ahmed 12 months ago

Hello. I've updated the PR, kindly have a look and let me know if anything else is required. Thank you

#21 Updated by Dru Lavigne 12 months ago

  • 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

#22 Updated by Bonnie Follweiler 12 months ago

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

#23 Updated by Bonnie Follweiler 12 months ago

  • Status changed from Ready for Testing to Passed Testing
  • Needs QA changed from Yes to No

#24 Updated by Dru Lavigne 12 months ago

  • Status changed from Passed Testing to Ready for Testing

#25 Updated by Samantha Bonham 12 months ago

I see the fix for the build issue. Line 35 is indented too far. "At" should line up with "Documentation" and "For".

#26 Updated by Dru Lavigne 12 months ago

  • Status changed from Ready for Testing to Done

Also available in: Atom PDF