OpenProject API V3 (Stable) — Favorites

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Favorites
  description: 'OpenProject API V3 (Stable) — Favorites. 4 operations. Lead operation: Unfavorite Project. Self-contained
    Naftiko capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Favorites
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-favorites
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Favorites business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-projects-id-favorite
      path: /api/v3/projects/{id}/favorite
      operations:
      - name: unfavoriteproject
        method: DELETE
        description: Unfavorite Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Project id
          required: true
      - name: favoriteproject
        method: POST
        description: Favorite Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Project id
          required: true
    - name: api-v3-workspaces-id-favorite
      path: /api/v3/workspaces/{id}/favorite
      operations:
      - name: unfavoriteworkspace
        method: DELETE
        description: Unfavorite Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Workspace id
          required: true
      - name: favoriteworkspace
        method: POST
        description: Favorite Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Workspace id
          required: true
    authentication:
      type: basic
      username: '{{env.OPENPROJECT_USER}}'
      password: '{{env.OPENPROJECT_PASS}}'
  exposes:
  - type: rest
    namespace: openproject-favorites-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Favorites. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/projects/{id}/favorite
      name: api-v3-projects-id-favorite
      description: REST surface for api-v3-projects-id-favorite.
      operations:
      - method: DELETE
        name: unfavoriteproject
        description: Unfavorite Project
        call: openproject-favorites.unfavoriteproject
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: favoriteproject
        description: Favorite Project
        call: openproject-favorites.favoriteproject
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/workspaces/{id}/favorite
      name: api-v3-workspaces-id-favorite
      description: REST surface for api-v3-workspaces-id-favorite.
      operations:
      - method: DELETE
        name: unfavoriteworkspace
        description: Unfavorite Workspace
        call: openproject-favorites.unfavoriteworkspace
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: favoriteworkspace
        description: Favorite Workspace
        call: openproject-favorites.favoriteworkspace
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-favorites-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Favorites. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: unfavorite-project
      description: Unfavorite Project
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-favorites.unfavoriteproject
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: favorite-project
      description: Favorite Project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-favorites.favoriteproject
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: unfavorite-workspace
      description: Unfavorite Workspace
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-favorites.unfavoriteworkspace
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: favorite-workspace
      description: Favorite Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-favorites.favoriteworkspace
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.