OpenProject API V3 (Stable) — Custom actions

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Custom actions
  description: 'OpenProject API V3 (Stable) — Custom actions. 2 operations. Lead operation: Get a custom action. Self-contained
    Naftiko capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Custom actions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-custom-actions
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Custom actions business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-custom_actions-id
      path: /api/v3/custom_actions/{id}
      operations:
      - name: getcustomaction
        method: GET
        description: Get a custom action
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The id of the custom action to fetch
          required: true
    - name: api-v3-custom_actions-id-execute
      path: /api/v3/custom_actions/{id}/execute
      operations:
      - name: executecustomaction
        method: POST
        description: Execute custom action
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The id of the custom action to execute
          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-custom-actions-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Custom actions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/v3/custom-actions/{id}
      name: api-v3-custom-actions-id
      description: REST surface for api-v3-custom_actions-id.
      operations:
      - method: GET
        name: getcustomaction
        description: Get a custom action
        call: openproject-custom-actions.getcustomaction
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/custom-actions/{id}/execute
      name: api-v3-custom-actions-id-execute
      description: REST surface for api-v3-custom_actions-id-execute.
      operations:
      - method: POST
        name: executecustomaction
        description: Execute custom action
        call: openproject-custom-actions.executecustomaction
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-custom-actions-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Custom actions. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-custom-action
      description: Get a custom action
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-custom-actions.getcustomaction
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: execute-custom-action
      description: Execute custom action
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-custom-actions.executecustomaction
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.