OpenProject API V3 (Stable) — Programs

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Programs
  description: 'OpenProject API V3 (Stable) — Programs. 5 operations. Lead operation: List programs. Self-contained Naftiko
    capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Programs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-programs
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Programs business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-programs
      path: /api/v3/programs
      operations:
      - name: listprograms
        method: GET
        description: List programs
        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-programs-id
      path: /api/v3/programs/{id}
      operations:
      - name: viewprogram
        method: GET
        description: View program
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Program id
          required: true
      - name: updateprogram
        method: PATCH
        description: Update Program
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Program id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteprogram
        method: DELETE
        description: Delete Program
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Program id
          required: true
    - name: api-v3-programs-id-form
      path: /api/v3/programs/{id}/form
      operations:
      - name: programupdateform
        method: POST
        description: Program update form
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Program 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-programs-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Programs. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/programs
      name: api-v3-programs
      description: REST surface for api-v3-programs.
      operations:
      - method: GET
        name: listprograms
        description: List programs
        call: openproject-programs.listprograms
        with:
          filters: rest.filters
          sortBy: rest.sortBy
          select: rest.select
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/programs/{id}
      name: api-v3-programs-id
      description: REST surface for api-v3-programs-id.
      operations:
      - method: GET
        name: viewprogram
        description: View program
        call: openproject-programs.viewprogram
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateprogram
        description: Update Program
        call: openproject-programs.updateprogram
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteprogram
        description: Delete Program
        call: openproject-programs.deleteprogram
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/programs/{id}/form
      name: api-v3-programs-id-form
      description: REST surface for api-v3-programs-id-form.
      operations:
      - method: POST
        name: programupdateform
        description: Program update form
        call: openproject-programs.programupdateform
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-programs-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Programs. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-programs
      description: List programs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-programs.listprograms
      with:
        filters: tools.filters
        sortBy: tools.sortBy
        select: tools.select
      outputParameters:
      - type: object
        mapping: $.
    - name: view-program
      description: View program
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-programs.viewprogram
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-program
      description: Update Program
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: openproject-programs.updateprogram
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-program
      description: Delete Program
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-programs.deleteprogram
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: program-update-form
      description: Program update form
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-programs.programupdateform
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.