New Redfish Release Adds OpenAPI 3.0 Support, Telemetry

Posted on Thu, 09/27/2018 - 07:14

In the latest update to DMTF’s Redfish®, version 2018.2, the standard adds support for OpenAPI 3.0, as well as telemetry streaming and eventing, and improved event subscription methods. An API designed to deliver simple and secure management for hybrid IT and the Software Defined Data Center (SDDC), new versions of the Redfish schema and specification, as well as additional developer resources, are now available. 

OpenAPI, a community-driven open specification from the OpenAPI Initiative (OAI), describes API services in YAML format and offers a rich ecosystem of tools for developers and end users. In the new Redfish Specification v1.6.0 (part of the new 2018.2 release), DMTF adds support for OpenAPI schema files in YAML and requires the use of standardized URIs, with fixed URIs for all Redfish resources. In addition, the 2018.2 Redfish Schema bundle now includes OpenAPI YAML files, along with JSON Schema and CSDL files.

For more information, the items released as part of the new Redfish 2018.2 update include:

  • 2018.2 Redfish Schema Bundle – a .zip file that contains the current versions of all Redfish schema. In addition to the new OpenAPI YAML files for all schemas, new schemas include TelemetryService, MetricDefinition, MetricReportDefinition, MetricReport, Triggers, as well as JobService, Job, PCIeSlots (plus 5 Resource Collections).
  • Redfish Specification v1.6.0 – along with OpenAPI support, the specification adds new modes for more flexible subscription to specific Registries or Resource Types, rather than loosely defined classes. Other new message and event enhancements include additional support for Grouping, Telemetry, SSE filtering, as well as additional Message Registries and more.
  • Redfish 2018.2 Overview – a presentation that provides detailed descriptions of each revision in the latest version of the Redfish Schema and Specification. 
  • Redfish Resource and Schema Guide – Designed to help educate users of Redfish, this human-readable guide to the Redfish Schema has been updated for version 2018.2. Application developers and DevOps personnel creating client-side software to communicate with a Redfish service, as well as other consumers of the API, will benefit from the explanations in this resource. 
  • Redfish History – September 2018 – updated with each new release, this presentation offers a comprehensive view of each revision to Redfish since 2016.

To learn more about Redfish, click here or - for developers - visit the Redfish Developer Hub today. A one-stop, in-depth technical resource – by developers, for developers – the Redfish Developer Hub provides all the files, tools, community support, tutorials and other advanced education you may need to help you use Redfish.

Technical work on the Redfish standard takes place in DMTF’s Redfish Forum (the group formerly known as the Scalable Platforms Management Forum). To find out how you can join and contribute to this standard, click here.