Salesforce Experience Cloud Salesforce User Interface API — Favorites

naftiko: 1.0.0-alpha2
info:
  label: Salesforce Experience Cloud Salesforce User Interface API — Favorites
  description: 'Salesforce Experience Cloud Salesforce User Interface API — Favorites. 3 operations. Lead operation: Salesforce
    Experience Cloud Get Favorites. Self-contained Naftiko capability covering one Salesforce Experience Cloud business surface.'
  tags:
  - Salesforce Experience Cloud
  - Favorites
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SALESFORCE_EXPERIENCE_CLOUD_API_KEY: SALESFORCE_EXPERIENCE_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: user-interface-favorites
    baseUri: https://{instance}.salesforce.com/services/data/v59.0/ui-api
    description: Salesforce Experience Cloud Salesforce User Interface API — Favorites business capability. Self-contained,
      no shared references.
    resources:
    - name: favorites
      path: /favorites
      operations:
      - name: getfavorites
        method: GET
        description: Salesforce Experience Cloud Get Favorites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addfavorite
        method: POST
        description: Salesforce Experience Cloud Add a Favorite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: favorites-favoriteId
      path: /favorites/{favoriteId}
      operations:
      - name: removefavorite
        method: DELETE
        description: Salesforce Experience Cloud Remove a Favorite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: favoriteId
          in: path
          type: string
          description: The ID of the favorite to remove
          required: true
    authentication:
      type: bearer
      token: '{{env.SALESFORCE_EXPERIENCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: user-interface-favorites-rest
    port: 8080
    description: REST adapter for Salesforce Experience Cloud Salesforce User Interface API — Favorites. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/favorites
      name: favorites
      description: REST surface for favorites.
      operations:
      - method: GET
        name: getfavorites
        description: Salesforce Experience Cloud Get Favorites
        call: user-interface-favorites.getfavorites
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addfavorite
        description: Salesforce Experience Cloud Add a Favorite
        call: user-interface-favorites.addfavorite
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/favorites/{favoriteid}
      name: favorites-favoriteid
      description: REST surface for favorites-favoriteId.
      operations:
      - method: DELETE
        name: removefavorite
        description: Salesforce Experience Cloud Remove a Favorite
        call: user-interface-favorites.removefavorite
        with:
          favoriteId: rest.favoriteId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: user-interface-favorites-mcp
    port: 9090
    transport: http
    description: MCP adapter for Salesforce Experience Cloud Salesforce User Interface API — Favorites. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: salesforce-experience-cloud-get-favorites
      description: Salesforce Experience Cloud Get Favorites
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: user-interface-favorites.getfavorites
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-experience-cloud-add-favorite
      description: Salesforce Experience Cloud Add a Favorite
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: user-interface-favorites.addfavorite
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: salesforce-experience-cloud-remove-favorite
      description: Salesforce Experience Cloud Remove a Favorite
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: user-interface-favorites.removefavorite
      with:
        favoriteId: tools.favoriteId
      outputParameters:
      - type: object
        mapping: $.