Skip to content

Commit a15ad28

Browse files
authored
docs(iam): document logs (#1031)
1 parent 89a3fb1 commit a15ad28

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

packages/clients/src/api/iam/v1alpha1/api.gen.ts

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1084,7 +1084,7 @@ export class API extends ParentAPI {
10841084

10851085
/**
10861086
* Get a quota in the Organization. Retrieve information about a resource
1087-
* quota, speficified by the `quotum_name` parameter. The quota's `limit`, or
1087+
* quota, specified by the `quotum_name` parameter. The quota's `limit`, or
10881088
* whether it is unlimited, is returned in the response.
10891089
*
10901090
* @param request - The request {@link GetQuotumRequest}
@@ -1187,9 +1187,25 @@ export class API extends ParentAPI {
11871187
unmarshalListLogsResponse,
11881188
)
11891189

1190+
/**
1191+
* List logs. List logs available for given Organization. You must define the
1192+
* `organization_id` in the query path of your request.
1193+
*
1194+
* @param request - The request {@link ListLogsRequest}
1195+
* @returns A Promise of ListLogsResponse
1196+
*/
11901197
listLogs = (request: Readonly<ListLogsRequest> = {}) =>
11911198
enrichForPagination('logs', this.pageOfListLogs, request)
11921199

1200+
/**
1201+
* Get a log. Retrieve information about a log, specified by the `log_id`
1202+
* parameter. The log's full details, including `id`, `ip`, `user_agent`,
1203+
* `action`, `bearer_id`, `resource_type` and `resource_id` are returned in
1204+
* the response.
1205+
*
1206+
* @param request - The request {@link GetLogRequest}
1207+
* @returns A Promise of Log
1208+
*/
11931209
getLog = (request: Readonly<GetLogRequest>) =>
11941210
this.client.fetch<Log>(
11951211
{

0 commit comments

Comments
 (0)