Skip to content

DRAFT ADR: New API to delete private schemas

Status

  • Proposed
  • Trialing
  • Under review
  • Approved
  • Retired

Context & Scope

End users and QA engineers often need to delete individual schemas, which contain errors or were uploaded by mistake. Current Schema service API does not have such method and these schemas are deleted manually.

Tradeoff Analysis

The important thing to consider before deleting any schema from a private context is that data may already exist for that schema. Therefore, delete should only be successful when schema with same id/body is recreated into system partition as SHARED.

TODO: edge cases to be elaborated and documented here

Decision

  1. Introduce a delete endpoint to have an ability to delete individual private schema. This endpoint should be governed by some admin role to cleanup schemas from private partitions only.

  2. Schemas in SHARED partition should still not have delete support.

  3. Create new API method as below:

Schema_delete_API OpenAPI spec for this API change schema_openapi.yaml

Consequences

  1. This will help users to keep clean set of schemas in their environments

  2. This will reduce the number of support requests for DevOps

Edited by Andrei Dalhikh [EPAM/GC]