swagger: '2.0'
info:
  description: Configuration for Fault failure object details resource.
  version: 'v2'
  title: fault_failure_object
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: fault_failure_object
    description: Fault failure object details
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key for all the fault_failure_object
   required: true
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/fault_failure_object:
    get:
      tags:
        - fault_failure_object
      summary: GET all fault_failure_object
      operationId: getall_fault_failure_object
      description: Use this operation to get fault failure objects
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the fault_failure_object resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the fault_failure_object resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of fault_failure_object resources.
          enum:
            - yes
      responses:
        200:
          description:  for fault_failure_object
          schema: 
              $ref: '#/definitions/getfault_failure_objectsResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

  /massvc/{customerid}/nitro/v2/config/fault_failure_object/{id}:
    get:
      tags:
        - fault_failure_object
      summary: GET by key for fault_failure_object
      operationId: getbykey_fault_failure_object
      description: Use this operation to get fault failure objects
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
      responses:
        200:
          description:  for fault_failure_object
          schema: 
              $ref: '#/definitions/getfault_failure_objectResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getfault_failure_objectResponse:
    type: object
    required:
      - fault_failure_object
    properties:
      fault_failure_object:
        $ref: '#/definitions/fault_failure_object'
    title: getfault_failure_objectResponse
    example:
      fault_failure_object:
        device_family: "nssdx"
        name: "nsroot"
        ip_address: "10.102.40.60"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getfault_failure_objectsResponse:
    type: object
    required:
      - fault_failure_object
    properties:
      fault_failure_object:
        type: array
        items:
          $ref: '#/definitions/fault_failure_object'
    title: getfault_failure_objectsResponse
    example:
      fault_failure_object:
        device_family: "nssdx"
        name: "nsroot"
        ip_address: "10.102.40.60"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"


  fault_failure_object:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the fault_failure_object
            type: string
            format: uuid
          device_family:
             description: "Device Family"
             type: string
             format: string
          name:
             description: "failure object name"
             type: string
             format: string
          ip_address:
             description: "Device IP Address"
             type: string
             format: ipaddress

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
