OpenProject API V3 (Stable) — Roles

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