OSIsoft PI Web API — EventFrames

naftiko: 1.0.0-alpha2
info:
  label: OSIsoft PI Web API — EventFrames
  description: 'OSIsoft PI Web API — EventFrames. 1 operations. Lead operation: Query event frames. Self-contained Naftiko
    capability covering one Osisoft Pi business surface.'
  tags:
  - Osisoft Pi
  - EventFrames
  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-eventframes
    baseUri: https://{piwebapi_host}/piwebapi
    description: OSIsoft PI Web API — EventFrames business capability. Self-contained, no shared references.
    resources:
    - name: eventframes
      path: /eventframes
      operations:
      - name: listeventframes
        method: GET
        description: Query event frames
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: databaseWebId
          in: query
          type: string
          description: AF database WebId to search
          required: true
        - name: startTime
          in: query
          type: string
        - name: endTime
          in: query
          type: string
        - name: nameFilter
          in: query
          type: string
        - name: templateName
          in: query
          type: string
        - name: maxCount
          in: query
          type: integer
        - name: selectedFields
          in: query
          type: string
    authentication:
      type: basic
      username: '{{env.OSISOFT_PI_USER}}'
      password: '{{env.OSISOFT_PI_PASS}}'
  exposes:
  - type: rest
    namespace: web-eventframes-rest
    port: 8080
    description: REST adapter for OSIsoft PI Web API — EventFrames. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/eventframes
      name: eventframes
      description: REST surface for eventframes.
      operations:
      - method: GET
        name: listeventframes
        description: Query event frames
        call: web-eventframes.listeventframes
        with:
          databaseWebId: rest.databaseWebId
          startTime: rest.startTime
          endTime: rest.endTime
          nameFilter: rest.nameFilter
          templateName: rest.templateName
          maxCount: rest.maxCount
          selectedFields: rest.selectedFields
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: web-eventframes-mcp
    port: 9090
    transport: http
    description: MCP adapter for OSIsoft PI Web API — EventFrames. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: query-event-frames
      description: Query event frames
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-eventframes.listeventframes
      with:
        databaseWebId: tools.databaseWebId
        startTime: tools.startTime
        endTime: tools.endTime
        nameFilter: tools.nameFilter
        templateName: tools.templateName
        maxCount: tools.maxCount
        selectedFields: tools.selectedFields
      outputParameters:
      - type: object
        mapping: $.