Endpoint Definition
/v1/{tenant_id}/schemas/partial-write
This endpoint allows authorized users to make partial updates to the schema by adding or modifying actions within individual entities.
Request Payload Structure
Behavior Description
When theschema_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.
schema_version
is specified, the endpoint will perform the same update process on the given version and generate a new version thereafter.
Partial Schema Endpoint Example Usage
Existing Schema
user
, organization
, and team
entities. This includes their respective relationships and permissions within the schema.
Partial Schema Update Request
To update theteam
entity by introducing new permissions, the following PATCH request with the accompanying payload is sent:
schema_version
empty string, it signals the system to take the latest(head) schema version as a base for applying updates.
Resulting Schema After Update
After the request is processed, the system outputs a new schema version where theteam
entity is revised to include the new permissions as illustrated below:
invite
and remove_user
permissions have been added, a member
relation has been included, the edit
permission has been deleted, and the delete
permission has been updated.Path Parameters
tenant_id is a string that identifies the tenant. It must match the pattern "[a-zA-Z0-9-,]+", be a maximum of 64 bytes, and must not be empty.
Body
application/json
Response
A successful response.
SchemaPartialWriteResponse is the response message for the Parietal Write method in the Schema service. It returns the requested schema.