swagger: '2.0'
info:
  description: Configuration for This gives the information about which all tree nodes in GUI are authorized and will be visible to a user after login. resource.
  version: 'v2'
  title: rba_ui
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: rba_ui
    description: This gives the information about which all tree nodes in GUI are authorized and will be visible to a user after login.
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 permission statements
   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/rba_ui:
    get:
      tags:
        - rba_ui
      summary: GET all rba_ui
      operationId: getall_rba_ui
      description: Use this operation to get all UI tress nodes are authorized to a user.
      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 rba_ui 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 rba_ui 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 rba_ui resources.
          enum:
            - yes
      responses:
        200:
          description:  for rba_ui
          schema: 
              $ref: '#/definitions/getrba_uisResponse'
        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/rba_ui/{id}:
    get:
      tags:
        - rba_ui
      summary: GET by key for rba_ui
      operationId: getbykey_rba_ui
      description: Use this operation to get all UI tress nodes are authorized to a user.
      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 rba_ui
          schema: 
              $ref: '#/definitions/getrba_uiResponse'
        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:
  getrba_uiResponse:
    type: object
    required:
      - rba_ui
    properties:
      rba_ui:
        $ref: '#/definitions/rba_ui'
    title: getrba_uiResponse
    example:
      rba_ui:
        parent_name: "parent_device"
        name: "BLR-Site"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        display_name: "lb vserver1"
        access_type: "true"
        parent_id: "10"

  getrba_uisResponse:
    type: object
    required:
      - rba_ui
    properties:
      rba_ui:
        type: array
        items:
          $ref: '#/definitions/rba_ui'
    title: getrba_uisResponse
    example:
      rba_ui:
        parent_name: "parent_device"
        name: "BLR-Site"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        display_name: "lb vserver1"
        access_type: "true"
        parent_id: "10"

  rba_ui_readwrite:
    type: object
    properties:
      name:
        description: "Unique name for UI tree node"
        type: string
        format: string
      display_name:
        description: "Display name for UI tree node"
        type: string
        format: string
      access_type:
        description: "true, if access is allowed"
        type: boolean
        format: boolean

  rba_ui:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the permission statements
            type: string
            format: string
          parent_name:
             description: "Parent node name for UI tree node"
             type: string
             format: string
          parent_id:
             description: "Parent id for UI tree node"
             type: string
             format: string
      - $ref: '#/definitions/rba_ui_readwrite'

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