Skip to content

database inspector changes: removed filter route (commented) #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smaEti wants to merge 1 commit into
base: main
Choose a base branch
from
Open

database inspector changes: removed filter route (commented) #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 112 additions & 112 deletions spec/database-inspector.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,102 +542,102 @@ paths:
500:
description: Unexpected server error
content: {}
/v1/databases/{databaseID}/datasets/{datasetName}/filter:
post:
tags:
- Database Inspector
summary: Filter dataset data
operationId: filterDataset
parameters:
- name: databaseID
in: path
description: The id of database
required: true
schema:
type: string
- name: datasetName
in: path
description: The name of dataset
required: true
schema:
type: string
- name: page
in: query
description: page
required: false
schema:
type: integer
example: 1
- name: count
in: query
description: count
required: false
schema:
type: integer
example: 50
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FilterDataRequest"
responses:
201:
description: Successfully got dataset by name.
content:
application/json:
schema:
$ref: "#/components/schemas/GetDatabaseByNameResponse"
400:
description: Bad request (invalid database ID)
content:
application/json:
schema:
$ref: "#/components/schemas/Error400Response"
example:
error:
statusCode: 400
error: "Bad Request"
message: "Invalid id"
401:
description: Unauthorized (missing or invalid authentication)
content:
application/json:
schema:
$ref: "#/components/schemas/Error401Response"
example:
error:
error: "Unauthorized."
404:
description: Not Found (host unreachable or no roles found)
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
examples:
hostNotFound:
summary: The database host was not found
value:
error:
statusCode: 404
error: "Not Found"
message: "The database host is unreachable"
datasetNotFound:
summary: dataset does not exist
value:
error:
statusCode: 404
error: "Not Found"
message: "dataset does not exist"
422:
description: Validation error
content: {}
409:
description: Database-related error (e.g., database or bridge in an invalid state)
content: {}
500:
description: Unexpected server error
content: {}
# /v1/databases/{databaseID}/datasets/{datasetName}/filter:
# post:
# tags:
# - Database Inspector
# summary: Filter dataset data
# operationId: filterDataset
# parameters:
# - name: databaseID
# in: path
# description: The id of database
# required: true
# schema:
# type: string
# - name: datasetName
# in: path
# description: The name of dataset
# required: true
# schema:
# type: string
# - name: page
# in: query
# description: page
# required: false
# schema:
# type: integer
# example: 1
# - name: count
# in: query
# description: count
# required: false
# schema:
# type: integer
# example: 50
# requestBody:
# required: true
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/FilterDataRequest"
# responses:
# 201:
# description: Successfully got dataset by name.
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/GetDatabaseByNameResponse"
# 400:
# description: Bad request (invalid database ID)
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/Error400Response"
# example:
# error:
# statusCode: 400
# error: "Bad Request"
# message: "Invalid id"
# 401:
# description: Unauthorized (missing or invalid authentication)
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/Error401Response"
# example:
# error:
# error: "Unauthorized."
# 404:
# description: Not Found (host unreachable or no roles found)
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/ErrorResponse"
# examples:
# hostNotFound:
# summary: The database host was not found
# value:
# error:
# statusCode: 404
# error: "Not Found"
# message: "The database host is unreachable"
# datasetNotFound:
# summary: dataset does not exist
# value:
# error:
# statusCode: 404
# error: "Not Found"
# message: "dataset does not exist"
# 422:
# description: Validation error
# content: {}
# 409:
# description: Database-related error (e.g., database or bridge in an invalid state)
# content: {}
# 500:
# description: Unexpected server error
# content: {}
/v1/databases/{databaseID}/datasets/{datasetName}/data:
post:
tags:
Expand Down Expand Up @@ -1042,22 +1042,22 @@ components:
properties:
query:
type: string
FilterDataRequest:
type: object
properties:
filter:
type: array
items:
type: object
properties:
column:
type: string
example: "id"
operator:
type: string
example: ">="
value:
example: 2
# FilterDataRequest:
Copy link

@khanzadimahdi khanzadimahdi Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commenting out the specs is not aligned with clean code ! the spec should reflect the client<>server contract. if this part of contract has been removed or not exists any more, it's better to remove it completely, otherwise suggest to keep it as it is.

btw the PR title reflects the removed filter but the content of PR comments some lines! they are not aligned.

# type: object
# properties:
# filter:
# type: array
# items:
# type: object
# properties:
# column:
# type: string
# example: "id"
# operator:
# type: string
# example: ">="
# value:
# example: 2
Error400Response:
type: object
properties:
Expand Down