Apache Guacamole REST API — Connections

naftiko: 1.0.0-alpha2
info:
  label: Apache Guacamole REST API — Connections
  description: 'Apache Guacamole REST API — Connections. 5 operations. Lead operation: Apache Guacamole List Connections.
    Self-contained Naftiko capability covering one Apache Guacamole business surface.'
  tags:
  - Apache Guacamole
  - Connections
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    APACHE_GUACAMOLE_API_KEY: APACHE_GUACAMOLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-connections
    baseUri: http://localhost:8080/guacamole
    description: Apache Guacamole REST API — Connections business capability. Self-contained, no shared references.
    resources:
    - name: api-session-data-dataSource-connections
      path: /api/session/data/{dataSource}/connections
      operations:
      - name: listconnections
        method: GET
        description: Apache Guacamole List Connections
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSource
          in: path
          type: string
          description: The data source identifier (e.g., postgresql, mysql)
          required: true
        - name: Guacamole-Token
          in: header
          type: string
          description: Authentication token from /api/tokens
          required: true
      - name: createconnection
        method: POST
        description: Apache Guacamole Create Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSource
          in: path
          type: string
          description: The data source identifier
          required: true
        - name: Guacamole-Token
          in: header
          type: string
          description: Authentication token
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-session-data-dataSource-connections-connectionId
      path: /api/session/data/{dataSource}/connections/{connectionId}
      operations:
      - name: getconnection
        method: GET
        description: Apache Guacamole Get Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSource
          in: path
          type: string
          description: The data source identifier
          required: true
        - name: connectionId
          in: path
          type: string
          description: The unique connection identifier
          required: true
        - name: Guacamole-Token
          in: header
          type: string
          description: Authentication token
          required: true
      - name: updateconnection
        method: PUT
        description: Apache Guacamole Update Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSource
          in: path
          type: string
          description: The data source identifier
          required: true
        - name: connectionId
          in: path
          type: string
          description: The unique connection identifier
          required: true
        - name: Guacamole-Token
          in: header
          type: string
          description: Authentication token
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconnection
        method: DELETE
        description: Apache Guacamole Delete Connection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dataSource
          in: path
          type: string
          description: The data source identifier
          required: true
        - name: connectionId
          in: path
          type: string
          description: The unique connection identifier
          required: true
        - name: Guacamole-Token
          in: header
          type: string
          description: Authentication token
          required: true
    authentication:
      type: apikey
      key: Guacamole-Token
      value: '{{env.APACHE_GUACAMOLE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-connections-rest
    port: 8080
    description: REST adapter for Apache Guacamole REST API — Connections. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/session/data/{datasource}/connections
      name: api-session-data-datasource-connections
      description: REST surface for api-session-data-dataSource-connections.
      operations:
      - method: GET
        name: listconnections
        description: Apache Guacamole List Connections
        call: rest-connections.listconnections
        with:
          dataSource: rest.dataSource
          Guacamole-Token: rest.Guacamole-Token
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconnection
        description: Apache Guacamole Create Connection
        call: rest-connections.createconnection
        with:
          dataSource: rest.dataSource
          Guacamole-Token: rest.Guacamole-Token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/session/data/{datasource}/connections/{connectionid}
      name: api-session-data-datasource-connections-connectionid
      description: REST surface for api-session-data-dataSource-connections-connectionId.
      operations:
      - method: GET
        name: getconnection
        description: Apache Guacamole Get Connection
        call: rest-connections.getconnection
        with:
          dataSource: rest.dataSource
          connectionId: rest.connectionId
          Guacamole-Token: rest.Guacamole-Token
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateconnection
        description: Apache Guacamole Update Connection
        call: rest-connections.updateconnection
        with:
          dataSource: rest.dataSource
          connectionId: rest.connectionId
          Guacamole-Token: rest.Guacamole-Token
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconnection
        description: Apache Guacamole Delete Connection
        call: rest-connections.deleteconnection
        with:
          dataSource: rest.dataSource
          connectionId: rest.connectionId
          Guacamole-Token: rest.Guacamole-Token
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-connections-mcp
    port: 9090
    transport: http
    description: MCP adapter for Apache Guacamole REST API — Connections. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: apache-guacamole-list-connections
      description: Apache Guacamole List Connections
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-connections.listconnections
      with:
        dataSource: tools.dataSource
        Guacamole-Token: tools.Guacamole-Token
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-guacamole-create-connection
      description: Apache Guacamole Create Connection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-connections.createconnection
      with:
        dataSource: tools.dataSource
        Guacamole-Token: tools.Guacamole-Token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-guacamole-get-connection
      description: Apache Guacamole Get Connection
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-connections.getconnection
      with:
        dataSource: tools.dataSource
        connectionId: tools.connectionId
        Guacamole-Token: tools.Guacamole-Token
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-guacamole-update-connection
      description: Apache Guacamole Update Connection
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-connections.updateconnection
      with:
        dataSource: tools.dataSource
        connectionId: tools.connectionId
        Guacamole-Token: tools.Guacamole-Token
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apache-guacamole-delete-connection
      description: Apache Guacamole Delete Connection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-connections.deleteconnection
      with:
        dataSource: tools.dataSource
        connectionId: tools.connectionId
        Guacamole-Token: tools.Guacamole-Token
      outputParameters:
      - type: object
        mapping: $.