Skip to content

docs(iam): document logs #1031

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
Nov 29, 2023
Merged

docs(iam): document logs #1031

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
18 changes: 17 additions & 1 deletion packages/clients/src/api/iam/v1alpha1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1084,7 +1084,7 @@ export class API extends ParentAPI {

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

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

/**
* Get a log. Retrieve information about a log, specified by the `log_id`
* parameter. The log's full details, including `id`, `ip`, `user_agent`,
* `action`, `bearer_id`, `resource_type` and `resource_id` are returned in
* the response.
*
* @param request - The request {@link GetLogRequest}
* @returns A Promise of Log
*/
getLog = (request: Readonly<GetLogRequest>) =>
this.client.fetch<Log>(
{
Expand Down