OpenProject API V3 (Stable) — Documents

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Documents
  description: 'OpenProject API V3 (Stable) — Documents. 3 operations. Lead operation: List Documents. Self-contained Naftiko
    capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-documents
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Documents business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-documents
      path: /api/v3/documents
      operations:
      - name: listdocuments
        method: GET
        description: List Documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: offset
          in: query
          type: integer
          description: Page number inside the requested collection.
        - name: pageSize
          in: query
          type: integer
          description: Number of elements to display per page.
        - name: sortBy
          in: query
          type: string
          description: JSON specifying sort criteria.
    - name: api-v3-documents-id
      path: /api/v3/documents/{id}
      operations:
      - name: viewdocument
        method: GET
        description: View document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Document id
          required: true
      - name: updatedocument
        method: PATCH
        description: Update document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Document 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-documents-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/documents
      name: api-v3-documents
      description: REST surface for api-v3-documents.
      operations:
      - method: GET
        name: listdocuments
        description: List Documents
        call: openproject-documents.listdocuments
        with:
          offset: rest.offset
          pageSize: rest.pageSize
          sortBy: rest.sortBy
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/documents/{id}
      name: api-v3-documents-id
      description: REST surface for api-v3-documents-id.
      operations:
      - method: GET
        name: viewdocument
        description: View document
        call: openproject-documents.viewdocument
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedocument
        description: Update document
        call: openproject-documents.updatedocument
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-documents
      description: List Documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-documents.listdocuments
      with:
        offset: tools.offset
        pageSize: tools.pageSize
        sortBy: tools.sortBy
      outputParameters:
      - type: object
        mapping: $.
    - name: view-document
      description: View document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-documents.viewdocument
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-document
      description: Update document
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: openproject-documents.updatedocument
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.