Skip to content

Sync with OpenAPI definition #232

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 7, 2024
Merged

Sync with OpenAPI definition #232

Show file tree
Hide file tree
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
19 changes: 5 additions & 14 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7716,6 +7716,7 @@
"SyncOrganization",
"TransferOwnership",
"UpdateAlertTriage",
"UpdateApiTokenCommitter",
"UpdateApiTokenName",
"UpdateApiTokenScopes",
"UpdateApiTokenVisibility",
Expand Down Expand Up @@ -8862,9 +8863,9 @@
"/orgs/{org_slug}/full-scans/diff": {
"get": {
"tags": [
"Diff Scans"
"Full Scans"
],
"summary": "Stream diff scan",
"summary": "Diff Full Scans",
"operationId": "GetOrgDiffScan",
"parameters": [
{
Expand Down Expand Up @@ -8893,16 +8894,6 @@
"schema": {
"type": "string"
}
},
{
"name": "preview",
"in": "query",
"required": true,
"description": "Create a diff-scan that is not persisted.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"security": [
Expand All @@ -8912,7 +8903,7 @@
]
}
],
"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",
"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",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -11093,7 +11084,7 @@
}
}
},
"description": "Returns a diff scan. The authenticated user must be a member of the organization."
"description": "The differnce between the two provided Full Scans."
},
"400": {
"$ref": "#/components/responses/SocketBadRequest"
Expand Down
14 changes: 6 additions & 8 deletions types/api.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,8 +335,8 @@ export interface paths {
};
"/orgs/{org_slug}/full-scans/diff": {
/**
* Stream diff scan
* @description Stream a diff scan between two full scans. Returns a diff scan.
* Diff Full Scans
* @description Get the difference between two Full Scans.
*
* This endpoint consumes 1 unit of your quota.
*
Expand Down Expand Up @@ -2865,7 +2865,7 @@ export interface operations {
parameters: {
query?: {
/** @description Filter audit log events by type. Omit for all types. */
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";
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";
/** @description Number of events per page */
per_page?: number;
/** @description Page token */
Expand Down Expand Up @@ -3291,8 +3291,8 @@ export interface operations {
};
};
/**
* Stream diff scan
* @description Stream a diff scan between two full scans. Returns a diff scan.
* Diff Full Scans
* @description Get the difference between two Full Scans.
*
* This endpoint consumes 1 unit of your quota.
*
Expand All @@ -3306,16 +3306,14 @@ export interface operations {
before: string;
/** @description The base full scan ID */
after: string;
/** @description Create a diff-scan that is not persisted. */
preview: boolean;
};
path: {
/** @description The slug of the organization */
org_slug: string;
};
};
responses: {
/** @description Returns a diff scan. The authenticated user must be a member of the organization. */
/** @description The differnce between the two provided Full Scans. */
200: {
content: {
"application/json": {
Expand Down