OpenStorage SDK — OpenStorageObjectstore

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageObjectstore
  description: 'OpenStorage SDK — OpenStorageObjectstore. 4 operations. Lead operation: Creates creates an object store endpoint
    on specified volume. Self-contained Naftiko capability covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageObjectstore
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstorageobjectstore
    baseUri: ''
    description: OpenStorage SDK — OpenStorageObjectstore business capability. Self-contained, no shared references.
    resources:
    - name: v1-objectstores
      path: /v1/objectstores
      operations:
      - name: openstorageobjectstorecreate
        method: POST
        description: Creates creates an object store endpoint on specified volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-objectstores-inspect-objectstore_id
      path: /v1/objectstores/inspect/{objectstore_id}
      operations:
      - name: openstorageobjectstoreinspect
        method: GET
        description: Inspect returns information about the object store endpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectstore_id
          in: path
          type: string
          description: Id of the object store
          required: true
    - name: v1-objectstores-objectstore_id
      path: /v1/objectstores/{objectstore_id}
      operations:
      - name: openstorageobjectstoredelete
        method: DELETE
        description: Delete destroys the object store endpoint on the volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectstore_id
          in: path
          type: string
          description: Id of the object store to delete
          required: true
      - name: openstorageobjectstoreupdate
        method: PUT
        description: Updates provided objectstore status.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectstore_id
          in: path
          type: string
          description: Objectstore Id to update
          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-openstorageobjectstore-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageObjectstore. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/objectstores
      name: v1-objectstores
      description: REST surface for v1-objectstores.
      operations:
      - method: POST
        name: openstorageobjectstorecreate
        description: Creates creates an object store endpoint on specified volume
        call: portworx-openstorageobjectstore.openstorageobjectstorecreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/objectstores/inspect/{objectstore-id}
      name: v1-objectstores-inspect-objectstore-id
      description: REST surface for v1-objectstores-inspect-objectstore_id.
      operations:
      - method: GET
        name: openstorageobjectstoreinspect
        description: Inspect returns information about the object store endpoint
        call: portworx-openstorageobjectstore.openstorageobjectstoreinspect
        with:
          objectstore_id: rest.objectstore_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/objectstores/{objectstore-id}
      name: v1-objectstores-objectstore-id
      description: REST surface for v1-objectstores-objectstore_id.
      operations:
      - method: DELETE
        name: openstorageobjectstoredelete
        description: Delete destroys the object store endpoint on the volume
        call: portworx-openstorageobjectstore.openstorageobjectstoredelete
        with:
          objectstore_id: rest.objectstore_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: openstorageobjectstoreupdate
        description: Updates provided objectstore status.
        call: portworx-openstorageobjectstore.openstorageobjectstoreupdate
        with:
          objectstore_id: rest.objectstore_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstorageobjectstore-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageObjectstore. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: creates-creates-object-store-endpoint
      description: Creates creates an object store endpoint on specified volume
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstorageobjectstore.openstorageobjectstorecreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: inspect-returns-information-about-object
      description: Inspect returns information about the object store endpoint
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageobjectstore.openstorageobjectstoreinspect
      with:
        objectstore_id: tools.objectstore_id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-destroys-object-store-endpoint
      description: Delete destroys the object store endpoint on the volume
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portworx-openstorageobjectstore.openstorageobjectstoredelete
      with:
        objectstore_id: tools.objectstore_id
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-provided-objectstore-status
      description: Updates provided objectstore status.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: portworx-openstorageobjectstore.openstorageobjectstoreupdate
      with:
        objectstore_id: tools.objectstore_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.