Skip to content

Commit 2f3d88a

Browse files
committed
chore: refresh OpenAPI schema
1 parent 51b1737 commit 2f3d88a

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

src/openapi/schema.ts

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ export interface paths {
4343
'/replication/replicate': {
4444
post: operations['replicate'];
4545
};
46+
'/replication/replicate/{id}': {
47+
/** Returns the details of a replication operation for a given shard, identified by the provided replication operation id. */
48+
get: operations['replicationDetails'];
49+
};
4650
'/users/own-info': {
4751
get: operations['getOwnInfo'];
4852
};
@@ -286,6 +290,18 @@ export interface definitions {
286290
dbUserType: 'db_user' | 'db_env_user';
287291
/** @description activity status of the returned user */
288292
active: boolean;
293+
/**
294+
* Format: date-time
295+
* @description Date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
296+
*/
297+
createdAt?: unknown;
298+
/** @description First 3 letters of the associated API-key */
299+
apiKeyFirstLetters?: unknown;
300+
/**
301+
* Format: date-time
302+
* @description Date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)
303+
*/
304+
lastUsedAt?: unknown;
289305
};
290306
UserApiKey: {
291307
/** @description The apikey */
@@ -568,6 +584,8 @@ export interface definitions {
568584
indexNullState?: boolean;
569585
/** @description Index length of properties (default: 'false'). */
570586
indexPropertyLength?: boolean;
587+
/** @description Using BlockMax WAND for query execution (default: 'false', will be 'true' for new collections created after 1.30). */
588+
usingBlockMaxWAND?: boolean;
571589
};
572590
/** @description Configure how replication is executed in a cluster */
573591
ReplicationConfig: {
@@ -689,6 +707,29 @@ export interface definitions {
689707
/** @description The shard id holding the replica to be deleted */
690708
shardId: string;
691709
};
710+
/** @description The current status and details of a replication operation, including information about the resources involved in the replication process. */
711+
ReplicationReplicateDetailsReplicaResponse: {
712+
/** @description The unique id of the replication operation. */
713+
id: string;
714+
/** @description The id of the shard to collect replication details for. */
715+
shardId: string;
716+
/** @description The name of the collection holding data being replicated. */
717+
collection: string;
718+
/** @description The id of the node where the source replica is allocated. */
719+
sourceNodeId: string;
720+
/** @description The id of the node where the target replica is allocated. */
721+
targetNodeId: string;
722+
/**
723+
* @description The current status of the replication operation, indicating the replication phase the operation is in.
724+
* @enum {string}
725+
*/
726+
status:
727+
| 'READY'
728+
| 'INDEXING'
729+
| 'REPLICATION_FINALIZING'
730+
| 'REPLICATION_HYDRATING'
731+
| 'REPLICATION_DEHYDRATING';
732+
};
692733
/** @description A single peer in the network. */
693734
PeerUpdate: {
694735
/**
@@ -1728,6 +1769,37 @@ export interface operations {
17281769
};
17291770
};
17301771
};
1772+
/** Returns the details of a replication operation for a given shard, identified by the provided replication operation id. */
1773+
replicationDetails: {
1774+
parameters: {
1775+
path: {
1776+
/** The replication operation id to get details for. */
1777+
id: string;
1778+
};
1779+
};
1780+
responses: {
1781+
/** The details of the replication operation. */
1782+
200: {
1783+
schema: definitions['ReplicationReplicateDetailsReplicaResponse'];
1784+
};
1785+
/** Malformed request. */
1786+
400: {
1787+
schema: definitions['ErrorResponse'];
1788+
};
1789+
/** Unauthorized or invalid credentials. */
1790+
401: unknown;
1791+
/** Forbidden */
1792+
403: {
1793+
schema: definitions['ErrorResponse'];
1794+
};
1795+
/** Shard replica operation not found */
1796+
404: unknown;
1797+
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
1798+
500: {
1799+
schema: definitions['ErrorResponse'];
1800+
};
1801+
};
1802+
};
17311803
getOwnInfo: {
17321804
responses: {
17331805
/** Info about the user */
@@ -1743,8 +1815,14 @@ export interface operations {
17431815
};
17441816
};
17451817
listAllUsers: {
1818+
parameters: {
1819+
query: {
1820+
/** Whether to include the last used time of the users */
1821+
includeLastUsedTime?: boolean;
1822+
};
1823+
};
17461824
responses: {
1747-
/** Info about the user */
1825+
/** Info about the users */
17481826
200: {
17491827
schema: definitions['DBUserInfo'][];
17501828
};
@@ -1766,6 +1844,10 @@ export interface operations {
17661844
/** user id */
17671845
user_id: string;
17681846
};
1847+
query: {
1848+
/** Whether to include the last used time of the given user */
1849+
includeLastUsedTime?: boolean;
1850+
};
17691851
};
17701852
responses: {
17711853
/** Info about the user */
@@ -1780,6 +1862,10 @@ export interface operations {
17801862
};
17811863
/** user not found */
17821864
404: unknown;
1865+
/** Request body is well-formed (i.e., syntactically correct), but semantically erroneous. */
1866+
422: {
1867+
schema: definitions['ErrorResponse'];
1868+
};
17831869
/** An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error. */
17841870
500: {
17851871
schema: definitions['ErrorResponse'];

0 commit comments

Comments
 (0)