FakerAPI — Users

naftiko: "1.0.0-alpha2"

info:
  label: "FakerAPI — Users"
  description: >-
    Users — Users. 1 operation. Lead operation: List Fake Users.
    Self-contained Naftiko capability covering one FakerAPI business surface
    for fake application user accounts.
  tags:
    - FakerAPI
    - Test Data
    - Users
  created: "2026-05-30"
  modified: "2026-05-30"

binds: []

capability:

  consumes:
    - type: http
      namespace: "fakerapi-users"
      baseUri: "https://fakerapi.it/api/v1"
      description: "FakerAPI — Users business capability. No authentication required."
      resources:
        - name: "users"
          path: "/users"
          operations:
            - name: "listUsers"
              method: GET
              description: "Return a collection of fake application user accounts."
              inputParameters:
                - name: "_quantity"
                  in: query
                  type: integer
                  required: false
                  description: "Number of records (1-1000, default 10)."
                - name: "_locale"
                  in: query
                  type: string
                  required: false
                  description: "Locale code."
                - name: "_seed"
                  in: query
                  type: integer
                  required: false
                  description: "Integer seed."
                - name: "_gender"
                  in: query
                  type: string
                  required: false
                  description: "Restrict to male or female."
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: "$."

  exposes:
    - type: rest
      namespace: "fakerapi-users-rest"
      port: 8080
      description: "REST adapter for FakerAPI — Users."
      resources:
        - path: "/v1/users"
          name: "users"
          description: "REST surface for fake users."
          operations:
            - method: GET
              name: "listUsers"
              description: "Return a collection of fake application user accounts."
              call: "fakerapi-users.listUsers"
              with:
                "_quantity": "rest._quantity"
                "_locale": "rest._locale"
                "_seed": "rest._seed"
                "_gender": "rest._gender"
              outputParameters:
                - type: object
                  mapping: "$."

    - type: mcp
      namespace: "fakerapi-users-mcp"
      port: 9090
      transport: http
      description: "MCP adapter for FakerAPI — Users."
      tools:
        - name: "list-fake-users"
          description: "Return a collection of fake application user accounts."
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: "fakerapi-users.listUsers"
          with:
            "_quantity": "tools._quantity"
            "_locale": "tools._locale"
            "_seed": "tools._seed"
            "_gender": "tools._gender"
          outputParameters:
            - type: object
              mapping: "$."