Skip to content

Commit cf531c7

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

File tree

2 files changed

+11
-22
lines changed

2 files changed

+11
-22
lines changed

openapi.json

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7716,6 +7716,7 @@
77167716
"SyncOrganization",
77177717
"TransferOwnership",
77187718
"UpdateAlertTriage",
7719+
"UpdateApiTokenCommitter",
77197720
"UpdateApiTokenName",
77207721
"UpdateApiTokenScopes",
77217722
"UpdateApiTokenVisibility",
@@ -8862,9 +8863,9 @@
88628863
"/orgs/{org_slug}/full-scans/diff": {
88638864
"get": {
88648865
"tags": [
8865-
"Diff Scans"
8866+
"Full Scans"
88668867
],
8867-
"summary": "Stream diff scan",
8868+
"summary": "Diff Full Scans",
88688869
"operationId": "GetOrgDiffScan",
88698870
"parameters": [
88708871
{
@@ -8893,16 +8894,6 @@
88938894
"schema": {
88948895
"type": "string"
88958896
}
8896-
},
8897-
{
8898-
"name": "preview",
8899-
"in": "query",
8900-
"required": true,
8901-
"description": "Create a diff-scan that is not persisted.",
8902-
"schema": {
8903-
"type": "boolean",
8904-
"default": false
8905-
}
89068897
}
89078898
],
89088899
"security": [
@@ -8912,7 +8903,7 @@
89128903
]
89138904
}
89148905
],
8915-
"description": "Stream a diff scan between two full scans. Returns a diff scan.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- full-scans:list",
8906+
"description": "Get the difference between two Full Scans.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- full-scans:list",
89168907
"responses": {
89178908
"200": {
89188909
"content": {
@@ -11093,7 +11084,7 @@
1109311084
}
1109411085
}
1109511086
},
11096-
"description": "Returns a diff scan. The authenticated user must be a member of the organization."
11087+
"description": "The differnce between the two provided Full Scans."
1109711088
},
1109811089
"400": {
1109911090
"$ref": "#/components/responses/SocketBadRequest"

types/api.d.ts

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -335,8 +335,8 @@ export interface paths {
335335
};
336336
"/orgs/{org_slug}/full-scans/diff": {
337337
/**
338-
* Stream diff scan
339-
* @description Stream a diff scan between two full scans. Returns a diff scan.
338+
* Diff Full Scans
339+
* @description Get the difference between two Full Scans.
340340
*
341341
* This endpoint consumes 1 unit of your quota.
342342
*
@@ -2865,7 +2865,7 @@ export interface operations {
28652865
parameters: {
28662866
query?: {
28672867
/** @description Filter audit log events by type. Omit for all types. */
2868-
type?: "BookDemo" | "CancelInvitation" | "ChangeMemberRole" | "ChangePlanSubscriptionSeats" | "ContactForm" | "CreateApiToken" | "CreateUser" | "GithubAppInstallation" | "JoinOrganization" | "JoinOrganizationByVcs" | "LinkAccount" | "RemoveMember" | "ResetInvitationLink" | "ResetOrganizationSettingToDefault" | "RotateApiToken" | "SendInvitation" | "SignIn" | "SignOut" | "Subscribe" | "SyncOrganization" | "TransferOwnership" | "UpdateAlertTriage" | "UpdateApiTokenName" | "UpdateApiTokenScopes" | "UpdateApiTokenVisibility" | "UpdateOrganizationSetting" | "UpgradeOrganizationPlan" | "VerifiedEmail" | "DeleteRepository" | "DeleteReport";
2868+
type?: "BookDemo" | "CancelInvitation" | "ChangeMemberRole" | "ChangePlanSubscriptionSeats" | "ContactForm" | "CreateApiToken" | "CreateUser" | "GithubAppInstallation" | "JoinOrganization" | "JoinOrganizationByVcs" | "LinkAccount" | "RemoveMember" | "ResetInvitationLink" | "ResetOrganizationSettingToDefault" | "RotateApiToken" | "SendInvitation" | "SignIn" | "SignOut" | "Subscribe" | "SyncOrganization" | "TransferOwnership" | "UpdateAlertTriage" | "UpdateApiTokenCommitter" | "UpdateApiTokenName" | "UpdateApiTokenScopes" | "UpdateApiTokenVisibility" | "UpdateOrganizationSetting" | "UpgradeOrganizationPlan" | "VerifiedEmail" | "DeleteRepository" | "DeleteReport";
28692869
/** @description Number of events per page */
28702870
per_page?: number;
28712871
/** @description Page token */
@@ -3291,8 +3291,8 @@ export interface operations {
32913291
};
32923292
};
32933293
/**
3294-
* Stream diff scan
3295-
* @description Stream a diff scan between two full scans. Returns a diff scan.
3294+
* Diff Full Scans
3295+
* @description Get the difference between two Full Scans.
32963296
*
32973297
* This endpoint consumes 1 unit of your quota.
32983298
*
@@ -3306,16 +3306,14 @@ export interface operations {
33063306
before: string;
33073307
/** @description The base full scan ID */
33083308
after: string;
3309-
/** @description Create a diff-scan that is not persisted. */
3310-
preview: boolean;
33113309
};
33123310
path: {
33133311
/** @description The slug of the organization */
33143312
org_slug: string;
33153313
};
33163314
};
33173315
responses: {
3318-
/** @description Returns a diff scan. The authenticated user must be a member of the organization. */
3316+
/** @description The differnce between the two provided Full Scans. */
33193317
200: {
33203318
content: {
33213319
"application/json": {

0 commit comments

Comments
 (0)