DreamFactory System API — Role

naftiko: 1.0.0-alpha2
info:
  label: DreamFactory System API — Role
  description: 'DreamFactory System API — Role. 5 operations. Lead operation: DreamFactory List roles. Self-contained Naftiko
    capability covering one Dreamfactory business surface.'
  tags:
  - Dreamfactory
  - Role
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DREAMFACTORY_API_KEY: DREAMFACTORY_API_KEY
capability:
  consumes:
  - type: http
    namespace: system-role
    baseUri: https://{instance}/api/v2
    description: DreamFactory System API — Role business capability. Self-contained, no shared references.
    resources:
    - name: system-role
      path: /system/role
      operations:
      - name: listroles
        method: GET
        description: DreamFactory List roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createrole
        method: POST
        description: DreamFactory Create role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: system-role-id
      path: /system/role/{id}
      operations:
      - name: getrole
        method: GET
        description: DreamFactory Get role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updaterole
        method: PATCH
        description: DreamFactory Update role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterole
        method: DELETE
        description: DreamFactory Delete role
        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-role-rest
    port: 8080
    description: REST adapter for DreamFactory System API — Role. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/system/role
      name: system-role
      description: REST surface for system-role.
      operations:
      - method: GET
        name: listroles
        description: DreamFactory List roles
        call: system-role.listroles
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrole
        description: DreamFactory Create role
        call: system-role.createrole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/system/role/{id}
      name: system-role-id
      description: REST surface for system-role-id.
      operations:
      - method: GET
        name: getrole
        description: DreamFactory Get role
        call: system-role.getrole
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updaterole
        description: DreamFactory Update role
        call: system-role.updaterole
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterole
        description: DreamFactory Delete role
        call: system-role.deleterole
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: system-role-mcp
    port: 9090
    transport: http
    description: MCP adapter for DreamFactory System API — Role. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: dreamfactory-list-roles
      description: DreamFactory List roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: system-role.listroles
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-create-role
      description: DreamFactory Create role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: system-role.createrole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-get-role
      description: DreamFactory Get role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: system-role.getrole
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-update-role
      description: DreamFactory Update role
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: system-role.updaterole
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dreamfactory-delete-role
      description: DreamFactory Delete role
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: system-role.deleterole
      outputParameters:
      - type: object
        mapping: $.