Skip to content

Commit a164ab8

Browse files
committed
docs(openapi): regenerate full types
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
1 parent 41a416c commit a164ab8

File tree

1 file changed

+126
-0
lines changed

1 file changed

+126
-0
lines changed

src/types/openapi/openapi-full.ts

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,27 @@ export interface paths {
119119
patch?: never;
120120
trace?: never;
121121
};
122+
"/ocs/v2.php/apps/profile_fields/api/v1/users/search": {
123+
parameters: {
124+
query?: never;
125+
header?: never;
126+
path?: never;
127+
cookie?: never;
128+
};
129+
/**
130+
* Search users by one profile field filter
131+
* @description Return a paginated list of users that match one explicit profile field filter. The response includes only the field/value pair that produced the match, not the full profile.
132+
* This endpoint requires admin access
133+
*/
134+
get: operations["field_value_admin_api-search"];
135+
put?: never;
136+
post?: never;
137+
delete?: never;
138+
options?: never;
139+
head?: never;
140+
patch?: never;
141+
trace?: never;
142+
};
122143
"/ocs/v2.php/apps/profile_fields/api/v1/me/values": {
123144
parameters: {
124145
query?: never;
@@ -234,6 +255,24 @@ export interface components {
234255
totalitems?: string;
235256
itemsperpage?: string;
236257
};
258+
SearchItem: {
259+
user_uid: string;
260+
display_name: string;
261+
fields: {
262+
[key: string]: components["schemas"]["LookupField"];
263+
};
264+
};
265+
SearchResult: {
266+
items: components["schemas"]["SearchItem"][];
267+
pagination: {
268+
/** Format: int64 */
269+
limit: number;
270+
/** Format: int64 */
271+
offset: number;
272+
/** Format: int64 */
273+
total: number;
274+
};
275+
};
237276
/** @enum {string} */
238277
Type: "text" | "number";
239278
ValuePayload: {
@@ -762,6 +801,93 @@ export interface operations {
762801
};
763802
};
764803
};
804+
"field_value_admin_api-search": {
805+
parameters: {
806+
query: {
807+
/** @description Immutable key of the field to filter by */
808+
fieldKey: string;
809+
/** @description Explicit search operator, currently `eq` or `contains` */
810+
operator?: string;
811+
/** @description Value payload to compare against the stored field value */
812+
value?: string | null;
813+
/** @description Maximum number of users to return in the current page */
814+
limit?: number;
815+
/** @description Zero-based offset into the matched result set */
816+
offset?: number;
817+
};
818+
header: {
819+
/** @description Required to be true for the API request to pass */
820+
"OCS-APIRequest": boolean;
821+
};
822+
path?: never;
823+
cookie?: never;
824+
};
825+
requestBody?: never;
826+
responses: {
827+
/** @description User search completed successfully */
828+
200: {
829+
headers: {
830+
[name: string]: unknown;
831+
};
832+
content: {
833+
"application/json": {
834+
ocs: {
835+
meta: components["schemas"]["OCSMeta"];
836+
data: components["schemas"]["SearchResult"];
837+
};
838+
};
839+
};
840+
};
841+
/** @description Invalid search filter or pagination values */
842+
400: {
843+
headers: {
844+
[name: string]: unknown;
845+
};
846+
content: {
847+
"application/json": {
848+
ocs: {
849+
meta: components["schemas"]["OCSMeta"];
850+
data: {
851+
message: string;
852+
};
853+
};
854+
};
855+
};
856+
};
857+
/** @description Authenticated admin user is required */
858+
401: {
859+
headers: {
860+
[name: string]: unknown;
861+
};
862+
content: {
863+
"application/json": {
864+
ocs: {
865+
meta: components["schemas"]["OCSMeta"];
866+
data: {
867+
message: string;
868+
};
869+
};
870+
};
871+
};
872+
};
873+
/** @description Search field definition not found */
874+
404: {
875+
headers: {
876+
[name: string]: unknown;
877+
};
878+
content: {
879+
"application/json": {
880+
ocs: {
881+
meta: components["schemas"]["OCSMeta"];
882+
data: {
883+
message: string;
884+
};
885+
};
886+
};
887+
};
888+
};
889+
};
890+
};
765891
"field_value_api-index": {
766892
parameters: {
767893
query?: never;

0 commit comments

Comments
 (0)