docs: delete assets api #78
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 10503587786Details
💛 - Coveralls |
luthfifahlevi
requested review from
haveiss,
mabdh,
irainia,
batrov,
sumslim,
Mayurjag,
utsav14nov and
anjali9791
irainia
reviewed
Nov 19, 2024
| | Name | Located in | Description | Required | Schema | | ||
| |------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| ------ | | ||
| | query_expr | body | query expression based on [expr-lang](https://expr-lang.org/) to filtering the assets that wants to be deleted. `refreshed_at`, `type`, and `service` identifiers must exist in the query. The `type` and `service` must using equals (`==`) or `IN` operator | Yes | string | | ||
| | dry_run | body | if set to true, then deletion should not proceed and only return the affected rows. Else, will perform deletion in the background (default) | No | string | |
There was a problem hiding this comment.
can we change the part saying:
if set to true, then deletion should not proceed and only return the affected rows
into
if set to true, deletion will not be executed but the number of rows matching the query is returned
also, need to put what is the default value to make it explicit. currently a bit confusing. an example:
(default: false) if set to true, ...
irainia
reviewed
Nov 19, 2024
|
|
||
| | Name | Type | Description | Required | | ||
| |---------------|---------|-----------------------------------------------------|----------| | ||
| | affected_rows | integer | the numbers of assets that match the given query | No | |
There was a problem hiding this comment.
do we need to add column required in this response?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
### Create Reference API for Delete Assets
Idea:
DeleteAssetsas DELETE/v1/assets/: an async API that will return how many rows that will affect based on filter criteria, and delete those rows from PostgreSQL (assets and lineage) and Elasticsearch in asynchronous.Request:
query_exprrepresent query expr for filter criteria: https://github.com/expr-lang/expr.dry_runrepresent whether it only return how much affected rows (if set to true), or also perform deletion process in the background (default: false).Response:
affected_rowsrepresent how many rows that will affect based on filter criteria.Current Approach: