swagger: '2.0'
info:
  description: Configuration for Cluster node information resource.
  version: 'v2'
  title: ns_clusternode
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_clusternode
    description: Cluster node information
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  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/ns_clusternode:
    get:
      tags:
        - ns_clusternode
      summary: GET all ns_clusternode
      operationId: getall_ns_clusternode
      description: Use this operation to get clusternode stats
      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 ns_clusternode 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 ns_clusternode 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 ns_clusternode resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_clusternode
          schema: 
              $ref: '#/definitions/getns_clusternodesResponse'
        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:
  addns_clusternodeRequest:
    type: object
    required:
      - ns_clusternode
    properties:
      ns_clusternode:
        $ref: '#/definitions/ns_clusternode_readwrite'
    title: addns_clusternodeRequest
    example:
      ns_clusternode:
        clusterid: "3"
        nodeid: "2"
        clnodeip: "1.1.1.1"
        password: "password"
        iscco: "true"
        clip: "1.1.1.1"
        node_group: "string_value"
        spotted_config_supported: "false"

  addns_clusternodeResponse:
    type: object
    required:
      - ns_clusternode
    properties:
      ns_clusternode:
        $ref: '#/definitions/ns_clusternode'
    title: addns_clusternodeResponse
    example:
      ns_clusternode:
        clusterid: "3"
        nodeid: "2"
        clnodeip: "1.1.1.1"
        password: "password"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        iscco: "true"
        clip: "1.1.1.1"
        clmasterstate: "ACTIVE"
        node_group: "string_value"
        spotted_config_supported: "false"

  getns_clusternodeResponse:
    type: object
    required:
      - ns_clusternode
    properties:
      ns_clusternode:
        $ref: '#/definitions/ns_clusternode'
    title: getns_clusternodeResponse
    example:
      ns_clusternode:
        clusterid: "3"
        nodeid: "2"
        clnodeip: "1.1.1.1"
        password: "password"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        iscco: "true"
        clip: "1.1.1.1"
        clmasterstate: "ACTIVE"
        node_group: "string_value"
        spotted_config_supported: "false"

  getns_clusternodesResponse:
    type: object
    required:
      - ns_clusternode
    properties:
      ns_clusternode:
        type: array
        items:
          $ref: '#/definitions/ns_clusternode'
    title: getns_clusternodesResponse
    example:
      ns_clusternode:
        clusterid: "3"
        nodeid: "2"
        clnodeip: "1.1.1.1"
        password: "password"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        iscco: "true"
        clip: "1.1.1.1"
        clmasterstate: "ACTIVE"
        node_group: "string_value"
        spotted_config_supported: "false"

  ns_clusternode_readwrite:
    type: object
    properties:
      clusterid:
        description: "Cluster Instance ID"
        type: integer
        format: int32
      nodeid:
        description: "Cluster Node ID"
        type: integer
        format: int32
      clnodeip:
        description: "Cluster Node IP"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      password:
        description: "Password of the CCO node(CLIP)"
        type: string
        format: password
        minLength: 1
        maxLength: 128
      iscco:
        description: "Is CCO"
        type: boolean
        format: boolean
      clip:
        description: "Cluster IP"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      node_group:
        description: "Node Group where the node belongs in L3 Cluster"
        type: string
        format: string
      spotted_config_supported:
        description: "is spotted config supported"
        type: boolean
        format: boolean

  ns_clusternode:
    allOf:
      -
        properties:
          act_id:
             description: "Activity Id"
             type: string
             format: uuid
          clmasterstate:
             description: "Cluster Master State"
             type: string
             format: string
      - $ref: '#/definitions/ns_clusternode_readwrite'

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