swagger: '2.0'
info:
  description: Configuration for Inventory resource.
  version: 'v2'
  title: inventory
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: inventory
    description: Inventory
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: device_ipaddress
   in: path
   type: string
   description: Device IP Address
   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/inventory:
    get:
      tags:
        - inventory
      summary: GET all inventory
      operationId: getall_inventory
      description: Use this operation to start inventory of a given device. All devices if device IP Address is not specified.
      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 inventory 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 inventory 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 inventory resources.
          enum:
            - yes
      responses:
        200:
          description:  for inventory
          schema: 
              $ref: '#/definitions/getinventorysResponse'
        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:
        - inventory
      summary: POST operation for inventory
      operationId: post_inventory
      description: POST operation for inventory
      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: inventory
          description: inventory object
          schema:
              $ref: '#/definitions/addinventoryRequest'
      responses:
        200:
          description: add for inventory
          schema: 
              $ref: '#/definitions/addinventoryResponse'
        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/inventory/{device_ipaddress}:
    get:
      tags:
        - inventory
      summary: GET by key for inventory
      operationId: getbykey_inventory
      description: Use this operation to start inventory of a given device. All devices if device IP Address is not specified.
      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 inventory
          schema: 
              $ref: '#/definitions/getinventoryResponse'
        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:
  addinventoryRequest:
    type: object
    required:
      - inventory
    properties:
      inventory:
        $ref: '#/definitions/inventory_readwrite'
    title: addinventoryRequest
    example:
      inventory:
        agent_id: "string_value"
        devices: ["string_value1","string_value2"]

  addinventoryResponse:
    type: object
    required:
      - inventory
    properties:
      inventory:
        $ref: '#/definitions/inventory'
    title: addinventoryResponse
    example:
      inventory:
        device_ipaddress: "1.1.1.1"
        device_type: "nsvpx"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        agent_id: "string_value"
        inventory_status: "string_value"
        customer_name: "admTenant"
        devices: ["string_value1","string_value2"]

  getinventoryResponse:
    type: object
    required:
      - inventory
    properties:
      inventory:
        $ref: '#/definitions/inventory'
    title: getinventoryResponse
    example:
      inventory:
        device_ipaddress: "1.1.1.1"
        device_type: "nsvpx"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        agent_id: "string_value"
        inventory_status: "string_value"
        customer_name: "admTenant"
        devices: ["string_value1","string_value2"]

  getinventorysResponse:
    type: object
    required:
      - inventory
    properties:
      inventory:
        type: array
        items:
          $ref: '#/definitions/inventory'
    title: getinventorysResponse
    example:
      inventory:
        device_ipaddress: "1.1.1.1"
        device_type: "nsvpx"
        act_id: "fce5b825-9217-4e58-b80c-48cfe8f0c6b3"
        agent_id: "string_value"
        inventory_status: "string_value"
        customer_name: "admTenant"
        devices: ["string_value1","string_value2"]

  inventory_readwrite:
    type: object
    properties:
      agent_id:
        description: "Agent ID"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      devices:
        description: "List of Device IPAddresses"
        type: array
        items:
          type: string
          format: string

  inventory:
    allOf:
      -
        properties:
          device_ipaddress:
            description: Device IP Address
            type: string
            format: IP Address
          device_type:
             description: "Status of inventory"
             type: string
             format: string
             minLength: 1
             maxLength: 64
          act_id:
             description: "Activity Id"
             type: string
             format: string
          inventory_status:
             description: "Status of inventory"
             type: string
             format: string
             minLength: 1
             maxLength: 1024
          customer_name:
             description: "customer name"
             type: string
             format: string
      - $ref: '#/definitions/inventory_readwrite'

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