swagger: '2.0'
info:
  description: Configuration for config audit template scheduler resource.
  version: 'v2'
  title: ns_configtemplate_scheduler
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_configtemplate_scheduler
    description: config audit template scheduler
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/ns_configtemplate_scheduler:
    get:
      tags:
        - ns_configtemplate_scheduler
      summary: GET all ns_configtemplate_scheduler
      operationId: getall_ns_configtemplate_scheduler
      description: Use this operation to get form  ns_configtemplate_scheduler
      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_configtemplate_scheduler 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_configtemplate_scheduler 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_configtemplate_scheduler resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_configtemplate_scheduler
          schema: 
              $ref: '#/definitions/getns_configtemplate_schedulersResponse'
        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:
        - ns_configtemplate_scheduler
      summary: POST operation for ns_configtemplate_scheduler
      operationId: post_ns_configtemplate_scheduler
      description: POST operation for ns_configtemplate_scheduler
      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: ns_configtemplate_scheduler
          description: ns_configtemplate_scheduler object
          schema:
              $ref: '#/definitions/addns_configtemplate_schedulerRequest'
      responses:
        200:
          description: add for ns_configtemplate_scheduler
          schema: 
              $ref: '#/definitions/addns_configtemplate_schedulerResponse'
        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/ns_configtemplate_scheduler/{id}:
    get:
      tags:
        - ns_configtemplate_scheduler
      summary: GET by key for ns_configtemplate_scheduler
      operationId: getbykey_ns_configtemplate_scheduler
      description: Use this operation to get form  ns_configtemplate_scheduler
      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 ns_configtemplate_scheduler
          schema: 
              $ref: '#/definitions/getns_configtemplate_schedulerResponse'
        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:
        - ns_configtemplate_scheduler
      summary: PUT for ns_configtemplate_scheduler
      operationId: putbykey_ns_configtemplate_scheduler
      description: Use this operation to modify ns_configtemplate_scheduler
      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: ns_configtemplate_scheduler
          description: ns_configtemplate_scheduler object
          schema:
              $ref: '#/definitions/modifyns_configtemplate_schedulerRequest'
      responses:
        200:
          description: add for ns_configtemplate_scheduler
          schema: 
              $ref: '#/definitions/modifyns_configtemplate_schedulerResponse'
        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'

    delete:
      tags:
        - ns_configtemplate_scheduler
      summary: Delete for ns_configtemplate_scheduler
      operationId: deletebykey_ns_configtemplate_scheduler
      description: Use this operation to delete from ns_configtemplate_scheduler
      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:
        204:
          description: add for ns_configtemplate_scheduler
        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_configtemplate_schedulerRequest:
    type: object
    required:
      - ns_configtemplate_scheduler
    properties:
      ns_configtemplate_scheduler:
        $ref: '#/definitions/ns_configtemplate_scheduler_readwrite'
    title: addns_configtemplate_schedulerRequest
    example:
      ns_configtemplate_scheduler:
        scheduleTimesEpoch: "1580774400"
        daily_time: "05:30"
        recurrenceOptions: "Mon,Tue"
        recurrence_type: "weekly"
        tz_offset: "0"

  addns_configtemplate_schedulerResponse:
    type: object
    required:
      - ns_configtemplate_scheduler
    properties:
      ns_configtemplate_scheduler:
        $ref: '#/definitions/ns_configtemplate_scheduler'
    title: addns_configtemplate_schedulerResponse
    example:
      ns_configtemplate_scheduler:
        scheduleTimesEpoch: "1580774400"
        parent_name: "test_job"
        daily_time: "05:30"
        recurrenceOptions: "Mon,Tue"
        id: "02640332-1e11-4f61-a17f-1f28bbb18fcc"
        recurrence_type: "weekly"
        tz_offset: "0"
        parent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getns_configtemplate_schedulerResponse:
    type: object
    required:
      - ns_configtemplate_scheduler
    properties:
      ns_configtemplate_scheduler:
        $ref: '#/definitions/ns_configtemplate_scheduler'
    title: getns_configtemplate_schedulerResponse
    example:
      ns_configtemplate_scheduler:
        scheduleTimesEpoch: "1580774400"
        parent_name: "test_job"
        daily_time: "05:30"
        recurrenceOptions: "Mon,Tue"
        id: "02640332-1e11-4f61-a17f-1f28bbb18fcc"
        recurrence_type: "weekly"
        tz_offset: "0"
        parent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getns_configtemplate_schedulersResponse:
    type: object
    required:
      - ns_configtemplate_scheduler
    properties:
      ns_configtemplate_scheduler:
        type: array
        items:
          $ref: '#/definitions/ns_configtemplate_scheduler'
    title: getns_configtemplate_schedulersResponse
    example:
      ns_configtemplate_scheduler:
        scheduleTimesEpoch: "1580774400"
        parent_name: "test_job"
        daily_time: "05:30"
        recurrenceOptions: "Mon,Tue"
        id: "02640332-1e11-4f61-a17f-1f28bbb18fcc"
        recurrence_type: "weekly"
        tz_offset: "0"
        parent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  modifyns_configtemplate_schedulerRequest:
    type: object
    required:
      - ns_configtemplate_scheduler
    properties:
      ns_configtemplate_scheduler:
        $ref: '#/definitions/ns_configtemplate_scheduler_readwrite'
    title: modifyns_configtemplate_schedulerRequest
    example:
      ns_configtemplate_scheduler:
        scheduleTimesEpoch: "1580774400"
        daily_time: "05:30"
        recurrenceOptions: "Mon,Tue"
        recurrence_type: "weekly"
        tz_offset: "0"

  modifyns_configtemplate_schedulerResponse:
    type: object
    required:
      - ns_configtemplate_scheduler
    properties:
      ns_configtemplate_scheduler:
        $ref: '#/definitions/ns_configtemplate_scheduler'
    title: modifyns_configtemplate_schedulerResponse
    example:
      ns_configtemplate_scheduler:
        scheduleTimesEpoch: "1580774400"
        parent_name: "test_job"
        daily_time: "05:30"
        recurrenceOptions: "Mon,Tue"
        id: "02640332-1e11-4f61-a17f-1f28bbb18fcc"
        recurrence_type: "weekly"
        tz_offset: "0"
        parent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  ns_configtemplate_scheduler_readwrite:
    type: object
    properties:
      scheduleTimesEpoch:
        description: "Epoch times for scheduling the job"
        type: string
        format: int64
      daily_time:
        description: "Daily time details of scheduler"
        type: string
        format: string
      recurrenceOptions:
        description: "Comma separated recurrence options of job that is scheduled"
        type: string
        format: string
      recurrence_type:
        description: "Daily, Week or Monthly option"
        type: string
        format: string
        maxLength: 255
      tz_offset:
        description: "Time zone offset."
        type: integer
        format: int32

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

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