Skip to content

Commit

Permalink
[OpenAPI] Spec updates (#1381)
Browse files Browse the repository at this point in the history
Co-authored-by: exekias <[email protected]>
  • Loading branch information
xata-bot and exekias authored Feb 21, 2024
1 parent 7c9422f commit 8ba20c6
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 0 deletions.
82 changes: 82 additions & 0 deletions packages/client/src/api/dataPlaneComponents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,87 @@ export const getBranchList = (variables: GetBranchListVariables, signal?: AbortS
signal
});

export type GetDatabaseSettingsPathParams = {
/**
* The Database Name
*/
dbName: Schemas.DBName;
workspace: string;
region: string;
};

export type GetDatabaseSettingsError = Fetcher.ErrorWrapper<
| {
status: 400;
payload: Responses.SimpleError;
}
| {
status: 401;
payload: Responses.AuthError;
}
| {
status: 404;
payload: Responses.SimpleError;
}
>;

export type GetDatabaseSettingsVariables = {
pathParams: GetDatabaseSettingsPathParams;
} & DataPlaneFetcherExtraProps;

/**
* Get database settings
*/
export const getDatabaseSettings = (variables: GetDatabaseSettingsVariables, signal?: AbortSignal) =>
dataPlaneFetch<Schemas.DatabaseSettings, GetDatabaseSettingsError, undefined, {}, {}, GetDatabaseSettingsPathParams>({
url: '/dbs/{dbName}/settings',
method: 'get',
...variables,
signal
});

export type UpdateDatabaseSettingsPathParams = {
/**
* The Database Name
*/
dbName: Schemas.DBName;
workspace: string;
region: string;
};

export type UpdateDatabaseSettingsError = Fetcher.ErrorWrapper<
| {
status: 400;
payload: Responses.SimpleError;
}
| {
status: 401;
payload: Responses.AuthError;
}
| {
status: 404;
payload: Responses.SimpleError;
}
>;

export type UpdateDatabaseSettingsVariables = {
body: Schemas.DatabaseSettings;
pathParams: UpdateDatabaseSettingsPathParams;
} & DataPlaneFetcherExtraProps;

/**
* Update database settings, this endpoint can be used to disable search
*/
export const updateDatabaseSettings = (variables: UpdateDatabaseSettingsVariables, signal?: AbortSignal) =>
dataPlaneFetch<
Schemas.DatabaseSettings,
UpdateDatabaseSettingsError,
Schemas.DatabaseSettings,
{},
{},
UpdateDatabaseSettingsPathParams
>({ url: '/dbs/{dbName}/settings', method: 'patch', ...variables, signal });

export type GetBranchDetailsPathParams = {
/**
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
Expand Down Expand Up @@ -4698,6 +4779,7 @@ export const operationsByTag = {
removeGitBranchesEntry,
resolveBranch
},
database: { getDatabaseSettings, updateDatabaseSettings },
migrations: {
getSchema,
getBranchMigrationHistory,
Expand Down
4 changes: 4 additions & 0 deletions packages/client/src/api/dataPlaneSchemas.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ export type ListBranchesResponse = {
branches: Branch[];
};

export type DatabaseSettings = {
search_enabled: boolean;
};

/**
* @maxLength 255
* @minLength 1
Expand Down

0 comments on commit 8ba20c6

Please sign in to comment.