OpenProject API V3 (Stable) — Previewing

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Previewing
  description: 'OpenProject API V3 (Stable) — Previewing. 2 operations. Lead operation: Preview Markdown document. Self-contained
    Naftiko capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Previewing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-previewing
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Previewing business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-render-markdown
      path: /api/v3/render/markdown
      operations:
      - name: previewmarkdowndocument
        method: POST
        description: Preview Markdown document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: context
          in: query
          type: string
          description: API-Link to the context in which the rendering occurs, for example a specific work package.
    - name: api-v3-render-plain
      path: /api/v3/render/plain
      operations:
      - name: previewplaindocument
        method: POST
        description: Preview plain document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.OPENPROJECT_USER}}'
      password: '{{env.OPENPROJECT_PASS}}'
  exposes:
  - type: rest
    namespace: openproject-previewing-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Previewing. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/render/markdown
      name: api-v3-render-markdown
      description: REST surface for api-v3-render-markdown.
      operations:
      - method: POST
        name: previewmarkdowndocument
        description: Preview Markdown document
        call: openproject-previewing.previewmarkdowndocument
        with:
          context: rest.context
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/render/plain
      name: api-v3-render-plain
      description: REST surface for api-v3-render-plain.
      operations:
      - method: POST
        name: previewplaindocument
        description: Preview plain document
        call: openproject-previewing.previewplaindocument
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-previewing-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Previewing. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: preview-markdown-document
      description: Preview Markdown document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-previewing.previewmarkdowndocument
      with:
        context: tools.context
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-plain-document
      description: Preview plain document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-previewing.previewplaindocument
      outputParameters:
      - type: object
        mapping: $.