UpKeep API — Parts

naftiko: 1.0.0-alpha2
info:
  label: UpKeep API — Parts
  description: 'UpKeep API — Parts. 5 operations. Lead operation: List Parts. Self-contained Naftiko capability covering one
    Upkeep business surface.'
  tags:
  - Upkeep
  - Parts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPKEEP_API_KEY: UPKEEP_API_KEY
capability:
  consumes:
  - type: http
    namespace: upkeep-parts
    baseUri: https://api.onupkeep.com/api/v2
    description: UpKeep API — Parts business capability. Self-contained, no shared references.
    resources:
    - name: parts
      path: /parts
      operations:
      - name: listparts
        method: GET
        description: List Parts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createpart
        method: POST
        description: Create Part
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: parts-id
      path: /parts/{id}
      operations:
      - name: getpart
        method: GET
        description: Get Part
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updatepart
        method: PATCH
        description: Update Part
        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: deletepart
        method: DELETE
        description: Delete Part
        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-parts-rest
    port: 8080
    description: REST adapter for UpKeep API — Parts. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/parts
      name: parts
      description: REST surface for parts.
      operations:
      - method: GET
        name: listparts
        description: List Parts
        call: upkeep-parts.listparts
        with:
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpart
        description: Create Part
        call: upkeep-parts.createpart
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/parts/{id}
      name: parts-id
      description: REST surface for parts-id.
      operations:
      - method: GET
        name: getpart
        description: Get Part
        call: upkeep-parts.getpart
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatepart
        description: Update Part
        call: upkeep-parts.updatepart
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepart
        description: Delete Part
        call: upkeep-parts.deletepart
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: upkeep-parts-mcp
    port: 9090
    transport: http
    description: MCP adapter for UpKeep API — Parts. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-parts
      description: List Parts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-parts.listparts
      with:
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-part
      description: Create Part
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: upkeep-parts.createpart
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-part
      description: Get Part
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: upkeep-parts.getpart
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-part
      description: Update Part
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: upkeep-parts.updatepart
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-part
      description: Delete Part
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: upkeep-parts.deletepart
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.