Skip to content

feat(api): support object path manipulation #2786

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

Merged
merged 1 commit into from
Sep 1, 2025
Merged

feat(api): support object path manipulation #2786

Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions src/services/api/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ export class BaseYdbAPI extends AxiosWrapper {
return `${BACKEND ?? ''}${path}`;
}

Copy link

Copilot AI Sep 1, 2025

Choose a reason for hiding this comment

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

The getSchemaPath method lacks documentation explaining its purpose, parameters, and return value. Add JSDoc comments to clarify the method's role in path manipulation and how it should be overridden in subclasses.

Copilot uses AI. Check for mistakes.
getSchemaPath(props: {path?: string; database?: string}) {
return props.path;
}

prepareArrayRequestParam(arr: (string | number)[]) {
return arr.join(',');
}
Expand Down
24 changes: 12 additions & 12 deletions src/services/api/viewer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export class ViewerAPI extends BaseYdbAPI {
{
database,
node_id: nodeId,
path,
path: this.getSchemaPath({path, database}),
enums: true,
filter,
},
Expand All @@ -163,7 +163,7 @@ export class ViewerAPI extends BaseYdbAPI {
this.getPath('/viewer/json/describe'),
{
database,
path,
path: this.getSchemaPath({path, database}),
enums: true,
backup: false,
private: true,
Expand All @@ -184,7 +184,7 @@ export class ViewerAPI extends BaseYdbAPI {
this.getPath('/viewer/json/describe'),
{
database,
path,
path: this.getSchemaPath({path, database}),
enums: true,
partition_stats: true,
subs: 0,
Expand All @@ -201,7 +201,7 @@ export class ViewerAPI extends BaseYdbAPI {
this.getPath('/viewer/json/acl'),
{
database,
path,
path: this.getSchemaPath({path, database}),
merge_rules: true,
dialect,
},
Expand All @@ -216,7 +216,7 @@ export class ViewerAPI extends BaseYdbAPI {
this.getPath('/viewer/json/acl'),
{
database,
path,
path: this.getSchemaPath({path, database}),
merge_rules: true,
dialect,
list_permissions: true,
Expand All @@ -238,7 +238,7 @@ export class ViewerAPI extends BaseYdbAPI {
rights,
{
database,
path,
path: this.getSchemaPath({path, database}),
merge_rules: true,
dialect,
},
Expand All @@ -254,7 +254,7 @@ export class ViewerAPI extends BaseYdbAPI {
this.getPath('/viewer/json/describe'),
{
database,
path,
path: this.getSchemaPath({path, database}),
enums: true,
backup: false,
children: false,
Expand All @@ -274,7 +274,7 @@ export class ViewerAPI extends BaseYdbAPI {
{
enums: true,
database,
path,
path: this.getSchemaPath({path, database}),
},
{concurrentId, requestConfig: {signal}},
);
Expand All @@ -290,7 +290,7 @@ export class ViewerAPI extends BaseYdbAPI {
enums: true,
include_stats: true,
database,
path,
path: this.getSchemaPath({path, database}),
},
{concurrentId, requestConfig: {signal}},
);
Expand All @@ -306,7 +306,7 @@ export class ViewerAPI extends BaseYdbAPI {
enums: true,
include_stats: true,
database,
path,
path: this.getSchemaPath({path, database}),
},
{concurrentId, requestConfig: {signal}},
);
Expand All @@ -329,7 +329,7 @@ export class ViewerAPI extends BaseYdbAPI {
enums: true,
include_stats: true,
database,
path,
path: this.getSchemaPath({path, database}),
consumer,
},
{concurrentId: concurrentId || 'getConsumer', requestConfig: {signal}},
Expand Down Expand Up @@ -438,7 +438,7 @@ export class ViewerAPI extends BaseYdbAPI {
this.getPath('/viewer/json/hotkeys'),
{
database,
path,
path: this.getSchemaPath({path, database}),
enable_sampling: enableSampling,
},
{concurrentId: concurrentId || 'getHotKeys', requestConfig: {signal}},
Expand Down
Loading