OpenStorage SDK — OpenStorageSchedulePolicy

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageSchedulePolicy
  description: 'OpenStorage SDK — OpenStorageSchedulePolicy. 5 operations. Lead operation: Enumerate returns a list of schedules.
    Self-contained Naftiko capability covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageSchedulePolicy
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstorageschedulepolicy
    baseUri: ''
    description: OpenStorage SDK — OpenStorageSchedulePolicy business capability. Self-contained, no shared references.
    resources:
    - name: v1-schedulepolicies
      path: /v1/schedulepolicies
      operations:
      - name: openstorageschedulepolicyenumerate
        method: GET
        description: Enumerate returns a list of schedules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: openstorageschedulepolicycreate
        method: POST
        description: Create creates a new snapshot schedule. They can be setup daily,
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: openstorageschedulepolicyupdate
        method: PUT
        description: Update a snapshot schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-schedulepolicies-inspect-name
      path: /v1/schedulepolicies/inspect/{name}
      operations:
      - name: openstorageschedulepolicyinspect
        method: GET
        description: Inspect returns information about a specified schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the schedule Policy
          required: true
    - name: v1-schedulepolicies-name
      path: /v1/schedulepolicies/{name}
      operations:
      - name: openstorageschedulepolicydelete
        method: DELETE
        description: Delete removes a snapshot schedule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of the schedule policy
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTWORX_API_KEY}}'
  exposes:
  - type: rest
    namespace: portworx-openstorageschedulepolicy-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageSchedulePolicy. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/schedulepolicies
      name: v1-schedulepolicies
      description: REST surface for v1-schedulepolicies.
      operations:
      - method: GET
        name: openstorageschedulepolicyenumerate
        description: Enumerate returns a list of schedules
        call: portworx-openstorageschedulepolicy.openstorageschedulepolicyenumerate
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: openstorageschedulepolicycreate
        description: Create creates a new snapshot schedule. They can be setup daily,
        call: portworx-openstorageschedulepolicy.openstorageschedulepolicycreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: openstorageschedulepolicyupdate
        description: Update a snapshot schedule
        call: portworx-openstorageschedulepolicy.openstorageschedulepolicyupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/schedulepolicies/inspect/{name}
      name: v1-schedulepolicies-inspect-name
      description: REST surface for v1-schedulepolicies-inspect-name.
      operations:
      - method: GET
        name: openstorageschedulepolicyinspect
        description: Inspect returns information about a specified schedule
        call: portworx-openstorageschedulepolicy.openstorageschedulepolicyinspect
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/schedulepolicies/{name}
      name: v1-schedulepolicies-name
      description: REST surface for v1-schedulepolicies-name.
      operations:
      - method: DELETE
        name: openstorageschedulepolicydelete
        description: Delete removes a snapshot schedule
        call: portworx-openstorageschedulepolicy.openstorageschedulepolicydelete
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstorageschedulepolicy-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageSchedulePolicy. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: enumerate-returns-list-schedules
      description: Enumerate returns a list of schedules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageschedulepolicy.openstorageschedulepolicyenumerate
      outputParameters:
      - type: object
        mapping: $.
    - name: create-creates-new-snapshot-schedule
      description: Create creates a new snapshot schedule. They can be setup daily,
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstorageschedulepolicy.openstorageschedulepolicycreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-snapshot-schedule
      description: Update a snapshot schedule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: portworx-openstorageschedulepolicy.openstorageschedulepolicyupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: inspect-returns-information-about-specified
      description: Inspect returns information about a specified schedule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageschedulepolicy.openstorageschedulepolicyinspect
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-removes-snapshot-schedule
      description: Delete removes a snapshot schedule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portworx-openstorageschedulepolicy.openstorageschedulepolicydelete
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.