JupyterHub REST API — Proxy

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