OHDSI / OHDSI/WebAPI

WebAPI 3.0 Change List

Open
#2,354 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
151
Forks
183
Avg merge
14m
Merged PRs (30d)
2

Description

Starting this thread to capture WebAPI 3.0 proposed changes New suggestions can be raised in comments and those that make sense can be promoted up to the top thread. This list is not exhaustive but is geared towards the changes that would alter existing functionality in a backwards-breaking change (hence the 3.0 version bump).

Major Version Changes
  1. Update JDK to JDK 17+
  2. Security is no longer optional
  3. Permission Rewrite
  4. Update Java Libraries to Latest Versions
  5. Caching Implementation
  6. Analysis Execution Pipeline via Strategus (including new Analysis Designs deprecating old)
  7. Refresh Flyway Migrations: Remove old non-supported Flyway Migrations
  8. Maven Dependency Management
  9. Remove outdated endpoints that don't have function.
  10. Make necessary changes to support multi-homed (ie: load-balanced) configuration
  11. Leverage websockets to faciliate server-side changes (ie: polling for cohort generation status)
  12. Integrated runtime statistics (time spent in queries, time spent processing results, cache hits/misses) so we can understand runtime dynamics.
  13. Move away from storing execution status in job table.
Notes

This section captures notes about items in the above list, as well as reasons why something is not in the list.

  1. Module System: There has been discussion about making WebAPI more modular to support customization. While this is something that could be discussed as a 3.x feature, it's not something that currently exists in 2.x. This Issue is focusing on current functionality that changes in a backwards-breaking way. A better approach implementing modules (or miicro services) would be to start a new project with that architecture in mind).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

This issue is a planning thread covering multiple WebAPI 3.0 changes, but it names no files, tests, or entry points. Start by breaking the list into separately scoped issues and locating the existing permission, caching, migration, execution, and endpoint components; completion criteria are not defined here.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend, databases, infrastructure, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
10/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.