naftiko: 1.0.0-alpha2
info:
  label: Miro Developer Platform — User
  description: 'Miro Developer Platform — User. 6 operations. Lead operation: List users. Self-contained Naftiko capability
    covering one Miro business surface.'
  tags:
  - Miro
  - User
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MIRO_API_KEY: MIRO_API_KEY
capability:
  consumes:
  - type: http
    namespace: miro-user
    baseUri: https://api.miro.com
    description: Miro Developer Platform — User business capability. Self-contained, no shared references.
    resources:
    - name: Users
      path: /Users
      operations:
      - name: listusers
        method: GET
        description: List users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attributes
          in: query
          type: string
          description: 'A comma-separated list of attribute names to return in the response. <br><br> Example attributes:
            id, userName, displayName, name, userType, active, emails, pho'
        - name: filter
          in: query
          type: string
          description: You can request a subset of resources by specifying the filter query parameter containing a filter
            expression. Attribute names and attribute operators used in f
        - name: startIndex
          in: query
          type: integer
          description: 'Use startIndex in combination with count query parameters to receive paginated results. <br><br> start
            index is 1-based. <br><br> Example: startIndex=1'
        - name: count
          in: query
          type: integer
          description: Specifies the maximum number of query results per page. <br><br> Use count in combination with startIndex
            query parameters to receive paginated results. <br><br
        - name: sortBy
          in: query
          type: string
          description: 'Specifies the attribute whose value will be used to order the response. <br><br> Example: sortBy=userName,
            sortBy=emails.value'
        - name: sortOrder
          in: query
          type: string
          description: 'Defines the order in which the sortBy parameter is applied. <br><br> Example: sortOrder=ascending'
      - name: createuser
        method: POST
        description: Create 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: getuser
        method: GET
        description: Get user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User ID of the user to be retrieved
          required: true
        - name: attributes
          in: query
          type: string
          description: A comma-separated list of attribute names to return in the response. <br><br> <br>Example attributes</b>
            - id, userName, displayName, name, userType, active, em
      - name: replaceuser
        method: PUT
        description: Replace user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User ID. A server-assigned, unique identifier for this user.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: patchuser
        method: PATCH
        description: Patch user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User ID. A server-assigned, unique identifier for this user.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - 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. A server-assigned, unique identifier for this user.
          required: true
    authentication:
      type: bearer
      token: '{{env.MIRO_API_KEY}}'
  exposes:
  - type: rest
    namespace: miro-user-rest
    port: 8080
    description: REST adapter for Miro Developer Platform — User. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for Users.
      operations:
      - method: GET
        name: listusers
        description: List users
        call: miro-user.listusers
        with:
          attributes: rest.attributes
          filter: rest.filter
          startIndex: rest.startIndex
          count: rest.count
          sortBy: rest.sortBy
          sortOrder: rest.sortOrder
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Create user
        call: miro-user.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{id}
      name: users-id
      description: REST surface for Users-id.
      operations:
      - method: GET
        name: getuser
        description: Get user
        call: miro-user.getuser
        with:
          id: rest.id
          attributes: rest.attributes
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replaceuser
        description: Replace user
        call: miro-user.replaceuser
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchuser
        description: Patch user
        call: miro-user.patchuser
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Delete user
        call: miro-user.deleteuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: miro-user-mcp
    port: 9090
    transport: http
    description: MCP adapter for Miro Developer Platform — User. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-users
      description: List users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: miro-user.listusers
      with:
        attributes: tools.attributes
        filter: tools.filter
        startIndex: tools.startIndex
        count: tools.count
        sortBy: tools.sortBy
        sortOrder: tools.sortOrder
      outputParameters:
      - type: object
        mapping: $.
    - name: create-user
      description: Create user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: miro-user.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user
      description: Get user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: miro-user.getuser
      with:
        id: tools.id
        attributes: tools.attributes
      outputParameters:
      - type: object
        mapping: $.
    - name: replace-user
      description: Replace user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: miro-user.replaceuser
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-user
      description: Patch user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: miro-user.patchuser
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: miro-user.deleteuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.