Shuffle API — Users

naftiko: 1.0.0-alpha2
info:
  label: Shuffle API — Users
  description: 'Shuffle API — Users. 5 operations. Lead operation: Generate API Key. Self-contained Naftiko capability covering
    one Shuffle business surface.'
  tags:
  - Shuffle
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHUFFLE_API_KEY: SHUFFLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: shuffle-users
    baseUri: https://shuffler.io/api/v1
    description: Shuffle API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users-generateapikey
      path: /users/generateapikey
      operations:
      - name: generateapikey
        method: GET
        description: Generate API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-getusers
      path: /users/getusers
      operations:
      - name: listusers
        method: GET
        description: List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-register
      path: /users/register
      operations:
      - name: registeruser
        method: POST
        description: Register User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-updateuser
      path: /users/updateuser
      operations:
      - name: updateuser
        method: PUT
        description: Update User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-id
      path: /users/{id}
      operations:
      - name: deleteuser
        method: DELETE
        description: Delete User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User ID
          required: true
    authentication:
      type: bearer
      token: '{{env.SHUFFLE_API_KEY}}'
  exposes:
  - type: rest
    namespace: shuffle-users-rest
    port: 8080
    description: REST adapter for Shuffle API — Users. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/users/generateapikey
      name: users-generateapikey
      description: REST surface for users-generateapikey.
      operations:
      - method: GET
        name: generateapikey
        description: Generate API Key
        call: shuffle-users.generateapikey
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/getusers
      name: users-getusers
      description: REST surface for users-getusers.
      operations:
      - method: GET
        name: listusers
        description: List Users
        call: shuffle-users.listusers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/register
      name: users-register
      description: REST surface for users-register.
      operations:
      - method: POST
        name: registeruser
        description: Register User
        call: shuffle-users.registeruser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/updateuser
      name: users-updateuser
      description: REST surface for users-updateuser.
      operations:
      - method: PUT
        name: updateuser
        description: Update User
        call: shuffle-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{id}
      name: users-id
      description: REST surface for users-id.
      operations:
      - method: DELETE
        name: deleteuser
        description: Delete User
        call: shuffle-users.deleteuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shuffle-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shuffle API — Users. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: generate-api-key
      description: Generate API Key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shuffle-users.generateapikey
      outputParameters:
      - type: object
        mapping: $.
    - name: list-users
      description: List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shuffle-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: register-user
      description: Register User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shuffle-users.registeruser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user
      description: Update User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: shuffle-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: shuffle-users.deleteuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.