OpenProject API V3 (Stable) — Versions

naftiko: 1.0.0-alpha2
info:
  label: OpenProject API V3 (Stable) — Versions
  description: 'OpenProject API V3 (Stable) — Versions. 11 operations. Lead operation: List versions available in a project.
    Self-contained Naftiko capability covering one Openproject business surface.'
  tags:
  - Openproject
  - Versions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENPROJECT_API_KEY: OPENPROJECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: openproject-versions
    baseUri: https://qa.openproject-edge.com
    description: OpenProject API V3 (Stable) — Versions business capability. Self-contained, no shared references.
    resources:
    - name: api-v3-projects-id-versions
      path: /api/v3/projects/{id}/versions
      operations:
      - name: listversionsavailableinaproject
        method: GET
        description: List versions available in a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: ID of the project whose versions will be listed
          required: true
    - name: api-v3-versions
      path: /api/v3/versions
      operations:
      - name: listversions
        method: GET
        description: List versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters
          in: query
          type: string
          description: JSON specifying filter conditions. Accepts the same format as returned by
        - name: sortBy
          in: query
          type: string
          description: JSON specifying sort criteria. Accepts the same format as returned by
      - name: createversion
        method: POST
        description: Create version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v3-versions-available_projects
      path: /api/v3/versions/available_projects
      operations:
      - name: availableprojectsforversions
        method: GET
        description: Available projects for versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v3-versions-form
      path: /api/v3/versions/form
      operations:
      - name: versioncreateform
        method: POST
        description: Version create form
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v3-versions-schema
      path: /api/v3/versions/schema
      operations:
      - name: viewversionschema
        method: GET
        description: View version schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v3-versions-id
      path: /api/v3/versions/{id}
      operations:
      - name: getversion
        method: GET
        description: Get version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Version id
          required: true
      - name: deleteversion
        method: DELETE
        description: Delete version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Version id
          required: true
      - name: updateversion
        method: PATCH
        description: Update Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Version id
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v3-versions-id-form
      path: /api/v3/versions/{id}/form
      operations:
      - name: versionupdateform
        method: POST
        description: Version update form
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: Project id
          required: true
    - name: api-v3-workspaces-id-versions
      path: /api/v3/workspaces/{id}/versions
      operations:
      - name: listversionsavailableinaworkspace
        method: GET
        description: List versions available in a workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: ID of the workspace whose versions will be listed
          required: true
    authentication:
      type: basic
      username: '{{env.OPENPROJECT_USER}}'
      password: '{{env.OPENPROJECT_PASS}}'
  exposes:
  - type: rest
    namespace: openproject-versions-rest
    port: 8080
    description: REST adapter for OpenProject API V3 (Stable) — Versions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v3/projects/{id}/versions
      name: api-v3-projects-id-versions
      description: REST surface for api-v3-projects-id-versions.
      operations:
      - method: GET
        name: listversionsavailableinaproject
        description: List versions available in a project
        call: openproject-versions.listversionsavailableinaproject
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/versions
      name: api-v3-versions
      description: REST surface for api-v3-versions.
      operations:
      - method: GET
        name: listversions
        description: List versions
        call: openproject-versions.listversions
        with:
          filters: rest.filters
          sortBy: rest.sortBy
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createversion
        description: Create version
        call: openproject-versions.createversion
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/versions/available-projects
      name: api-v3-versions-available-projects
      description: REST surface for api-v3-versions-available_projects.
      operations:
      - method: GET
        name: availableprojectsforversions
        description: Available projects for versions
        call: openproject-versions.availableprojectsforversions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/versions/form
      name: api-v3-versions-form
      description: REST surface for api-v3-versions-form.
      operations:
      - method: POST
        name: versioncreateform
        description: Version create form
        call: openproject-versions.versioncreateform
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/versions/schema
      name: api-v3-versions-schema
      description: REST surface for api-v3-versions-schema.
      operations:
      - method: GET
        name: viewversionschema
        description: View version schema
        call: openproject-versions.viewversionschema
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/versions/{id}
      name: api-v3-versions-id
      description: REST surface for api-v3-versions-id.
      operations:
      - method: GET
        name: getversion
        description: Get version
        call: openproject-versions.getversion
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteversion
        description: Delete version
        call: openproject-versions.deleteversion
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateversion
        description: Update Version
        call: openproject-versions.updateversion
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/versions/{id}/form
      name: api-v3-versions-id-form
      description: REST surface for api-v3-versions-id-form.
      operations:
      - method: POST
        name: versionupdateform
        description: Version update form
        call: openproject-versions.versionupdateform
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v3/workspaces/{id}/versions
      name: api-v3-workspaces-id-versions
      description: REST surface for api-v3-workspaces-id-versions.
      operations:
      - method: GET
        name: listversionsavailableinaworkspace
        description: List versions available in a workspace
        call: openproject-versions.listversionsavailableinaworkspace
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: openproject-versions-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenProject API V3 (Stable) — Versions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-versions-available-project
      description: List versions available in a project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-versions.listversionsavailableinaproject
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-versions
      description: List versions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-versions.listversions
      with:
        filters: tools.filters
        sortBy: tools.sortBy
      outputParameters:
      - type: object
        mapping: $.
    - name: create-version
      description: Create version
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-versions.createversion
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: available-projects-versions
      description: Available projects for versions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-versions.availableprojectsforversions
      outputParameters:
      - type: object
        mapping: $.
    - name: version-create-form
      description: Version create form
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-versions.versioncreateform
      outputParameters:
      - type: object
        mapping: $.
    - name: view-version-schema
      description: View version schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-versions.viewversionschema
      outputParameters:
      - type: object
        mapping: $.
    - name: get-version
      description: Get version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-versions.getversion
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-version
      description: Delete version
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: openproject-versions.deleteversion
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-version
      description: Update Version
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: openproject-versions.updateversion
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: version-update-form
      description: Version update form
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: openproject-versions.versionupdateform
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: list-versions-available-workspace
      description: List versions available in a workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: openproject-versions.listversionsavailableinaworkspace
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.