search

SNIA / Swordfish-basic-web-client

The Swordfish Basic Web Client can connect to one or more Swordfish services (including the Swordfish emulator), and present in a web UI frame the entire Swordfish hierarchy. The basic web client also provides basic capabilities to modify configurable Properties (as specified in the schema), as well an providing a basic interface to add or remove elements from the service through a Web UI.
BSD 3-Clause "New" or "Revised" License
7 stars 6 forks source link

SNIA Swordfish basic webclient docs #28

Closed sravanthikalluri19 closed 6 years ago

sravanthikalluri19 commented 6 years ago

SNIA basic web client documentation's for

  1. General audience 2.Developer 3.Installation steps(Environment Set up)
rahlvers commented 6 years ago

Waiting for additional comments in developer doc to be addressed RE: how to modify GUI code when new, updated Redfish / Swordfish schemaare available. Also, where in the GUI code, specifically, are the schema referenced?

rahlvers commented 6 years ago

Latest updates to documentation still don't show any reference to schema, only to extracting information from the service. I've embedded both changes and comments. @sravanthikalluri19 - please review and update.

ddeel commented 6 years ago

Has there been any progress towards addressing the comments on this pull request?

sravanthikalluri19 commented 6 years ago

@rahlvers @ddeel

please clarify the below points 1. This section doesn’t describe how the system references the schema. It only describes how it interacts with running services.

Hoping the running services are designed and implemented based on the schema's

2. How does the web client decide which properties are editable?

Based on the schema definition if the properties are editable, the services are appending a permissions property containing Boolean values for read and write.

Apart from these do we need to add/change any functionality/points in the document?

rahlvers commented 6 years ago

The documentation needs to be cleaned up to remove all references to schema - the web client doesn't look at schema at all. It only interacts with the service.

rahlvers commented 6 years ago

Approved in SSM TWG 9/11/18