swagger: '2.0'
info:
  description: Configuration for Config advice result resource.
  version: 'v2'
  title: config_advice_result
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: config_advice_result
    description: Config advice result
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: System generated key
   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/config_advice_result:
    get:
      tags:
        - config_advice_result
      summary: GET all config_advice_result
      operationId: getall_config_advice_result
      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 config_advice_result 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 config_advice_result 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 config_advice_result resources.
          enum:
            - yes
      responses:
        200:
          description:  for config_advice_result
          schema: 
              $ref: '#/definitions/getconfig_advice_resultsResponse'
        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:
  getconfig_advice_resultResponse:
    type: object
    required:
      - config_advice_result
    properties:
      config_advice_result:
        $ref: '#/definitions/config_advice_result'
    title: getconfig_advice_resultResponse
    example:
      config_advice_result:
        parent_name: "test_job"
        modification_status_message: "enable feature AAA Done"
        issue: "DNS Server is not configured."
        parent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        modification_status: "false"
        corrective_command: "add dns nameserver IP"
        id: "38f867d1-3d10-4bfa-8498-604a57e67bc4"
        category: "System Settings"
        severity: "WARN"
        advice: "DNS server is currently not configured. Please make sure this is configured."

  getconfig_advice_resultsResponse:
    type: object
    required:
      - config_advice_result
    properties:
      config_advice_result:
        type: array
        items:
          $ref: '#/definitions/config_advice_result'
    title: getconfig_advice_resultsResponse
    example:
      config_advice_result:
        parent_name: "test_job"
        modification_status_message: "enable feature AAA Done"
        issue: "DNS Server is not configured."
        parent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        modification_status: "false"
        corrective_command: "add dns nameserver IP"
        id: "38f867d1-3d10-4bfa-8498-604a57e67bc4"
        category: "System Settings"
        severity: "WARN"
        advice: "DNS server is currently not configured. Please make sure this is configured."

  config_advice_result_readwrite:
    type: object
    properties:
      modification_status_message:
        description: "Command Deployment message"
        type: string
        format: string
      issue:
        description: "Issue"
        type: string
        format: string
      modification_status:
        description: "Command Deployment Status"
        type: boolean
        format: boolean
      corrective_command:
        description: "Command"
        type: string
        format: string
        maxLength: 256
      category:
        description: "Category"
        type: string
        format: string
      severity:
        description: "Severity"
        type: string
        format: string
      advice:
        description: "Advice"
        type: string
        format: string

  config_advice_result:
    allOf:
      -
        properties:
          id:
            description: System generated key
            type: string
            format: uuid
      - $ref: '#/definitions/config_advice_result_readwrite'

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