OpenProject API V3 (Stable)

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable)
  description: 'OpenProject API V3 (Stable). 3 operations. Lead operation: Get a custom field hierarchy item. Self-contained
    Naftiko capability covering one Openproject business surface.'
  tags:
  - Openproject
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-general
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-custom_field_items-id
      path: /api/v3/custom_field_items/{id}
      operations:
      - name: getcustomfielditem
        method: GET
        description: Get a custom field hierarchy item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The custom field item's unique identifier
          required: true
    - name: api-v3-custom_field_items-id-branch
      path: /api/v3/custom_field_items/{id}/branch
      operations:
      - name: getcustomfielditembranch
        method: GET
        description: Get a custom field hierarchy item's branch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The custom field item's unique identifier
          required: true
    - name: api-v3-custom_fields-id-items
      path: /api/v3/custom_fields/{id}/items
      operations:
      - name: getcustomfielditems
        method: GET
        description: Get the custom field hierarchy items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The custom field's unique identifier
          required: true
        - name: parent
          in: query
          type: integer
          description: The identifier of the parent hierarchy item
        - name: depth
          in: query
          type: integer
          description: The level of hierarchy depth
    authentication:
      type: basic
      username: '{{env.OPENPROJECT_USER}}'
      password: '{{env.OPENPROJECT_PASS}}'
  exposes:
  - type: rest
    namespace: openproject-general-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable). One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/v3/custom-field-items/{id}
      name: api-v3-custom-field-items-id
      description: REST surface for api-v3-custom_field_items-id.
      operations:
      - method: GET
        name: getcustomfielditem
        description: Get a custom field hierarchy item
        call: openproject-general.getcustomfielditem
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/custom-field-items/{id}/branch
      name: api-v3-custom-field-items-id-branch
      description: REST surface for api-v3-custom_field_items-id-branch.
      operations:
      - method: GET
        name: getcustomfielditembranch
        description: Get a custom field hierarchy item's branch
        call: openproject-general.getcustomfielditembranch
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/custom-fields/{id}/items
      name: api-v3-custom-fields-id-items
      description: REST surface for api-v3-custom_fields-id-items.
      operations:
      - method: GET
        name: getcustomfielditems
        description: Get the custom field hierarchy items
        call: openproject-general.getcustomfielditems
        with:
          id: rest.id
          parent: rest.parent
          depth: rest.depth
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable). One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-custom-field-hierarchy-item
      description: Get a custom field hierarchy item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-general.getcustomfielditem
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-field-hierarchy-item-s
      description: Get a custom field hierarchy item's branch
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-general.getcustomfielditembranch
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-custom-field-hierarchy-items
      description: Get the custom field hierarchy items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-general.getcustomfielditems
      with:
        id: tools.id
        parent: tools.parent
        depth: tools.depth
      outputParameters:
      - type: object
        mapping: $.