DreamFactory System API

naftiko: 1.0.0-alpha2
info:
  label: DreamFactory System API
  description: 'DreamFactory System API. 5 operations. Lead operation: DreamFactory List services. Self-contained Naftiko
    capability covering one Dreamfactory business surface.'
  tags:
  - Dreamfactory
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DREAMFACTORY_API_KEY: DREAMFACTORY_API_KEY
capability:
  consumes:
  - type: http
    namespace: system-general
    baseUri: https://{instance}/api/v2
    description: DreamFactory System API business capability. Self-contained, no shared references.
    resources:
    - name: system-service
      path: /system/service
      operations:
      - name: listservices
        method: GET
        description: DreamFactory List services
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createservice
        method: POST
        description: DreamFactory Create service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: system-service-id
      path: /system/service/{id}
      operations:
      - name: getservice
        method: GET
        description: DreamFactory Get service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateservice
        method: PATCH
        description: DreamFactory Update service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteservice
        method: DELETE
        description: DreamFactory Delete service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-DreamFactory-Session-Token
      value: '{{env.DREAMFACTORY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: system-general-rest
    port: 8080
    description: REST adapter for DreamFactory System API. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/system/service
      name: system-service
      description: REST surface for system-service.
      operations:
      - method: GET
        name: listservices
        description: DreamFactory List services
        call: system-general.listservices
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createservice
        description: DreamFactory Create service
        call: system-general.createservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/service/{id}
      name: system-service-id
      description: REST surface for system-service-id.
      operations:
      - method: GET
        name: getservice
        description: DreamFactory Get service
        call: system-general.getservice
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateservice
        description: DreamFactory Update service
        call: system-general.updateservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteservice
        description: DreamFactory Delete service
        call: system-general.deleteservice
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: system-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for DreamFactory System API. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: dreamfactory-list-services
      description: DreamFactory List services
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: system-general.listservices
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-create-service
      description: DreamFactory Create service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: system-general.createservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-get-service
      description: DreamFactory Get service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: system-general.getservice
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-update-service
      description: DreamFactory Update service
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: system-general.updateservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-delete-service
      description: DreamFactory Delete service
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: system-general.deleteservice
      outputParameters:
      - type: object
        mapping: $.