UpKeep API — Preventive Maintenance

naftiko: 1.0.0-alpha2
info:
  label: UpKeep API — Preventive Maintenance
  description: 'UpKeep API — Preventive Maintenance. 5 operations. Lead operation: List Preventive Maintenances. Self-contained
    Naftiko capability covering one Upkeep business surface.'
  tags:
  - Upkeep
  - Preventive Maintenance
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPKEEP_API_KEY: UPKEEP_API_KEY
capability:
  consumes:
  - type: http
    namespace: upkeep-preventive-maintenance
    baseUri: https://api.onupkeep.com/api/v2
    description: UpKeep API — Preventive Maintenance business capability. Self-contained, no shared references.
    resources:
    - name: preventive-maintenances
      path: /preventive-maintenances
      operations:
      - name: listpreventivemaintenances
        method: GET
        description: List Preventive Maintenances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createpreventivemaintenance
        method: POST
        description: Create Preventive Maintenance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: preventive-maintenances-id
      path: /preventive-maintenances/{id}
      operations:
      - name: getpreventivemaintenance
        method: GET
        description: Get Preventive Maintenance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updatepreventivemaintenance
        method: PATCH
        description: Update Preventive Maintenance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletepreventivemaintenance
        method: DELETE
        description: Delete Preventive Maintenance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: session-token
      value: '{{env.UPKEEP_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: upkeep-preventive-maintenance-rest
    port: 8080
    description: REST adapter for UpKeep API — Preventive Maintenance. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/preventive-maintenances
      name: preventive-maintenances
      description: REST surface for preventive-maintenances.
      operations:
      - method: GET
        name: listpreventivemaintenances
        description: List Preventive Maintenances
        call: upkeep-preventive-maintenance.listpreventivemaintenances
        with:
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpreventivemaintenance
        description: Create Preventive Maintenance
        call: upkeep-preventive-maintenance.createpreventivemaintenance
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/preventive-maintenances/{id}
      name: preventive-maintenances-id
      description: REST surface for preventive-maintenances-id.
      operations:
      - method: GET
        name: getpreventivemaintenance
        description: Get Preventive Maintenance
        call: upkeep-preventive-maintenance.getpreventivemaintenance
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatepreventivemaintenance
        description: Update Preventive Maintenance
        call: upkeep-preventive-maintenance.updatepreventivemaintenance
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepreventivemaintenance
        description: Delete Preventive Maintenance
        call: upkeep-preventive-maintenance.deletepreventivemaintenance
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: upkeep-preventive-maintenance-mcp
    port: 9090
    transport: http
    description: MCP adapter for UpKeep API — Preventive Maintenance. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-preventive-maintenances
      description: List Preventive Maintenances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-preventive-maintenance.listpreventivemaintenances
      with:
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-preventive-maintenance
      description: Create Preventive Maintenance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: upkeep-preventive-maintenance.createpreventivemaintenance
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-preventive-maintenance
      description: Get Preventive Maintenance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-preventive-maintenance.getpreventivemaintenance
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-preventive-maintenance
      description: Update Preventive Maintenance
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: upkeep-preventive-maintenance.updatepreventivemaintenance
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-preventive-maintenance
      description: Delete Preventive Maintenance
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: upkeep-preventive-maintenance.deletepreventivemaintenance
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.