Freestyle VMs API — Terminals

naftiko: 1.0.0-alpha2
info:
  label: "Freestyle VMs API \u2014 Terminals"
  description: 'Freestyle VMs API terminals surface. 3 operations. Lead operation: list_terminals. Self-contained Naftiko
    capability for one Freestyle business surface.'
  tags:
  - Freestyle
  - VM
  - Terminals
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    FREESTYLE_API_KEY: FREESTYLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: vm-terminals
    baseUri: https://api.freestyle.sh
    description: Freestyle VMs API terminals business capability.
    resources:
    - name: v1-vms-terminals
      path: /v1/vms/{vm_id}/terminals
      operations:
      - name: list-terminals
        method: GET
        description: list_terminals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vm_id
          in: path
          type: string
          required: true
    - name: v1-vms-terminals-logs
      path: /v1/vms/{vm_id}/terminals/{terminal_id}/logs
      operations:
      - name: get-terminal-logs
        method: GET
        description: get_terminal_logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vm_id
          in: path
          type: string
          required: true
        - name: terminal_id
          in: path
          type: string
          required: true
    - name: v1-vms-terminals-xterm-256color
      path: /v1/vms/{vm_id}/terminals/{terminal_id}/xterm-256color
      operations:
      - name: get-terminal-xterm
        method: GET
        description: get_terminal_xterm
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: vm_id
          in: path
          type: string
          required: true
        - name: terminal_id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: Bearer {{env.FREESTYLE_API_KEY}}
      placement: header
  exposes:
  - type: rest
    namespace: vm-terminals-rest
    port: 8080
    description: REST adapter for Freestyle VMs API terminals. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/vms/{vm_id}/terminals
      name: v1-vms-terminals
      description: REST surface for v1-vms-terminals.
      operations:
      - method: GET
        name: list-terminals
        description: list-terminals
        call: vm-terminals.list-terminals
        with:
          vm_id: rest.path.vm_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/vms/{vm_id}/terminals/{terminal_id}/logs
      name: v1-vms-terminals-logs
      description: REST surface for v1-vms-terminals-logs.
      operations:
      - method: GET
        name: get-terminal-logs
        description: get-terminal-logs
        call: vm-terminals.get-terminal-logs
        with:
          vm_id: rest.path.vm_id
          terminal_id: rest.path.terminal_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/vms/{vm_id}/terminals/{terminal_id}/xterm-256color
      name: v1-vms-terminals-xterm-256color
      description: REST surface for v1-vms-terminals-xterm-256color.
      operations:
      - method: GET
        name: get-terminal-xterm
        description: get-terminal-xterm
        call: vm-terminals.get-terminal-xterm
        with:
          vm_id: rest.path.vm_id
          terminal_id: rest.path.terminal_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vm-terminals-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freestyle VMs API terminals. One tool per consumed operation.
    tools:
    - name: freestyle-list-terminals
      description: list-terminals
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vm-terminals.list-terminals
      with:
        vm_id: tools.path.vm_id
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-get-terminal-logs
      description: get-terminal-logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vm-terminals.get-terminal-logs
      with:
        vm_id: tools.path.vm_id
        terminal_id: tools.path.terminal_id
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-get-terminal-xterm
      description: get-terminal-xterm
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vm-terminals.get-terminal-xterm
      with:
        vm_id: tools.path.vm_id
        terminal_id: tools.path.terminal_id
      outputParameters:
      - type: object
        mapping: $.