OpenStorage SDK — OpenStorageSchedule

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageSchedule
  description: 'OpenStorage SDK — OpenStorageSchedule. 3 operations. Lead operation: Enumerate returns all the schedules.
    Self-contained Naftiko capability covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageSchedule
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstorageschedule
    baseUri: ''
    description: OpenStorage SDK — OpenStorageSchedule business capability. Self-contained, no shared references.
    resources:
    - name: v1-schedules-type
      path: /v1/schedules/{type}
      operations:
      - name: openstoragescheduleenumerate
        method: GET
        description: Enumerate returns all the schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: Type is schedule type (cast to string from a Job.Type enum, as the version of
          required: true
    - name: v1-schedules-type-id
      path: /v1/schedules/{type}/{id}
      operations:
      - name: openstoragescheduledelete
        method: DELETE
        description: Delete deletes a schedule by type and ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: Type is schedule type (cast to string from a Job.Type enum, as the version of
          required: true
        - name: id
          in: path
          type: string
          description: ID of the schedule
          required: true
      - name: openstoragescheduleinspect
        method: GET
        description: Inspect queries information of a schedule by type and ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: Type is schedule type (cast to string from a Job.Type enum, as the version of
          required: true
        - name: id
          in: path
          type: string
          description: ID of the schedule
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTWORX_API_KEY}}'
  exposes:
  - type: rest
    namespace: portworx-openstorageschedule-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageSchedule. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/schedules/{type}
      name: v1-schedules-type
      description: REST surface for v1-schedules-type.
      operations:
      - method: GET
        name: openstoragescheduleenumerate
        description: Enumerate returns all the schedules
        call: portworx-openstorageschedule.openstoragescheduleenumerate
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/schedules/{type}/{id}
      name: v1-schedules-type-id
      description: REST surface for v1-schedules-type-id.
      operations:
      - method: DELETE
        name: openstoragescheduledelete
        description: Delete deletes a schedule by type and ID
        call: portworx-openstorageschedule.openstoragescheduledelete
        with:
          type: rest.type
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: openstoragescheduleinspect
        description: Inspect queries information of a schedule by type and ID
        call: portworx-openstorageschedule.openstoragescheduleinspect
        with:
          type: rest.type
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstorageschedule-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageSchedule. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: enumerate-returns-all-schedules
      description: Enumerate returns all the schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageschedule.openstoragescheduleenumerate
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-deletes-schedule-type-and
      description: Delete deletes a schedule by type and ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portworx-openstorageschedule.openstoragescheduledelete
      with:
        type: tools.type
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: inspect-queries-information-schedule-type
      description: Inspect queries information of a schedule by type and ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageschedule.openstoragescheduleinspect
      with:
        type: tools.type
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.