swagger: '2.0'
info:
  description: Configuration for Feature wise purge Setting resource.
  version: 'v2'
  title: module_purge_setting
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: module_purge_setting
    description: Feature wise purge Setting
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
   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/module_purge_setting:
    get:
      tags:
        - module_purge_setting
      summary: GET all module_purge_setting
      operationId: getall_module_purge_setting
      description: Use this operation to get module purge settings
      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 module_purge_setting 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 module_purge_setting 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 module_purge_setting resources.
          enum:
            - yes
      responses:
        200:
          description:  for module_purge_setting
          schema: 
              $ref: '#/definitions/getmodule_purge_settingsResponse'
        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/module_purge_setting/{id}:
    get:
      tags:
        - module_purge_setting
      summary: GET by key for module_purge_setting
      operationId: getbykey_module_purge_setting
      description: Use this operation to get module purge settings
      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 module_purge_setting
          schema: 
              $ref: '#/definitions/getmodule_purge_settingResponse'
        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'

    put:
      tags:
        - module_purge_setting
      summary: PUT for module_purge_setting
      operationId: putbykey_module_purge_setting
      description: Use this operation to modify module purge settings
      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
        - in: body
          name: module_purge_setting
          description: module_purge_setting object
          schema:
              $ref: '#/definitions/modifymodule_purge_settingRequest'
      responses:
        200:
          description:  for module_purge_setting
          schema: 
              $ref: '#/definitions/modifymodule_purge_settingResponse'
        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:
  getmodule_purge_settingResponse:
    type: object
    required:
      - module_purge_setting
    properties:
      module_purge_setting:
        $ref: '#/definitions/module_purge_setting'
    title: getmodule_purge_settingResponse
    example:
      module_purge_setting:
        module_name: "LICENSE_USAGE"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        purge_interval: "60"

  getmodule_purge_settingsResponse:
    type: object
    required:
      - module_purge_setting
    properties:
      module_purge_setting:
        type: array
        items:
          $ref: '#/definitions/module_purge_setting'
    title: getmodule_purge_settingsResponse
    example:
      module_purge_setting:
        module_name: "LICENSE_USAGE"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        purge_interval: "60"

  modifymodule_purge_settingRequest:
    type: object
    required:
      - module_purge_setting
    properties:
      module_purge_setting:
        $ref: '#/definitions/module_purge_setting_readwrite'
    title: modifymodule_purge_settingRequest
    example:
      module_purge_setting:
        module_name: "LICENSE_USAGE"
        purge_interval: "60"

  modifymodule_purge_settingResponse:
    type: object
    required:
      - module_purge_setting
    properties:
      module_purge_setting:
        $ref: '#/definitions/module_purge_setting'
    title: modifymodule_purge_settingResponse
    example:
      module_purge_setting:
        module_name: "LICENSE_USAGE"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        purge_interval: "60"

  module_purge_setting_readwrite:
    type: object
    properties:
      module_name:
        description: "module name"
        type: string
        format: string
      purge_interval:
        description: "purge interval"
        type: integer
        format: int32

  module_purge_setting:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: uuid
      - $ref: '#/definitions/module_purge_setting_readwrite'

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