OpenProject API V3 (Stable) — Portfolios

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Portfolios
  description: 'OpenProject API V3 (Stable) — Portfolios. 5 operations. Lead operation: List portfolios. Self-contained Naftiko
    capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Portfolios
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-portfolios
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Portfolios business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-portfolios
      path: /api/v3/portfolios
      operations:
      - name: listportfolios
        method: GET
        description: List portfolios
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters
          in: query
          type: string
          description: JSON specifying filter conditions.
        - name: sortBy
          in: query
          type: string
          description: JSON specifying sort criteria.
        - name: select
          in: query
          type: string
          description: Comma separated list of properties to include.
    - name: api-v3-portfolios-id
      path: /api/v3/portfolios/{id}
      operations:
      - name: viewportfolio
        method: GET
        description: View portfolio
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Portfolio id
          required: true
      - name: updateportfolio
        method: PATCH
        description: Update Portfolio
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Portfolio id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteportfolio
        method: DELETE
        description: Delete Portfolio
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Portfolio id
          required: true
    - name: api-v3-portfolios-id-form
      path: /api/v3/portfolios/{id}/form
      operations:
      - name: portfolioupdateform
        method: POST
        description: Portfolio update form
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Portfolio id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.OPENPROJECT_USER}}'
      password: '{{env.OPENPROJECT_PASS}}'
  exposes:
  - type: rest
    namespace: openproject-portfolios-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Portfolios. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/portfolios
      name: api-v3-portfolios
      description: REST surface for api-v3-portfolios.
      operations:
      - method: GET
        name: listportfolios
        description: List portfolios
        call: openproject-portfolios.listportfolios
        with:
          filters: rest.filters
          sortBy: rest.sortBy
          select: rest.select
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/portfolios/{id}
      name: api-v3-portfolios-id
      description: REST surface for api-v3-portfolios-id.
      operations:
      - method: GET
        name: viewportfolio
        description: View portfolio
        call: openproject-portfolios.viewportfolio
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateportfolio
        description: Update Portfolio
        call: openproject-portfolios.updateportfolio
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteportfolio
        description: Delete Portfolio
        call: openproject-portfolios.deleteportfolio
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/portfolios/{id}/form
      name: api-v3-portfolios-id-form
      description: REST surface for api-v3-portfolios-id-form.
      operations:
      - method: POST
        name: portfolioupdateform
        description: Portfolio update form
        call: openproject-portfolios.portfolioupdateform
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-portfolios-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Portfolios. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-portfolios
      description: List portfolios
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-portfolios.listportfolios
      with:
        filters: tools.filters
        sortBy: tools.sortBy
        select: tools.select
      outputParameters:
      - type: object
        mapping: $.
    - name: view-portfolio
      description: View portfolio
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-portfolios.viewportfolio
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-portfolio
      description: Update Portfolio
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: openproject-portfolios.updateportfolio
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-portfolio
      description: Delete Portfolio
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-portfolios.deleteportfolio
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: portfolio-update-form
      description: Portfolio update form
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-portfolios.portfolioupdateform
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.