OpenStorage SDK — OpenStorageJob

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageJob
  description: 'OpenStorage SDK — OpenStorageJob. 3 operations. Lead operation: Enumerate returns all the jobs currently known
    to the system. Self-contained Naftiko capability covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageJob
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstoragejob
    baseUri: ''
    description: OpenStorage SDK — OpenStorageJob business capability. Self-contained, no shared references.
    resources:
    - name: v1-jobs
      path: /v1/jobs
      operations:
      - name: openstoragejobenumerate
        method: GET
        description: Enumerate returns all the jobs currently known to the system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: Type if specified will list the jobs of the provided type.
    - name: v1-jobs-id
      path: /v1/jobs/{id}
      operations:
      - name: openstoragejobgetstatus
        method: GET
        description: GetStatus gets the status of a job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the job
          required: true
        - name: type
          in: query
          type: string
          description: Type of the job.
      - name: openstoragejobupdate
        method: PUT
        description: Update updates an existing job's state
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: ID of the job
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTWORX_API_KEY}}'
  exposes:
  - type: rest
    namespace: portworx-openstoragejob-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageJob. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/jobs
      name: v1-jobs
      description: REST surface for v1-jobs.
      operations:
      - method: GET
        name: openstoragejobenumerate
        description: Enumerate returns all the jobs currently known to the system
        call: portworx-openstoragejob.openstoragejobenumerate
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/jobs/{id}
      name: v1-jobs-id
      description: REST surface for v1-jobs-id.
      operations:
      - method: GET
        name: openstoragejobgetstatus
        description: GetStatus gets the status of a job
        call: portworx-openstoragejob.openstoragejobgetstatus
        with:
          id: rest.id
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: openstoragejobupdate
        description: Update updates an existing job's state
        call: portworx-openstoragejob.openstoragejobupdate
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstoragejob-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageJob. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: enumerate-returns-all-jobs-currently
      description: Enumerate returns all the jobs currently known to the system
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstoragejob.openstoragejobenumerate
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: getstatus-gets-status-job
      description: GetStatus gets the status of a job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstoragejob.openstoragejobgetstatus
      with:
        id: tools.id
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: update-updates-existing-job-s-state
      description: Update updates an existing job's state
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: portworx-openstoragejob.openstoragejobupdate
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.