OpenStorage SDK — OpenStorageRole

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageRole
  description: 'OpenStorage SDK — OpenStorageRole. 5 operations. Lead operation: List all roles. Self-contained Naftiko capability
    covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageRole
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstoragerole
    baseUri: ''
    description: OpenStorage SDK — OpenStorageRole business capability. Self-contained, no shared references.
    resources:
    - name: v1-roles
      path: /v1/roles
      operations:
      - name: openstorageroleenumerate
        method: GET
        description: List all roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: openstoragerolecreate
        method: POST
        description: Create a role for users in the system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: openstorageroleupdate
        method: PUT
        description: Update an existing role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-roles-inspect-name
      path: /v1/roles/inspect/{name}
      operations:
      - name: openstorageroleinspect
        method: GET
        description: Get information about a role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name of role
          required: true
    - name: v1-roles-name
      path: /v1/roles/{name}
      operations:
      - name: openstorageroledelete
        method: DELETE
        description: Delete an existing role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTWORX_API_KEY}}'
  exposes:
  - type: rest
    namespace: portworx-openstoragerole-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageRole. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/roles
      name: v1-roles
      description: REST surface for v1-roles.
      operations:
      - method: GET
        name: openstorageroleenumerate
        description: List all roles
        call: portworx-openstoragerole.openstorageroleenumerate
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: openstoragerolecreate
        description: Create a role for users in the system
        call: portworx-openstoragerole.openstoragerolecreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: openstorageroleupdate
        description: Update an existing role
        call: portworx-openstoragerole.openstorageroleupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/roles/inspect/{name}
      name: v1-roles-inspect-name
      description: REST surface for v1-roles-inspect-name.
      operations:
      - method: GET
        name: openstorageroleinspect
        description: Get information about a role
        call: portworx-openstoragerole.openstorageroleinspect
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/roles/{name}
      name: v1-roles-name
      description: REST surface for v1-roles-name.
      operations:
      - method: DELETE
        name: openstorageroledelete
        description: Delete an existing role
        call: portworx-openstoragerole.openstorageroledelete
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstoragerole-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageRole. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-roles
      description: List all roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstoragerole.openstorageroleenumerate
      outputParameters:
      - type: object
        mapping: $.
    - name: create-role-users-system
      description: Create a role for users in the system
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstoragerole.openstoragerolecreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-existing-role
      description: Update an existing role
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: portworx-openstoragerole.openstorageroleupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-information-about-role
      description: Get information about a role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstoragerole.openstorageroleinspect
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-existing-role
      description: Delete an existing role
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portworx-openstoragerole.openstorageroledelete
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.