Remote API Improvements Page - mrietveld/jbpm GitHub Wiki

HomeRest API Improvements Page
2014-09-30

Overview

There are a lot of medium and minor issues and feature requests with regards to the Remote API.

This page describes the isssues that need to be addressed in 6.1.x.

Among others, see:

Goals

General improvements to both the client side and server side Remote API's

Primary 6.1 goals

  • Thin down client side dependencies as much as possible
  • implement process definition operations
  • low-hanging fruit improvements
  • query operations

Nice-to-have

  • JAXB "data-only" module for REST
  • more difficult improvements to the Remote API
  • Swagger use

Current Status

Sep 30th:

  • JBPM-4178: done (process definition retrieval)
  • BPMSPL-25: done (kie-remote-client now has a tiny footprint)
  • BPMSPL-84: 70% done (operations exist, no real tests.. )

Work Plan

  • query service needs bugfixing and refinement
  • lots of documentation is needed

Deadlines

Community 6.2.0.Final (September, 2014)

Task Breakdown

  • query tests
    • basic unit test in kie-remote-services
    • add integration tests
    • one of the tests should be usable for documentation (examples)
  • Low-hanging fruit
    • Skim bz's, grab easy issues, implement, test, and document!
  • Documentation
    • Add to community (6.1/master!)
    • Inform docs (Vikram) about updates -- where are 6.1 docs located?

Coordination with other teams

  • Inform QE
  • Add documentation to product docs
  • Add documentation to community docs
⚠️ **GitHub.com Fallback** ⚠️