OSIsoft PI Web API — BatchRequests

naftiko: 1.0.0-alpha2
info:
  label: OSIsoft PI Web API — BatchRequests
  description: 'OSIsoft PI Web API — BatchRequests. 1 operations. Lead operation: Execute a batch request. Self-contained
    Naftiko capability covering one Osisoft Pi business surface.'
  tags:
  - Osisoft Pi
  - BatchRequests
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OSISOFT_PI_API_KEY: OSISOFT_PI_API_KEY
capability:
  consumes:
  - type: http
    namespace: web-batchrequests
    baseUri: https://{piwebapi_host}/piwebapi
    description: OSIsoft PI Web API — BatchRequests business capability. Self-contained, no shared references.
    resources:
    - name: batch
      path: /batch
      operations:
      - name: executebatch
        method: POST
        description: Execute a batch request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.OSISOFT_PI_USER}}'
      password: '{{env.OSISOFT_PI_PASS}}'
  exposes:
  - type: rest
    namespace: web-batchrequests-rest
    port: 8080
    description: REST adapter for OSIsoft PI Web API — BatchRequests. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/batch
      name: batch
      description: REST surface for batch.
      operations:
      - method: POST
        name: executebatch
        description: Execute a batch request
        call: web-batchrequests.executebatch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: web-batchrequests-mcp
    port: 9090
    transport: http
    description: MCP adapter for OSIsoft PI Web API — BatchRequests. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: execute-batch-request
      description: Execute a batch request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: web-batchrequests.executebatch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.