OpenProject API V3 (Stable) — Help texts

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Help texts
  description: 'OpenProject API V3 (Stable) — Help texts. 2 operations. Lead operation: List help texts. Self-contained Naftiko
    capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Help texts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-help-texts
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Help texts business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-help_texts
      path: /api/v3/help_texts
      operations:
      - name: listhelptexts
        method: GET
        description: List help texts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v3-help_texts-id
      path: /api/v3/help_texts/{id}
      operations:
      - name: gethelptext
        method: GET
        description: Get help text
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Help text id
          required: true
    authentication:
      type: basic
      username: '{{env.OPENPROJECT_USER}}'
      password: '{{env.OPENPROJECT_PASS}}'
  exposes:
  - type: rest
    namespace: openproject-help-texts-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Help texts. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/help-texts
      name: api-v3-help-texts
      description: REST surface for api-v3-help_texts.
      operations:
      - method: GET
        name: listhelptexts
        description: List help texts
        call: openproject-help-texts.listhelptexts
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/help-texts/{id}
      name: api-v3-help-texts-id
      description: REST surface for api-v3-help_texts-id.
      operations:
      - method: GET
        name: gethelptext
        description: Get help text
        call: openproject-help-texts.gethelptext
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-help-texts-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Help texts. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-help-texts
      description: List help texts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-help-texts.listhelptexts
      outputParameters:
      - type: object
        mapping: $.
    - name: get-help-text
      description: Get help text
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-help-texts.gethelptext
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.