OpenProject API V3 (Stable) — Principals

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Principals
  description: 'OpenProject API V3 (Stable) — Principals. 11 operations. Lead operation: List placehoder users. Self-contained
    Naftiko capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Principals
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-principals
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Principals business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-placeholder_users
      path: /api/v3/placeholder_users
      operations:
      - name: listplaceholderusers
        method: GET
        description: List placehoder users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters
          in: query
          type: string
          description: JSON specifying filter conditions.
        - name: select
          in: query
          type: string
          description: Comma separated list of properties to include.
      - name: createplaceholderuser
        method: POST
        description: Create placeholder user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v3-placeholder_users-id
      path: /api/v3/placeholder_users/{id}
      operations:
      - name: deleteplaceholderuser
        method: DELETE
        description: Delete placeholder user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Placeholder user id
          required: true
      - name: viewplaceholderuser
        method: GET
        description: View placeholder user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The placeholder user id
          required: true
      - name: updateplaceholderuser
        method: PATCH
        description: Update placeholder user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Placeholder user id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v3-principals
      path: /api/v3/principals
      operations:
      - name: listprincipals
        method: GET
        description: List principals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters
          in: query
          type: string
          description: JSON specifying filter conditions.
        - name: select
          in: query
          type: string
          description: Comma separated list of properties to include.
    - name: api-v3-users
      path: /api/v3/users
      operations:
      - name: listusers
        method: GET
        description: List Users
        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: filters
          in: query
          type: string
          description: JSON specifying filter conditions.
        - name: sortBy
          in: query
          type: string
          description: JSON specifying sort criteria.
        - name: select
          in: query
          type: string
          description: Comma separated list of properties to include.
      - name: createuser
        method: POST
        description: Create User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v3-users-id
      path: /api/v3/users/{id}
      operations:
      - name: deleteuser
        method: DELETE
        description: Delete user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User id. Use `me` to reference current user, if any.
          required: true
      - name: viewuser
        method: GET
        description: View user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User id. Use `me` to reference current user, if any.
          required: true
      - name: updateuser
        method: PATCH
        description: Update user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: User id. Use `me` to reference current user, if any.
          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-principals-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Principals. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/placeholder-users
      name: api-v3-placeholder-users
      description: REST surface for api-v3-placeholder_users.
      operations:
      - method: GET
        name: listplaceholderusers
        description: List placehoder users
        call: openproject-principals.listplaceholderusers
        with:
          filters: rest.filters
          select: rest.select
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createplaceholderuser
        description: Create placeholder user
        call: openproject-principals.createplaceholderuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/placeholder-users/{id}
      name: api-v3-placeholder-users-id
      description: REST surface for api-v3-placeholder_users-id.
      operations:
      - method: DELETE
        name: deleteplaceholderuser
        description: Delete placeholder user
        call: openproject-principals.deleteplaceholderuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: viewplaceholderuser
        description: View placeholder user
        call: openproject-principals.viewplaceholderuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateplaceholderuser
        description: Update placeholder user
        call: openproject-principals.updateplaceholderuser
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/principals
      name: api-v3-principals
      description: REST surface for api-v3-principals.
      operations:
      - method: GET
        name: listprincipals
        description: List principals
        call: openproject-principals.listprincipals
        with:
          filters: rest.filters
          select: rest.select
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/users
      name: api-v3-users
      description: REST surface for api-v3-users.
      operations:
      - method: GET
        name: listusers
        description: List Users
        call: openproject-principals.listusers
        with:
          offset: rest.offset
          pageSize: rest.pageSize
          filters: rest.filters
          sortBy: rest.sortBy
          select: rest.select
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Create User
        call: openproject-principals.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/users/{id}
      name: api-v3-users-id
      description: REST surface for api-v3-users-id.
      operations:
      - method: DELETE
        name: deleteuser
        description: Delete user
        call: openproject-principals.deleteuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: viewuser
        description: View user
        call: openproject-principals.viewuser
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateuser
        description: Update user
        call: openproject-principals.updateuser
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-principals-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Principals. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-placehoder-users
      description: List placehoder users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-principals.listplaceholderusers
      with:
        filters: tools.filters
        select: tools.select
      outputParameters:
      - type: object
        mapping: $.
    - name: create-placeholder-user
      description: Create placeholder user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-principals.createplaceholderuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-placeholder-user
      description: Delete placeholder user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-principals.deleteplaceholderuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: view-placeholder-user
      description: View placeholder user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-principals.viewplaceholderuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-placeholder-user
      description: Update placeholder user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: openproject-principals.updateplaceholderuser
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-principals
      description: List principals
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-principals.listprincipals
      with:
        filters: tools.filters
        select: tools.select
      outputParameters:
      - type: object
        mapping: $.
    - name: list-users
      description: List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-principals.listusers
      with:
        offset: tools.offset
        pageSize: tools.pageSize
        filters: tools.filters
        sortBy: tools.sortBy
        select: tools.select
      outputParameters:
      - type: object
        mapping: $.
    - name: create-user
      description: Create User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-principals.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-principals.deleteuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: view-user
      description: View user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-principals.viewuser
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user
      description: Update user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: openproject-principals.updateuser
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.