Open Liberty APIs — Batch

naftiko: 1.0.0-alpha2
info:
  label: Open Liberty APIs — Batch
  description: 'Open Liberty APIs — Batch. 6 operations. Lead operation: Get Batch Job Execution. Self-contained Naftiko capability
    covering one Websphere business surface.'
  tags:
  - Websphere
  - Batch
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBSPHERE_API_KEY: WEBSPHERE_API_KEY
capability:
  consumes:
  - type: http
    namespace: open-liberty-apis-batch
    baseUri: https://localhost:9443
    description: Open Liberty APIs — Batch business capability. Self-contained, no shared references.
    resources:
    - name: ibm-api-batch-jobexecutions-executionId
      path: /ibm/api/batch/jobexecutions/{executionId}
      operations:
      - name: getbatchjobexecution
        method: GET
        description: Get Batch Job Execution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: executionId
          in: path
          type: integer
          description: Job execution identifier
          required: true
    - name: ibm-api-batch-jobexecutions-executionId-restart
      path: /ibm/api/batch/jobexecutions/{executionId}/restart
      operations:
      - name: restartbatchjobexecution
        method: PUT
        description: Restart a Batch Job Execution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: executionId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: ibm-api-batch-jobexecutions-executionId-stop
      path: /ibm/api/batch/jobexecutions/{executionId}/stop
      operations:
      - name: stopbatchjobexecution
        method: PUT
        description: Stop a Batch Job Execution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: executionId
          in: path
          type: integer
          required: true
    - name: ibm-api-batch-jobinstances
      path: /ibm/api/batch/jobinstances
      operations:
      - name: listbatchjobinstances
        method: GET
        description: List Batch Job Instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobName
          in: query
          type: string
          description: Filter by job name
        - name: page
          in: query
          type: integer
          description: Page number
        - name: pageSize
          in: query
          type: integer
          description: Number of items per page
        - name: sortBy
          in: query
          type: string
          description: Sort field
    - name: ibm-api-batch-jobinstances-jobInstanceId
      path: /ibm/api/batch/jobinstances/{jobInstanceId}
      operations:
      - name: getbatchjobinstance
        method: GET
        description: Get Batch Job Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobInstanceId
          in: path
          type: integer
          description: Job instance identifier
          required: true
    - name: ibm-api-batch-jobinstances-jobInstanceId-jobexecutions
      path: /ibm/api/batch/jobinstances/{jobInstanceId}/jobexecutions
      operations:
      - name: listbatchjobexecutions
        method: GET
        description: List Job Executions for an Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobInstanceId
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.WEBSPHERE_API_KEY}}'
  exposes:
  - type: rest
    namespace: open-liberty-apis-batch-rest
    port: 8080
    description: REST adapter for Open Liberty APIs — Batch. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/ibm/api/batch/jobexecutions/{executionid}
      name: ibm-api-batch-jobexecutions-executionid
      description: REST surface for ibm-api-batch-jobexecutions-executionId.
      operations:
      - method: GET
        name: getbatchjobexecution
        description: Get Batch Job Execution
        call: open-liberty-apis-batch.getbatchjobexecution
        with:
          executionId: rest.executionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ibm/api/batch/jobexecutions/{executionid}/restart
      name: ibm-api-batch-jobexecutions-executionid-restart
      description: REST surface for ibm-api-batch-jobexecutions-executionId-restart.
      operations:
      - method: PUT
        name: restartbatchjobexecution
        description: Restart a Batch Job Execution
        call: open-liberty-apis-batch.restartbatchjobexecution
        with:
          executionId: rest.executionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ibm/api/batch/jobexecutions/{executionid}/stop
      name: ibm-api-batch-jobexecutions-executionid-stop
      description: REST surface for ibm-api-batch-jobexecutions-executionId-stop.
      operations:
      - method: PUT
        name: stopbatchjobexecution
        description: Stop a Batch Job Execution
        call: open-liberty-apis-batch.stopbatchjobexecution
        with:
          executionId: rest.executionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ibm/api/batch/jobinstances
      name: ibm-api-batch-jobinstances
      description: REST surface for ibm-api-batch-jobinstances.
      operations:
      - method: GET
        name: listbatchjobinstances
        description: List Batch Job Instances
        call: open-liberty-apis-batch.listbatchjobinstances
        with:
          jobName: rest.jobName
          page: rest.page
          pageSize: rest.pageSize
          sortBy: rest.sortBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ibm/api/batch/jobinstances/{jobinstanceid}
      name: ibm-api-batch-jobinstances-jobinstanceid
      description: REST surface for ibm-api-batch-jobinstances-jobInstanceId.
      operations:
      - method: GET
        name: getbatchjobinstance
        description: Get Batch Job Instance
        call: open-liberty-apis-batch.getbatchjobinstance
        with:
          jobInstanceId: rest.jobInstanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ibm/api/batch/jobinstances/{jobinstanceid}/jobexecutions
      name: ibm-api-batch-jobinstances-jobinstanceid-jobexecutions
      description: REST surface for ibm-api-batch-jobinstances-jobInstanceId-jobexecutions.
      operations:
      - method: GET
        name: listbatchjobexecutions
        description: List Job Executions for an Instance
        call: open-liberty-apis-batch.listbatchjobexecutions
        with:
          jobInstanceId: rest.jobInstanceId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: open-liberty-apis-batch-mcp
    port: 9090
    transport: http
    description: MCP adapter for Open Liberty APIs — Batch. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-batch-job-execution
      description: Get Batch Job Execution
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-batch.getbatchjobexecution
      with:
        executionId: tools.executionId
      outputParameters:
      - type: object
        mapping: $.
    - name: restart-batch-job-execution
      description: Restart a Batch Job Execution
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: open-liberty-apis-batch.restartbatchjobexecution
      with:
        executionId: tools.executionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-batch-job-execution
      description: Stop a Batch Job Execution
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: open-liberty-apis-batch.stopbatchjobexecution
      with:
        executionId: tools.executionId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-batch-job-instances
      description: List Batch Job Instances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-batch.listbatchjobinstances
      with:
        jobName: tools.jobName
        page: tools.page
        pageSize: tools.pageSize
        sortBy: tools.sortBy
      outputParameters:
      - type: object
        mapping: $.
    - name: get-batch-job-instance
      description: Get Batch Job Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-batch.getbatchjobinstance
      with:
        jobInstanceId: tools.jobInstanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: list-job-executions-instance
      description: List Job Executions for an Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: open-liberty-apis-batch.listbatchjobexecutions
      with:
        jobInstanceId: tools.jobInstanceId
      outputParameters:
      - type: object
        mapping: $.