Freestyle Web Deployments API — Deployments

naftiko: 1.0.0-alpha2
info:
  label: "Freestyle Web Deployments API \u2014 Deployments"
  description: 'Freestyle Web Deployments API deployments surface. 8 operations. Lead operation: Deploy a Website. Self-contained
    Naftiko capability for one Freestyle business surface.'
  tags:
  - Freestyle
  - Web
  - Deployments
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    FREESTYLE_API_KEY: FREESTYLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: web-deployments
    baseUri: https://api.freestyle.sh
    description: Freestyle Web Deployments API deployments business capability.
    resources:
    - name: web-v1-deployment
      path: /web/v1/deployment
      operations:
      - name: handle-deploy-web-v2
        method: POST
        description: Deploy a Website
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: web-v1-deployments
      path: /web/v1/deployments
      operations:
      - name: handle-list-web-deploys
        method: GET
        description: List Web Deploys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: string
          required: true
        - name: offset
          in: query
          type: string
          required: true
        - name: search
          in: query
          type: string
          required: true
    - name: web-v1-deployments
      path: /web/v1/deployments/{deployment_id}
      operations:
      - name: handle-get-web-deploy-details
        method: GET
        description: Get Information on Web Deploy
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deployment_id
          in: path
          type: string
          required: true
    - name: web-v1-deployments-fetch
      path: /web/v1/deployments/{deployment_id}/fetch
      operations:
      - name: handle-fetch-deployment
        method: GET
        description: Fetch Content From a Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deployment_id
          in: path
          type: string
          required: true
      - name: handle-fetch-deployment
        method: PUT
        description: Fetch Content From a Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deployment_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: handle-fetch-deployment
        method: POST
        description: Fetch Content From a Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deployment_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: handle-fetch-deployment
        method: DELETE
        description: Fetch Content From a Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deployment_id
          in: path
          type: string
          required: true
      - name: handle-fetch-deployment
        method: PATCH
        description: Fetch Content From a Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deployment_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: Bearer {{env.FREESTYLE_API_KEY}}
      placement: header
  exposes:
  - type: rest
    namespace: web-deployments-rest
    port: 8080
    description: REST adapter for Freestyle Web Deployments API deployments. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/web/v1/deployment
      name: web-v1-deployment
      description: REST surface for web-v1-deployment.
      operations:
      - method: POST
        name: handle-deploy-web-v2
        description: Deploy a Website
        call: web-deployments.handle-deploy-web-v2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/web/v1/deployments
      name: web-v1-deployments
      description: REST surface for web-v1-deployments.
      operations:
      - method: GET
        name: handle-list-web-deploys
        description: List Web Deploys
        call: web-deployments.handle-list-web-deploys
        with: {}
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/web/v1/deployments/{deployment_id}
      name: web-v1-deployments
      description: REST surface for web-v1-deployments.
      operations:
      - method: GET
        name: handle-get-web-deploy-details
        description: Get Information on Web Deploy
        call: web-deployments.handle-get-web-deploy-details
        with:
          deployment_id: rest.path.deployment_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/web/v1/deployments/{deployment_id}/fetch
      name: web-v1-deployments-fetch
      description: REST surface for web-v1-deployments-fetch.
      operations:
      - method: GET
        name: handle-fetch-deployment
        description: Fetch Content From a Deployment
        call: web-deployments.handle-fetch-deployment
        with:
          deployment_id: rest.path.deployment_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: handle-fetch-deployment
        description: Fetch Content From a Deployment
        call: web-deployments.handle-fetch-deployment
        with:
          deployment_id: rest.path.deployment_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: handle-fetch-deployment
        description: Fetch Content From a Deployment
        call: web-deployments.handle-fetch-deployment
        with:
          deployment_id: rest.path.deployment_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: handle-fetch-deployment
        description: Fetch Content From a Deployment
        call: web-deployments.handle-fetch-deployment
        with:
          deployment_id: rest.path.deployment_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: handle-fetch-deployment
        description: Fetch Content From a Deployment
        call: web-deployments.handle-fetch-deployment
        with:
          deployment_id: rest.path.deployment_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: web-deployments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Freestyle Web Deployments API deployments. One tool per consumed operation.
    tools:
    - name: freestyle-handle-deploy-web-v2
      description: Deploy a Website
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: web-deployments.handle-deploy-web-v2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-list-web-deploys
      description: List Web Deploys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-deployments.handle-list-web-deploys
      with: {}
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-get-web-deploy-details
      description: Get Information on Web Deploy
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-deployments.handle-get-web-deploy-details
      with:
        deployment_id: tools.path.deployment_id
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-fetch-deployment
      description: Fetch Content From a Deployment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-deployments.handle-fetch-deployment
      with:
        deployment_id: tools.path.deployment_id
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-fetch-deployment
      description: Fetch Content From a Deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: web-deployments.handle-fetch-deployment
      with:
        deployment_id: tools.path.deployment_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-fetch-deployment
      description: Fetch Content From a Deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: web-deployments.handle-fetch-deployment
      with:
        deployment_id: tools.path.deployment_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-fetch-deployment
      description: Fetch Content From a Deployment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: web-deployments.handle-fetch-deployment
      with:
        deployment_id: tools.path.deployment_id
      outputParameters:
      - type: object
        mapping: $.
    - name: freestyle-handle-fetch-deployment
      description: Fetch Content From a Deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: web-deployments.handle-fetch-deployment
      with:
        deployment_id: tools.path.deployment_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.