feat(api): partial schema insertion

[thegeekywanderer]

Problem Statement

As development teams regularly roll out new API endpoints, features each addition often necessitates corresponding updates to the schema. The current procedure, which requires comprehensive schema re-uploads for any modification, has proven to be inefficient and not conducive to rapid development cycles. There is an essential need for a more refined update mechanism that supports iterative and incremental schema modifications, allowing teams to make precise changes with minimal disruption.

Request Payload Structure

PATCH /v1/{tenant_id}/schemas/partial-write

{
  "metadata": {
    "schema_version": ""
  },
  "entities": {
    "entity-name": {
        "write": [],
        "delete": [],
        "update": [],
    }
}

Behavior Description

When the schema_version in the request metadata is left empty, the system will default to using the latest(head) schema version as the base for updates.

• name (string): The name of the entity to be changed.
• write (string array): Conditions to be added. If a relation or permission/action already exists, it should return an error.
• delete (string array): Names (permissions/actions) to be deleted. If the relation/permission/action name does not exist, it should return an error. Note: specifying the name is enough as relation/permission/action names should be unique.
• update (string array): Conditions to be updated.

If schema_version is specified, the endpoint will perform the same update process on the given version and generate a new version thereafter.

[lekhanhtoan37]

Any update?
I think usecase update schema is very important in real world.

[thegeekywanderer]

Hi @lekhanhtoan37, We are working on this on priority. We realised that this approach was not the best and causing quite a few anti patterns hence its taking some time. Should be done by next week hopefully.