apache / apache/polaris

Remove `entityVersion` from public APIs

Open
#556 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Java
Stars
2.1k
Forks
522
Avg merge
1d 17h
Merged PRs (30d)
137

Description

### Describe the bug

`polaris-management-service.yml` uses a simple `entityVersion` approach to validate whether some update request, which includes the _full_ representation of the entity to be updated, can be performed or not.

The approach to be able to update a whole entity should be replaced with specific update operations per entity type. This is much easier to validate in service implementations and easier to understand from a client's point of view.

Contributor guide

Open the contributing guide

Research direction

Start with polaris-management-service.yml and trace the service implementations that use the entityVersion update approach. Identify the entity-specific update operations required to replace whole-entity updates, and verify that the public API definitions and implementations no longer depend on entityVersion.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, yaml
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.