Passbolt API — Favorites

naftiko: 1.0.0-alpha2
info:
  label: Passbolt API — Favorites
  description: 'Passbolt API — Favorites. 2 operations. Lead operation: Unset a resource as favorite.. Self-contained Naftiko
    capability covering one Passbolt business surface.'
  tags:
  - Passbolt
  - Favorites
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PASSBOLT_API_KEY: PASSBOLT_API_KEY
capability:
  consumes:
  - type: http
    namespace: passbolt-favorites
    baseUri: https://passbolt.local
    description: Passbolt API — Favorites business capability. Self-contained, no shared references.
    resources:
    - name: favorite-favoriteId}.json
      path: /favorite/{favoriteId}.json
      operations:
      - name: deletefavorite
        method: DELETE
        description: Unset a resource as favorite.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: favorite-foreignModel-foreignId}.json
      path: /favorite/{foreignModel}/{foreignId}.json
      operations:
      - name: addfavorite
        method: POST
        description: Set a resource as favorite.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PASSBOLT_API_KEY}}'
  exposes:
  - type: rest
    namespace: passbolt-favorites-rest
    port: 8080
    description: REST adapter for Passbolt API — Favorites. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/favorite/favoriteid-json
      name: favorite-favoriteid-json
      description: REST surface for favorite-favoriteId}.json.
      operations:
      - method: DELETE
        name: deletefavorite
        description: Unset a resource as favorite.
        call: passbolt-favorites.deletefavorite
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/favorite/{foreignmodel}/foreignid-json
      name: favorite-foreignmodel-foreignid-json
      description: REST surface for favorite-foreignModel-foreignId}.json.
      operations:
      - method: POST
        name: addfavorite
        description: Set a resource as favorite.
        call: passbolt-favorites.addfavorite
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: passbolt-favorites-mcp
    port: 9090
    transport: http
    description: MCP adapter for Passbolt API — Favorites. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: unset-resource-favorite
      description: Unset a resource as favorite.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: passbolt-favorites.deletefavorite
      outputParameters:
      - type: object
        mapping: $.
    - name: set-resource-favorite
      description: Set a resource as favorite.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: passbolt-favorites.addfavorite
      outputParameters:
      - type: object
        mapping: $.