JupyterHub REST API

naftiko: 1.0.0-alpha2
info:
  label: JupyterHub REST API
  description: 'JupyterHub REST API. 2 operations. Lead operation: JupyterHub Get version. Self-contained Naftiko capability
    covering one Jupyterhub business surface.'
  tags:
  - Jupyterhub
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTERHUB_API_KEY: JUPYTERHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-general
    baseUri: http://localhost:8000/hub/api
    description: JupyterHub REST API business capability. Self-contained, no shared references.
    resources:
    - name: root
      path: /
      operations:
      - name: gethubversion
        method: GET
        description: JupyterHub Get version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: info
      path: /info
      operations:
      - name: gethubinfo
        method: GET
        description: JupyterHub Get detailed info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.JUPYTERHUB_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-general-rest
    port: 8080
    description: REST adapter for JupyterHub REST API. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1
      name: root
      description: REST surface for root.
      operations:
      - method: GET
        name: gethubversion
        description: JupyterHub Get version
        call: rest-general.gethubversion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/info
      name: info
      description: REST surface for info.
      operations:
      - method: GET
        name: gethubinfo
        description: JupyterHub Get detailed info
        call: rest-general.gethubinfo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for JupyterHub REST API. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: jupyterhub-get-version
      description: JupyterHub Get version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-general.gethubversion
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyterhub-get-detailed-info
      description: JupyterHub Get detailed info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-general.gethubinfo
      outputParameters:
      - type: object
        mapping: $.