This is an experimental extension of the http-prompt tool intended to be a playground to add Redfish-specific capabilities (see the Redfish pages at DMTF.org for more information on Redfish).
redfish-prompt is a swift and robust tool capable of prompted navigation for communicating with custom API endpoints.
- An interactive command line tool with auto-complete feature to navigate schema and interrogate an endpoint.
- An automated traverser tool for navigating collections in a multi-level schema for a hypermedia API like Redfish.
- A promising tool for system mangers and network engineers to reach endpoints and handle critical parameters.
Basic usage:
Save and load a copy of the spec locally:
Clone this repository in your local machine
$ git clone https://github.com/nsfcac/redfish-prompt.git
We recommend having setup a local python (e.g., conda ) environment to avoid package dependency or permission errors if you are installing it on a system-wide Python. Note that you need sudo access if you are trying to install it system-wide.
Switch to the cloned directory and run the following commands
$ cd redfish-prompt/
$ python setup.py install
This will finish processing dependencies for redfish-prompt 1.0.0.
$ redfish-prompt
This fetches the Redfish OpenAPI schema, from the web as a default.
To change URL address, use cd:
#Relative URL path
$ cd redfish/v1
One can now see auto completion option enabled with redfish-prompt.
The tool differs from http-prompt in that it will load the Redfish OpenAPI description files from the DMTF web site automatically upon start. This can still be replaced by any other OpenAPI description, for example a newer or customized specification file, using the --spec option. You can save the loaded specification as a Python pickled object locally by specifying the --savespec option. This will write it into local storage in a location printed on the console. (This location varies depending on the operating system, following the convention used by http-prompt and httpie, but is always echoed to the output when this occurs.) Future lauches of redfish-prompt will use this savedspec file and bypass reading the OpenAPI description from the web, as a convenience for speed and offline usage. To restore the original behavior, remove the savedspec file from the local storage.
The functionality of the tool can be tested by running a Mockup server. redfishMockupCreator is a python34 program that builds a redfish Mockup folder structure from a real live Redfish service. This folder structure can then be mounted under the redfishMockupServer tool. Once the Redfish Mockup server is running on the localhost we can launch redfish-prompt.
$ redfish-prompt localhost:8000/redfish/v1
$ redfish-prompt localhost:8000/redfish/v1 --spec = openapi-combined.yaml
$ redfish-prompt localhost:8000/redfish/v1 --spec = openapi-combined.json
To combine multiple Swagger schemas into one dereferenced schema use Swagger Combine installation.
A general form of dereferencing with swagger-combine is
$ swagger-combine –o <output_filename> -f <format of output_file> <input_filename>
For instance, dereferencing Redfish's openapi.yaml file into combined YAML and JSON formats
$ swagger-combine –o openapi-combined.yaml –f yaml openapi.yaml
$ swagger-combine –o openapi-combined.json –f yaml openapi.yaml