swagger: '2.0'
info:
  description: Configuration for Configuration Commands for use in configuration template resource.
  version: 'v2'
  title: config_command
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: config_command
    description: Configuration Commands for use in configuration template
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 config command
   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_command:
    get:
      tags:
        - config_command
      summary: GET all config_command
      operationId: getall_config_command
      description: Use this operation to get config commands
      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_command 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_command 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_command resources.
          enum:
            - yes
      responses:
        200:
          description:  for config_command
          schema: 
              $ref: '#/definitions/getconfig_commandsResponse'
        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'

    post:
      tags:
        - config_command
      summary: POST operation for config_command
      operationId: post_config_command
      description: POST operation for config_command
      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: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: body
          name: config_command
          description: config_command object
          schema:
              $ref: '#/definitions/addconfig_commandRequest'
      responses:
        200:
          description: add for config_command
          schema: 
              $ref: '#/definitions/addconfig_commandResponse'
        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/config_command/{id}:
    get:
      tags:
        - config_command
      summary: GET by key for config_command
      operationId: getbykey_config_command
      description: Use this operation to get config commands
      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: add for config_command
          schema: 
              $ref: '#/definitions/getconfig_commandResponse'
        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:
  addconfig_commandRequest:
    type: object
    required:
      - config_command
    properties:
      config_command:
        $ref: '#/definitions/config_command_readwrite'
    title: addconfig_commandRequest
    example:
      config_command:
        protocol: "SSH"
        rollback_command: "rm vlan 1"
        parent_name: "template1"
        nitro_payload: "string_value"
        nitro_method: "POST"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        index: "0"
        timeout: "300"
        nitro_resource: "managed_device"
        command: "add vlan 1"

  addconfig_commandResponse:
    type: object
    required:
      - config_command
    properties:
      config_command:
        $ref: '#/definitions/config_command'
    title: addconfig_commandResponse
    example:
      config_command:
        protocol: "SSH"
        rollback_command: "rm vlan 1"
        parent_name: "template1"
        nitro_payload: "string_value"
        nitro_method: "POST"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        index: "0"
        timeout: "300"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        nitro_resource: "managed_device"
        command: "add vlan 1"

  getconfig_commandResponse:
    type: object
    required:
      - config_command
    properties:
      config_command:
        $ref: '#/definitions/config_command'
    title: getconfig_commandResponse
    example:
      config_command:
        protocol: "SSH"
        rollback_command: "rm vlan 1"
        parent_name: "template1"
        nitro_payload: "string_value"
        nitro_method: "POST"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        index: "0"
        timeout: "300"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        nitro_resource: "managed_device"
        command: "add vlan 1"

  getconfig_commandsResponse:
    type: object
    required:
      - config_command
    properties:
      config_command:
        type: array
        items:
          $ref: '#/definitions/config_command'
    title: getconfig_commandsResponse
    example:
      config_command:
        protocol: "SSH"
        rollback_command: "rm vlan 1"
        parent_name: "template1"
        nitro_payload: "string_value"
        nitro_method: "POST"
        parent_id: "6a56c246-b4f4-4b16-8158-f8ac028f2b88"
        index: "0"
        timeout: "300"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        nitro_resource: "managed_device"
        command: "add vlan 1"

  config_command_readwrite:
    type: object
    properties:
      protocol:
        description: "Protocol used by Configuration Command: SSH|SCP|SFTP"
        type: string
        format: string
        minLength: 1
        maxLength: 32
      rollback_command:
        description: " Rollback Command String"
        type: string
        format: string
      parent_name:
        description: "Parent name of config command"
        type: string
        format: string
      nitro_payload:
        description: "NITRO Request Payload"
        type: string
        format: string
      nitro_method:
        description: "NITRO Request Method: POST|PUT|DELETE"
        type: string
        format: string
        minLength: 1
        maxLength: 32
      parent_id:
        description: "Parent Id of config command"
        type: string
        format: uuid
      index:
        description: "Index that stores the position of the command in a command array"
        type: integer
        format: int32
      timeout:
        description: "Command Timeout in secs"
        type: integer
        format: int32
      nitro_resource:
        description: "NITRO Resource Name"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      command:
        description: "Command String for Protocols SSH|SCP|SFTP"
        type: string
        format: string

  config_command:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all config command
            type: string
            format: uuid
      - $ref: '#/definitions/config_command_readwrite'

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