Skip to content

Commit 3307aaf

Browse files
github-actions[bot]github-actions[bot]
authored
fix(openapi): sync with openapi definition (#184)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent b4f250e commit 3307aaf

File tree

2 files changed

+259
-0
lines changed

2 files changed

+259
-0
lines changed

‎openapi.json

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8073,6 +8073,137 @@
80738073
"x-readme": {}
80748074
}
80758075
},
8076+
"/orgs/{org_slug}/audit-log": {
8077+
"get": {
8078+
"tags": [
8079+
"Audit Log"
8080+
],
8081+
"summary": "Get Audit Log Events",
8082+
"operationId": "getAuditLogEvents",
8083+
"parameters": [
8084+
{
8085+
"name": "org_slug",
8086+
"in": "path",
8087+
"required": true,
8088+
"schema": {
8089+
"type": "string"
8090+
}
8091+
}
8092+
],
8093+
"security": [
8094+
{
8095+
"basicAuth": [
8096+
"audit-log:list"
8097+
]
8098+
}
8099+
],
8100+
"description": "Paginated list of audit log events.\n\nThe `type` queryParam must be omitted or one of:\n\n- BookDemo\n- CancelInvitation\n- ChangeMemberRole\n- ChangePlanSubscriptionSeats\n- ContactForm\n- CreateApiToken\n- CreateUser\n- GithubAppInstallation\n- JoinOrganizationByVcs\n- LinkAccount\n- RemoveMember\n- ResetInvitationLink\n- ResetOrganizationSettingToDefault\n- RotateApiToken\n- SendInvitation\n- SignIn\n- SignOut\n- Subscribe\n- SyncOrganization\n- TransferOwnership\n- UpdateAlertTriage\n- UpdateApiTokenName\n- UpdateApiTokenScopes\n- UpdateApiTokenVisibility\n- UpdateOrganizationSetting\n- UpgradeOrganizationPlan\n- VerifiedEmail\n\nThis endpoint consumes 0 units of your quota.",
8101+
"responses": {
8102+
"200": {
8103+
"content": {
8104+
"application/json": {
8105+
"schema": {
8106+
"type": "object",
8107+
"additionalProperties": false,
8108+
"properties": {
8109+
"results": {
8110+
"type": "array",
8111+
"items": {
8112+
"type": "object",
8113+
"additionalProperties": false,
8114+
"properties": {
8115+
"event_id": {
8116+
"type": "string",
8117+
"default": ""
8118+
},
8119+
"created_at": {
8120+
"type": "string",
8121+
"default": ""
8122+
},
8123+
"updated_at": {
8124+
"type": "string",
8125+
"default": ""
8126+
},
8127+
"country_code": {
8128+
"type": "string",
8129+
"default": ""
8130+
},
8131+
"organization_id": {
8132+
"type": "string",
8133+
"default": ""
8134+
},
8135+
"ip_address": {
8136+
"type": "string",
8137+
"default": ""
8138+
},
8139+
"payload": {
8140+
"type": "object",
8141+
"default": null
8142+
},
8143+
"status_code": {
8144+
"type": "integer",
8145+
"default": 0
8146+
},
8147+
"type": {
8148+
"type": "string",
8149+
"default": ""
8150+
},
8151+
"user_agent": {
8152+
"type": "string",
8153+
"default": ""
8154+
},
8155+
"user_id": {
8156+
"type": "string",
8157+
"default": ""
8158+
},
8159+
"user_email": {
8160+
"type": "string",
8161+
"default": ""
8162+
},
8163+
"user_image": {
8164+
"type": "string",
8165+
"default": ""
8166+
},
8167+
"organization_name": {
8168+
"type": "string",
8169+
"default": ""
8170+
}
8171+
}
8172+
}
8173+
},
8174+
"nextPage": {
8175+
"type": "integer",
8176+
"default": 0
8177+
}
8178+
},
8179+
"required": [
8180+
"nextPage",
8181+
"results"
8182+
]
8183+
}
8184+
}
8185+
},
8186+
"description": "The paginated list of events in an organizations audit log and the next page querystring token."
8187+
},
8188+
"400": {
8189+
"$ref": "#/components/responses/SocketBadRequest"
8190+
},
8191+
"401": {
8192+
"$ref": "#/components/responses/SocketUnauthorized"
8193+
},
8194+
"403": {
8195+
"$ref": "#/components/responses/SocketForbidden"
8196+
},
8197+
"404": {
8198+
"$ref": "#/components/responses/SocketNotFoundResponse"
8199+
},
8200+
"429": {
8201+
"$ref": "#/components/responses/SocketTooManyRequestsResponse"
8202+
}
8203+
},
8204+
"x-readme": {}
8205+
}
8206+
},
80768207
"/analytics/org/{filter}": {
80778208
"get": {
80788209
"tags": [

‎types/api.d.ts

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,45 @@ export interface paths {
260260
*/
261261
get: operations["getOrgFullScanMetadata"];
262262
};
263+
"/orgs/{org_slug}/audit-log": {
264+
/**
265+
* Get Audit Log Events
266+
* @description Paginated list of audit log events.
267+
*
268+
* The `type` queryParam must be omitted or one of:
269+
*
270+
* - BookDemo
271+
* - CancelInvitation
272+
* - ChangeMemberRole
273+
* - ChangePlanSubscriptionSeats
274+
* - ContactForm
275+
* - CreateApiToken
276+
* - CreateUser
277+
* - GithubAppInstallation
278+
* - JoinOrganizationByVcs
279+
* - LinkAccount
280+
* - RemoveMember
281+
* - ResetInvitationLink
282+
* - ResetOrganizationSettingToDefault
283+
* - RotateApiToken
284+
* - SendInvitation
285+
* - SignIn
286+
* - SignOut
287+
* - Subscribe
288+
* - SyncOrganization
289+
* - TransferOwnership
290+
* - UpdateAlertTriage
291+
* - UpdateApiTokenName
292+
* - UpdateApiTokenScopes
293+
* - UpdateApiTokenVisibility
294+
* - UpdateOrganizationSetting
295+
* - UpgradeOrganizationPlan
296+
* - VerifiedEmail
297+
*
298+
* This endpoint consumes 0 units of your quota.
299+
*/
300+
get: operations["getAuditLogEvents"];
301+
};
263302
"/analytics/org/{filter}": {
264303
/**
265304
* Get organization analytics (unstable)
@@ -2883,6 +2922,95 @@ export interface operations {
28832922
429: components["responses"]["SocketTooManyRequestsResponse"];
28842923
};
28852924
};
2925+
/**
2926+
* Get Audit Log Events
2927+
* @description Paginated list of audit log events.
2928+
*
2929+
* The `type` queryParam must be omitted or one of:
2930+
*
2931+
* - BookDemo
2932+
* - CancelInvitation
2933+
* - ChangeMemberRole
2934+
* - ChangePlanSubscriptionSeats
2935+
* - ContactForm
2936+
* - CreateApiToken
2937+
* - CreateUser
2938+
* - GithubAppInstallation
2939+
* - JoinOrganizationByVcs
2940+
* - LinkAccount
2941+
* - RemoveMember
2942+
* - ResetInvitationLink
2943+
* - ResetOrganizationSettingToDefault
2944+
* - RotateApiToken
2945+
* - SendInvitation
2946+
* - SignIn
2947+
* - SignOut
2948+
* - Subscribe
2949+
* - SyncOrganization
2950+
* - TransferOwnership
2951+
* - UpdateAlertTriage
2952+
* - UpdateApiTokenName
2953+
* - UpdateApiTokenScopes
2954+
* - UpdateApiTokenVisibility
2955+
* - UpdateOrganizationSetting
2956+
* - UpgradeOrganizationPlan
2957+
* - VerifiedEmail
2958+
*
2959+
* This endpoint consumes 0 units of your quota.
2960+
*/
2961+
getAuditLogEvents: {
2962+
parameters: {
2963+
path: {
2964+
org_slug: string;
2965+
};
2966+
};
2967+
responses: {
2968+
/** @description The paginated list of events in an organizations audit log and the next page querystring token. */
2969+
200: {
2970+
content: {
2971+
"application/json": {
2972+
results: {
2973+
/** @default */
2974+
event_id?: string;
2975+
/** @default */
2976+
created_at?: string;
2977+
/** @default */
2978+
updated_at?: string;
2979+
/** @default */
2980+
country_code?: string;
2981+
/** @default */
2982+
organization_id?: string;
2983+
/** @default */
2984+
ip_address?: string;
2985+
/** @default null */
2986+
payload?: Record<string, never>;
2987+
/** @default 0 */
2988+
status_code?: number;
2989+
/** @default */
2990+
type?: string;
2991+
/** @default */
2992+
user_agent?: string;
2993+
/** @default */
2994+
user_id?: string;
2995+
/** @default */
2996+
user_email?: string;
2997+
/** @default */
2998+
user_image?: string;
2999+
/** @default */
3000+
organization_name?: string;
3001+
}[];
3002+
/** @default 0 */
3003+
nextPage: number;
3004+
};
3005+
};
3006+
};
3007+
400: components["responses"]["SocketBadRequest"];
3008+
401: components["responses"]["SocketUnauthorized"];
3009+
403: components["responses"]["SocketForbidden"];
3010+
404: components["responses"]["SocketNotFoundResponse"];
3011+
429: components["responses"]["SocketTooManyRequestsResponse"];
3012+
};
3013+
};
28863014
/**
28873015
* Get organization analytics (unstable)
28883016
* @description Get analytics data regarding the number of alerts found across all active repositories.

0 commit comments

Comments
 (0)