JupyterHub REST API — Tokens

naftiko: 1.0.0-alpha2
info:
  label: JupyterHub REST API — Tokens
  description: 'JupyterHub REST API — Tokens. 4 operations. Lead operation: JupyterHub List user tokens. Self-contained Naftiko
    capability covering one Jupyterhub business surface.'
  tags:
  - Jupyterhub
  - Tokens
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTERHUB_API_KEY: JUPYTERHUB_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-tokens
    baseUri: http://localhost:8000/hub/api
    description: JupyterHub REST API — Tokens business capability. Self-contained, no shared references.
    resources:
    - name: users-name-tokens
      path: /users/{name}/tokens
      operations:
      - name: listusertokens
        method: GET
        description: JupyterHub List user tokens
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: createusertoken
        method: POST
        description: JupyterHub Create user token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: users-name-tokens-token_id
      path: /users/{name}/tokens/{token_id}
      operations:
      - name: getusertoken
        method: GET
        description: JupyterHub Get user token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: token_id
          in: path
          type: string
          required: true
      - name: revokeusertoken
        method: DELETE
        description: JupyterHub Revoke user token
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: token_id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.JUPYTERHUB_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-tokens-rest
    port: 8080
    description: REST adapter for JupyterHub REST API — Tokens. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users/{name}/tokens
      name: users-name-tokens
      description: REST surface for users-name-tokens.
      operations:
      - method: GET
        name: listusertokens
        description: JupyterHub List user tokens
        call: rest-tokens.listusertokens
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createusertoken
        description: JupyterHub Create user token
        call: rest-tokens.createusertoken
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{name}/tokens/{token-id}
      name: users-name-tokens-token-id
      description: REST surface for users-name-tokens-token_id.
      operations:
      - method: GET
        name: getusertoken
        description: JupyterHub Get user token
        call: rest-tokens.getusertoken
        with:
          name: rest.name
          token_id: rest.token_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: revokeusertoken
        description: JupyterHub Revoke user token
        call: rest-tokens.revokeusertoken
        with:
          name: rest.name
          token_id: rest.token_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-tokens-mcp
    port: 9090
    transport: http
    description: MCP adapter for JupyterHub REST API — Tokens. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: jupyterhub-list-user-tokens
      description: JupyterHub List user tokens
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-tokens.listusertokens
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyterhub-create-user-token
      description: JupyterHub Create user token
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-tokens.createusertoken
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyterhub-get-user-token
      description: JupyterHub Get user token
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-tokens.getusertoken
      with:
        name: tools.name
        token_id: tools.token_id
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyterhub-revoke-user-token
      description: JupyterHub Revoke user token
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-tokens.revokeusertoken
      with:
        name: tools.name
        token_id: tools.token_id
      outputParameters:
      - type: object
        mapping: $.