OpenStorage SDK — OpenStorageClusterDomains

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageClusterDomains
  description: 'OpenStorage SDK — OpenStorageClusterDomains. 4 operations. Lead operation: Enumerate returns names of all
    the cluster domains in the cluster. Self-contained Naftiko capability covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageClusterDomains
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstorageclusterdomains
    baseUri: ''
    description: OpenStorage SDK — OpenStorageClusterDomains business capability. Self-contained, no shared references.
    resources:
    - name: v1-clusterdomains
      path: /v1/clusterdomains
      operations:
      - name: openstorageclusterdomainsenumerate
        method: GET
        description: Enumerate returns names of all the cluster domains in the cluster
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-clusterdomains-activate-cluster_domain_name
      path: /v1/clusterdomains/activate/{cluster_domain_name}
      operations:
      - name: openstorageclusterdomainsactivate
        method: POST
        description: Activates a cluster domain in the cluster.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cluster_domain_name
          in: path
          type: string
          description: Name of the cluster domain to activate
          required: true
    - name: v1-clusterdomains-deactivate-cluster_domain_name
      path: /v1/clusterdomains/deactivate/{cluster_domain_name}
      operations:
      - name: openstorageclusterdomainsdeactivate
        method: POST
        description: Deactivates a cluster domain in the cluster.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cluster_domain_name
          in: path
          type: string
          description: Name of the cluster domain to deactivate
          required: true
    - name: v1-clusterdomains-inspect-cluster_domain_name
      path: /v1/clusterdomains/inspect/{cluster_domain_name}
      operations:
      - name: openstorageclusterdomainsinspect
        method: GET
        description: Inspect returns information about a cluster domain and a
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cluster_domain_name
          in: path
          type: string
          description: Name of the cluster domain to inspect
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTWORX_API_KEY}}'
  exposes:
  - type: rest
    namespace: portworx-openstorageclusterdomains-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageClusterDomains. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/clusterdomains
      name: v1-clusterdomains
      description: REST surface for v1-clusterdomains.
      operations:
      - method: GET
        name: openstorageclusterdomainsenumerate
        description: Enumerate returns names of all the cluster domains in the cluster
        call: portworx-openstorageclusterdomains.openstorageclusterdomainsenumerate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/clusterdomains/activate/{cluster-domain-name}
      name: v1-clusterdomains-activate-cluster-domain-name
      description: REST surface for v1-clusterdomains-activate-cluster_domain_name.
      operations:
      - method: POST
        name: openstorageclusterdomainsactivate
        description: Activates a cluster domain in the cluster.
        call: portworx-openstorageclusterdomains.openstorageclusterdomainsactivate
        with:
          cluster_domain_name: rest.cluster_domain_name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/clusterdomains/deactivate/{cluster-domain-name}
      name: v1-clusterdomains-deactivate-cluster-domain-name
      description: REST surface for v1-clusterdomains-deactivate-cluster_domain_name.
      operations:
      - method: POST
        name: openstorageclusterdomainsdeactivate
        description: Deactivates a cluster domain in the cluster.
        call: portworx-openstorageclusterdomains.openstorageclusterdomainsdeactivate
        with:
          cluster_domain_name: rest.cluster_domain_name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/clusterdomains/inspect/{cluster-domain-name}
      name: v1-clusterdomains-inspect-cluster-domain-name
      description: REST surface for v1-clusterdomains-inspect-cluster_domain_name.
      operations:
      - method: GET
        name: openstorageclusterdomainsinspect
        description: Inspect returns information about a cluster domain and a
        call: portworx-openstorageclusterdomains.openstorageclusterdomainsinspect
        with:
          cluster_domain_name: rest.cluster_domain_name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstorageclusterdomains-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageClusterDomains. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: enumerate-returns-names-all-cluster
      description: Enumerate returns names of all the cluster domains in the cluster
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageclusterdomains.openstorageclusterdomainsenumerate
      outputParameters:
      - type: object
        mapping: $.
    - name: activates-cluster-domain-cluster
      description: Activates a cluster domain in the cluster.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstorageclusterdomains.openstorageclusterdomainsactivate
      with:
        cluster_domain_name: tools.cluster_domain_name
      outputParameters:
      - type: object
        mapping: $.
    - name: deactivates-cluster-domain-cluster
      description: Deactivates a cluster domain in the cluster.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstorageclusterdomains.openstorageclusterdomainsdeactivate
      with:
        cluster_domain_name: tools.cluster_domain_name
      outputParameters:
      - type: object
        mapping: $.
    - name: inspect-returns-information-about-cluster
      description: Inspect returns information about a cluster domain and a
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageclusterdomains.openstorageclusterdomainsinspect
      with:
        cluster_domain_name: tools.cluster_domain_name
      outputParameters:
      - type: object
        mapping: $.