Project

General

Profile

Bug #83516

Document Websocket API

Added by William Grzybowski 8 months ago. Updated 7 months ago.

Status:
Done
Priority:
No priority
Assignee:
Waqar Ahmed
Category:
Middleware
Target version:
Severity:
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

We need to make sure all public websocket API is properly documented.

Please ask help of related parties for plugins that are not clear.

Examples of websocket payload are not required unless its not a trivial call.

We will loop in docs team in the PR for better suggestions.


Related issues

Copied to FreeNAS - Bug #85052: Review Websocket API documentationClosed

History

#1 Updated by Bug Clerk 8 months ago

  • Status changed from Unscreened to In Progress

#2 Updated by Bug Clerk 7 months ago

  • Status changed from In Progress to Ready for Testing

#3 Updated by Dru Lavigne 7 months ago

  • Copied to Bug #85052: Review Websocket API documentation added

#4 Updated by Dru Lavigne 7 months ago

  • Status changed from Ready for Testing to Done
  • Target version changed from 11.3-BETA1 to 11.3-ALPHA1
  • Needs QA changed from Yes to No
  • Needs Doc changed from Yes to No
  • Needs Merging changed from Yes to No

Also available in: Atom PDF