on-http-y1/static/redfish.yaml

OnRack Http Server

swagger: "2.0"
info:
  version: "1.2.0"
  title: rackhd redfish v1
# during dev, should point to your local machine
#host: localhost:8080
# basePath prefixes all resource paths
basePath: /redfish/v1
#
schemes:
  # tip: remove http to make production-grade
  - http
  - https
# format of bodies a client can send (Content-Type)
consumes:
  - application/json
# format of the responses to the client (Accepts)
produces:
  - application/json
tags:
  - name: "/redfish/v1"
    description: DMTF/SPMF Redfish v1.0.0
paths:
  /:
    x-swagger-router-controller: service-root
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic', 'anonymous' ]
      summary: retrieve list of root-level resources
      description: >
        This object represents the root Redfish service.  All values for resources described
        by this schema shall comply to the requirements as described in the Redfish specification.
        This object represents the root Redfish service.
      operationId: getServiceRoot
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ServiceRoot.1.0.0_ServiceRoot"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Chassis:
    x-swagger-router-controller: chassis
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of physical components
      description: >
        Defines a collection of physical components managed by the service
      operationId: listChassis
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ChassisCollection_ChassisCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Chassis/{identifier}:
    x-swagger-router-controller: chassis
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve specific information for a physical component
      description: >
        Retrieves a detailed information catalog for the physical component
        specified by identifier
      operationId: getChassis
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: skuChassis
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Chassis.1.0.0_Chassis"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Chassis/{identifier}/Thermal:
    x-swagger-router-controller: chassis
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve thermal characteristics of a chassis
      description: >
        defines a collection of thermal elements contained within a resource.
      operationId: getThermal
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: skuChassis
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Thermal.1.0.0_Thermal"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Chassis/{identifier}/Power:
    x-swagger-router-controller: chassis
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve power characteristics of a chassis
      description: >
        defines a collection of power elements contained within a resource.
      operationId: getPower
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: skuChassis
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Power.1.0.0_Power"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of computer systems
      description: retrieve list of computer systems
      operationId: listSystems
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ComputerSystemCollection_ComputerSystemCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve information for a specific computer systems (physical and/or virtual)
      description: >
        defines a computer system and its respective properties.  A computer system represents a
        machine (physical or virtual) and the local resources such as memory, cpu and other
        devices that can be accessed from that machine.
      operationId: getSystem
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          description: node identifier
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ComputerSystem.1.0.0_ComputerSystem"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Bios:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the current bios settings for a specified identifier
      description: >
        defines a set of bios resources
      operationId: listSystemBios
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Bios.v1_0_1.Bios"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Bios/Settings:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the pending bios settings for a specified identifier
      description: >
        defines a set of bios resources that are pending
      operationId: listSystemBiosSettings
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Bios.v1_0_1.Bios"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    patch:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: patch the pending bios settings for a specified identifier
      description: >
        patch a set of bios resources
      operationId: patchSystemBiosSettings
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/Bios.v1_0_1.Bios"
      responses:
        202:
          description: Success
          $ref: "#/responses/status_202"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Bios.ChangePassword:
    x-swagger-router-controller: systems
    post:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Change the BIOS password for the given system identifier
      description: >
        changes the bios password of a node
      operationId: changeSystemBiosPassword
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/Bios.ChangePassword"
      responses:
        202:
          description: Success
          $ref: "#/responses/status_202"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Processors:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the processor collection for the specified system identifier
      description: >
        defines a collection of processors contained within a resource.
      operationId: listSystemProcessors
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ProcessorCollection_ProcessorCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Processors/{socket}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve a specified processor for the specified system identifier
      description: >
        This represents the properties of a processor attached to a System.
      operationId: getSystemProcessor
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: socket
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Processor.1.0.0_Processor"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/SimpleStorage:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the simple storage collection
      description: >
        Defines a collection of simple storage collections that are
        present on the system described by identifier
      operationId: listSimpleStorage
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/SimpleStorageCollection_SimpleStorageCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/SimpleStorage/{index}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the simple storage collection by device identifier
      description: >
        Defines a collection of storage devices on the device specified by
        identifier that are present on the system described by identifier
      operationId: getSimpleStorage
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/SimpleStorage.1.0.0_SimpleStorage"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Storage:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the storage collection
      description: >
        Defines a collection of simple storage collections that are
        present on the system described by identifier
      operationId: listStorage
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/StorageCollection_StorageCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Storage/{index}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the specific storage instance based on the index
      description: >
        Defines a storage subsystem on the device specified by
        identifier that are present on the system described by identifier
      operationId: getStorage
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Storage.1.1.1_Storage"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Storage/{index}/Drives/{driveIndex}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the specific drive instance based on the driveIndex
      description: >
        Defines a Drive specified by the driveIndex within a Storage subsystem
        specified by the index
      operationId: getDrive
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
        - name: driveIndex
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Drive.1.1.1_Drive"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Add a hot spare the specific drive instance based on the driveIndex
      description: >
        Defines a Drive specified by the driveIndex within a Storage subsystem
        specified by the index
      operationId: addHotspare
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
        - name: driveIndex
          in: path
          required: true
          type: string
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/Drive.addHotspare"
      responses:
        200:
          description: Success
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Storage/{index}/Volumes:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the collection of volumes contained in the storage subsystem
      description: >
        Defines a collection of volumes contained within a resource
      operationId: listVolume
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/VolumeCollection_VolumeCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Add a volume to the collection of volumes contained in the storage subsystem
      description: >
        Defines a collection of volumes contained within a resource
      operationId: addVolume
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/Volume.add"
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/VolumeCollection_VolumeCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"

  /Systems/{identifier}/Storage/{index}/Volumes/{volumeIndex}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the specific volume instance based on the volumeIndex
      description: >
        Defines a Volume specified by the volumeIndex within a Storage subsystem
        specified by the index
      operationId: getVolume
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
        - name: volumeIndex
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/Volume.1.0.2_Volume"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the specific volume instance based on the volumeIndex
      description: >
        Defines a Volume specified by the volumeIndex within a Storage subsystem
        specified by the index
      operationId: deleteVolume
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
        - name: volumeIndex
          in: path
          required: true
          type: string
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/Volume.delete"
      responses:
        200:
          description: Success
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of the logs for a computer system
      description: >
        Defines a collection of log services that are available for the system
        described by identifier
      operationId: listLogService
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogServiceCollection_LogServiceCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices/sel:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of the logs for a computer system
      description: >
        Defines a collection of SEL entries for the system described by
        identifier.
      operationId: getSelLogService
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogService.1.0.0_LogService"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices/sel/Entries:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of the logs entries for associated for log service
      description: >
        Defines a collection of entries for the system described by identifier
      operationId: listSelLogServiceEntries
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogEntryCollection_LogEntryCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices/sel/Entries/{entryId}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve log entry by logId associated for log service
      description: >
        Defines a log entry specified by entryId within the LogService of the
        specified type for the system described by identifier
      operationId: getSelLogServiceEntry
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: entryId
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogEntry.1.0.0_LogEntry"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices/lc:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of the logs for a computer system
      description: >
        Defines a collection of SEL entries for the system described by
        identifier.
      operationId: getLcLogService
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogService.1.0.0_LogService"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices/lc/Entries:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of the logs entries for associated for log service
      description: >
        Defines a collection of entries for the system described by identifier
      operationId: listLcLogServiceEntries
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogEntryCollection_LogEntryCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/LogServices/lc/Entries/{entryId}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve log entry by logId associated for log service
      description: >
        Defines a log entry specified by entryId within the LogService of the
        specified type for the system described by identifier
      operationId: getLcLogServiceEntry
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: entryId
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/LogEntry.1.0.0_LogEntry"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Actions/ComputerSystem.Reset:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the list of reset types for the specified compute node
      description: >
        Retrieve  a list of valid reset types for the system described by identifier
      operationId: listResetTypes
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/RackHD.ResetAction_ResetAction"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      x-privileges: [ 'ConfigureComponents' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: reset a node
      description: >
        Perform the reset specified in the post data arguments on the system
        described by identifier
      operationId: doReset
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/RackHD.ResetAction_ResetAction"
      responses:
        202:
          description: Success
          $ref: "#/responses/status_202"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/Actions/RackHD.BootImage:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the list of boot image types for the specified compute node
      description: >
        Retrieve  a list of valid boot image types for the system described by identifier
      operationId: listBootImage
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/RackHD.BootImage_BootImageList"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      x-privileges: [ 'ConfigureComponents' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: install a boot image on a node
      description: >
        Perform the boot image installation specified in the post data arguments on
        the system described by identifier
      operationId: doBootImage
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/RackHD.BootImage_BootImage"
      responses:
        202:
          description: Success
          schema:
            $ref: "#/definitions/odata.4.0.0_idRef"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/EthernetInterfaces:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the simple storage collection
      description: >
        Defines a collection of ethernet interfaces that are
        present on the system described by identifier
      operationId: listSystemEthernetInterfaces
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/EthernetInterfaceCollection.EthernetInterfaceCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/EthernetInterfaces/{index}:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: Retrieve the ethernet interface by device identifier
      description: >
        Defines an ethernet interface present on the system described by identifier
      operationId: listSystemEthernetInterfacesById
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: index
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/EthernetInterface.v1_2_0.EthernetInterface"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Systems/{identifier}/SecureBoot:
    x-swagger-router-controller: systems
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve the current secure boot status
      description: >
        Gets the current UEFI Secure Boot status
        present on the system described by identifier
      operationId: getSecureBoot
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
      responses:
        200:
          description: Success
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      x-privileges: [ 'ConfigureComponents' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: enable or disable UEFI Secure Boot
      description: >
        Setting this property to true enables UEFI Secure Boot, and setting it to
        false disables it. This property can be enabled only in UEFI boot mode.
      operationId: setSecureBoot
      tags: [ "/redfish/v1" ]
      parameters:
        - name: identifier
          in: path
          required: true
          type: string
          x-param-handler: sku
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/SecureBoot.1.0.1_SecureBoot.post"
      responses:
        202:
          description: Success
          schema:
            $ref: "#/definitions/odata.4.0.0_idRef"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /AccountService:
    x-swagger-router-controller: account-service
    get:
      x-privileges: [ 'ConfigureUsers' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve account service information
      operationId: getAccountService
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/AccountService.1.0.0_AccountService"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /AccountService/Accounts:
    x-swagger-router-controller: account-service
    get:
      x-privileges: [ 'ConfigureUsers' ]
      x-authentication-type: [ 'redfish', 'basic']
      summary: retrieve information about the accounts
      operationId: getAccounts
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ManagerAccountCollection_ManagerAccountCollection"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    post:
      x-privileges: [ 'ConfigureUsers' ]
      x-authentication-type: [ 'redfish', 'basic', 'anonymous' ]
      summary: create a user with the provided information
      operationId: createAccount
      tags: [ "/redfish/v1" ]
      parameters:
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/ManagerAccount.1.0.0_ManagerAccount.post"
      responses:
        201:
          description: Success
          $ref: "#/responses/status_201"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        409:
          $ref: "#/responses/status_409"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /EventService:
    x-swagger-router-controller: event-service
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of policies used by event service listeners
      operationId: eventServiceRoot
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/EventService.1.0.0_EventService"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
  /EventService/Subscriptions:
    x-swagger-router-controller: event-service
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve collection of subscribed events
      operationId: getEventsCollection
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/EventDestinationCollection_EventDestinationCollection"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
    post:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve collection of subscribed events
      operationId: createSubscription
      tags: [ "/redfish/v1" ]
      parameters:
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/EventDestination.1.0.0_EventDestination"
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/EventDestinationCollection_EventDestinationCollection"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        409:
          $ref: "#/responses/status_409"
  /EventService/Subscriptions/{index}:
    x-swagger-router-controller: event-service
    get:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve specific event subscription
      operationId: getEvent
      tags: [ "/redfish/v1" ]
      parameters:
        - name: index
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/EventDestination.1.0.0_EventDestination"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
    delete:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: delete specific event subscription
      operationId: deleteEvent
      tags: [ "/redfish/v1" ]
      parameters:
        - name: index
          in: path
          required: true
          type: string
      responses:
        204:
          description: Success
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
  /EventService/Actions/EventService.SubmitTestEvent:
    x-swagger-router-controller: event-service
    post:
      x-privileges: [ 'Login' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: submit a test event action
      operationId: testEvent
      tags: [ "/redfish/v1" ]
      parameters:
        - name: body
          in: body
          required: false
          schema:
            $ref: "#/definitions/testEvent"
      responses:
        202:
          description: Success
          $ref: "#/responses/status_202"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
  /AccountService/Accounts/{name}:
    x-swagger-router-controller: account-service
    get:
      x-privileges: [ 'ConfigureUsers' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve information about the specified account
      operationId: getAccount
      tags: [ "/redfish/v1" ]
      parameters:
        - name: name
          in: path
          required: true
          type: string
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ManagerAccount.1.0.0_ManagerAccount"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    delete:
      x-privileges: [ 'ConfigureUsers' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: delete the specified account
      operationId: removeAccount
      tags: [ "/redfish/v1" ]
      parameters:
        - name: name
          in: path
          required: true
          type: string
      responses:
        204:
          description: Success
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
    patch:
      x-privileges: [ 'ConfigureUsers', 'ConfigureSelf' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: update the user with the provided information
      operationId: modifyAccount
      tags: [ "/redfish/v1" ]
      parameters:
        - name: name
          in: path
          required: true
          type: string
        - name: payload
          in: body
          required: true
          schema:
            $ref: "#/definitions/ManagerAccount.1.0.0_ManagerAccount"
      responses:
        202:
          description: Success
          $ref: "#/responses/status_202"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /Managers:
    x-swagger-router-controller: managers
    get:
      x-privileges: [ 'ConfigureManager' ]
      x-authentication-type: [ 'redfish', 'basic' ]
      summary: retrieve list of management servers
      operationId: listManagers
      tags: [ "/redfish/v1" ]
      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/ManagerCollection_ManagerCollection"
        400:
          $ref: "#/responses/status_400"
        401:
          $ref: "#/responses/status_401"
        403:
          $ref: "#/responses/status_403"
        404:
          $ref: "#/responses/status_404"
        500:
          description: Error
          schema: