Skip to content

Commit 230ed25

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

File tree

2 files changed

+508
-15
lines changed

2 files changed

+508
-15
lines changed

‎openapi.json

Lines changed: 323 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18236,6 +18236,320 @@
1823618236
"x-readme": {}
1823718237
}
1823818238
},
18239+
"/orgs/{org_slug}/settings/license-policy": {
18240+
"get": {
18241+
"tags": [
18242+
"Settings"
18243+
],
18244+
"summary": "Get Organization License Policy",
18245+
"operationId": "getOrgLicensePolicy",
18246+
"parameters": [
18247+
{
18248+
"name": "org_slug",
18249+
"in": "path",
18250+
"required": true,
18251+
"description": "The slug of the organization",
18252+
"schema": {
18253+
"type": "string"
18254+
}
18255+
}
18256+
],
18257+
"security": [
18258+
{
18259+
"basicAuth": [
18260+
"license-policy:read"
18261+
]
18262+
}
18263+
],
18264+
"description": "Retrieve the license policy of an organization.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- license-policy:read",
18265+
"responses": {
18266+
"200": {
18267+
"content": {
18268+
"application/json": {
18269+
"schema": {
18270+
"type": "object",
18271+
"additionalProperties": false,
18272+
"properties": {
18273+
"license_policy_org_id": {
18274+
"type": "string",
18275+
"description": "",
18276+
"default": ""
18277+
},
18278+
"license_policy": {
18279+
"type": "object",
18280+
"additionalProperties": {
18281+
"type": "object",
18282+
"additionalProperties": false,
18283+
"properties": {
18284+
"allowed": {
18285+
"type": "boolean",
18286+
"default": false,
18287+
"description": ""
18288+
},
18289+
"licenseId": {
18290+
"type": "string",
18291+
"description": "",
18292+
"default": ""
18293+
},
18294+
"name": {
18295+
"type": "string",
18296+
"description": "",
18297+
"default": ""
18298+
},
18299+
"deprecated": {
18300+
"type": "boolean",
18301+
"default": false,
18302+
"description": ""
18303+
},
18304+
"fsfLibre": {
18305+
"type": "boolean",
18306+
"default": false,
18307+
"description": ""
18308+
},
18309+
"osiApproved": {
18310+
"type": "boolean",
18311+
"default": false,
18312+
"description": ""
18313+
},
18314+
"crossRef": {
18315+
"type": "string",
18316+
"description": "",
18317+
"default": ""
18318+
},
18319+
"blueOakTier": {
18320+
"type": "string",
18321+
"description": "",
18322+
"default": ""
18323+
},
18324+
"blueOakFamily": {
18325+
"type": "string",
18326+
"description": "",
18327+
"default": ""
18328+
},
18329+
"licenseExceptionId": {
18330+
"type": "string",
18331+
"description": "",
18332+
"default": ""
18333+
},
18334+
"isDeprecatedLicenseId": {
18335+
"type": "boolean",
18336+
"default": false,
18337+
"description": ""
18338+
}
18339+
}
18340+
},
18341+
"properties": {}
18342+
}
18343+
}
18344+
}
18345+
}
18346+
},
18347+
"description": "Retrieved license policy details"
18348+
},
18349+
"400": {
18350+
"$ref": "#/components/responses/SocketBadRequest"
18351+
},
18352+
"401": {
18353+
"$ref": "#/components/responses/SocketUnauthorized"
18354+
},
18355+
"403": {
18356+
"$ref": "#/components/responses/SocketForbidden"
18357+
},
18358+
"404": {
18359+
"$ref": "#/components/responses/SocketNotFoundResponse"
18360+
},
18361+
"429": {
18362+
"$ref": "#/components/responses/SocketTooManyRequestsResponse"
18363+
}
18364+
},
18365+
"x-readme": {}
18366+
},
18367+
"post": {
18368+
"tags": [
18369+
"Settings"
18370+
],
18371+
"summary": "Update License Policy",
18372+
"operationId": "updateOrgLicensePolicy",
18373+
"parameters": [
18374+
{
18375+
"name": "org_slug",
18376+
"in": "path",
18377+
"required": true,
18378+
"description": "The slug of the organization",
18379+
"schema": {
18380+
"type": "string"
18381+
}
18382+
},
18383+
{
18384+
"name": "merge_update",
18385+
"in": "query",
18386+
"required": true,
18387+
"description": "Merge the policy update with the existing policy. Default is true. If false, the existing policy will be replaced with the new policy.",
18388+
"schema": {
18389+
"type": "boolean",
18390+
"default": false
18391+
}
18392+
}
18393+
],
18394+
"requestBody": {
18395+
"content": {
18396+
"application/json": {
18397+
"schema": {
18398+
"type": "object",
18399+
"additionalProperties": false,
18400+
"properties": {
18401+
"quick_setup": {
18402+
"type": "object",
18403+
"additionalProperties": false,
18404+
"properties": {
18405+
"permissive": {
18406+
"type": "boolean",
18407+
"default": false,
18408+
"description": ""
18409+
},
18410+
"weak_copyleft": {
18411+
"type": "boolean",
18412+
"default": false,
18413+
"description": ""
18414+
},
18415+
"strong_copyleft": {
18416+
"type": "boolean",
18417+
"default": false,
18418+
"description": ""
18419+
},
18420+
"lead": {
18421+
"type": "boolean",
18422+
"default": false,
18423+
"description": ""
18424+
}
18425+
}
18426+
},
18427+
"license_policy": {
18428+
"type": "object",
18429+
"additionalProperties": {
18430+
"type": "boolean",
18431+
"default": false,
18432+
"description": ""
18433+
},
18434+
"properties": {}
18435+
}
18436+
}
18437+
}
18438+
}
18439+
},
18440+
"required": false
18441+
},
18442+
"security": [
18443+
{
18444+
"basicAuth": [
18445+
"license-policy:update"
18446+
]
18447+
}
18448+
],
18449+
"description": "Update the license policy of an organization.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- license-policy:update",
18450+
"responses": {
18451+
"200": {
18452+
"content": {
18453+
"application/json": {
18454+
"schema": {
18455+
"type": "object",
18456+
"additionalProperties": false,
18457+
"properties": {
18458+
"license_policy_org_id": {
18459+
"type": "string",
18460+
"description": "",
18461+
"default": ""
18462+
},
18463+
"license_policy": {
18464+
"type": "object",
18465+
"additionalProperties": {
18466+
"type": "object",
18467+
"additionalProperties": false,
18468+
"properties": {
18469+
"allowed": {
18470+
"type": "boolean",
18471+
"default": false,
18472+
"description": ""
18473+
},
18474+
"licenseId": {
18475+
"type": "string",
18476+
"description": "",
18477+
"default": ""
18478+
},
18479+
"name": {
18480+
"type": "string",
18481+
"description": "",
18482+
"default": ""
18483+
},
18484+
"deprecated": {
18485+
"type": "boolean",
18486+
"default": false,
18487+
"description": ""
18488+
},
18489+
"fsfLibre": {
18490+
"type": "boolean",
18491+
"default": false,
18492+
"description": ""
18493+
},
18494+
"osiApproved": {
18495+
"type": "boolean",
18496+
"default": false,
18497+
"description": ""
18498+
},
18499+
"crossRef": {
18500+
"type": "string",
18501+
"description": "",
18502+
"default": ""
18503+
},
18504+
"blueOakTier": {
18505+
"type": "string",
18506+
"description": "",
18507+
"default": ""
18508+
},
18509+
"blueOakFamily": {
18510+
"type": "string",
18511+
"description": "",
18512+
"default": ""
18513+
},
18514+
"licenseExceptionId": {
18515+
"type": "string",
18516+
"description": "",
18517+
"default": ""
18518+
},
18519+
"isDeprecatedLicenseId": {
18520+
"type": "boolean",
18521+
"default": false,
18522+
"description": ""
18523+
}
18524+
}
18525+
},
18526+
"properties": {}
18527+
}
18528+
}
18529+
}
18530+
}
18531+
},
18532+
"description": "Updated repository details"
18533+
},
18534+
"400": {
18535+
"$ref": "#/components/responses/SocketBadRequest"
18536+
},
18537+
"401": {
18538+
"$ref": "#/components/responses/SocketUnauthorized"
18539+
},
18540+
"403": {
18541+
"$ref": "#/components/responses/SocketForbidden"
18542+
},
18543+
"404": {
18544+
"$ref": "#/components/responses/SocketNotFoundResponse"
18545+
},
18546+
"429": {
18547+
"$ref": "#/components/responses/SocketTooManyRequestsResponse"
18548+
}
18549+
},
18550+
"x-readme": {}
18551+
}
18552+
},
1823918553
"/analytics/org/{filter}": {
1824018554
"get": {
1824118555
"tags": [
@@ -18907,6 +19221,7 @@
1890719221
"Project Reports"
1890819222
],
1890919223
"summary": "Delete a report",
19224+
"deprecated": true,
1891019225
"operationId": "deleteReport",
1891119226
"parameters": [
1891219227
{
@@ -18926,7 +19241,7 @@
1892619241
]
1892719242
}
1892819243
],
18929-
"description": "Delete a specific project report generated with the GitHub app. These endpoints will be merged into the full-scans endpoint so\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:write",
19244+
"description": "Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Delete a specific project report generated with the GitHub app.\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:write",
1893019245
"responses": {
1893119246
"200": {
1893219247
"content": {
@@ -18975,6 +19290,7 @@
1897519290
"Project Reports"
1897619291
],
1897719292
"summary": "Get list of reports",
19293+
"deprecated": true,
1897819294
"operationId": "getReportList",
1897919295
"parameters": [
1898019296
{
@@ -19003,7 +19319,7 @@
1900319319
]
1900419320
}
1900519321
],
19006-
"description": "Get all your project reports generated with the GitHub app. This endpoint will be merged into the full-scans endpoint soon.\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:list",
19322+
"description": "Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all your project reports generated with the GitHub app.\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:list",
1900719323
"responses": {
1900819324
"200": {
1900919325
"content": {
@@ -19097,6 +19413,7 @@
1909719413
"Project Reports"
1909819414
],
1909919415
"summary": "Create a report",
19416+
"deprecated": true,
1910019417
"operationId": "createReport",
1910119418
"requestBody": {
1910219419
"content": {
@@ -19135,7 +19452,7 @@
1913519452
]
1913619453
}
1913719454
],
19138-
"description": "Upload a lockfile to get your project analyzed by Socket.\nYou can upload multiple lockfiles in the same request, but each filename must be unique.\n\nThe name of the file must be in the supported list.\n\nFor example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:write",
19455+
"description": "Deprecated: Use `/orgs/{org_slug}/full-scans` instead.\n\nUpload a lockfile to get your project analyzed by Socket.\nYou can upload multiple lockfiles in the same request, but each filename must be unique.\n\nThe name of the file must be in the supported list.\n\nFor example, these are valid filenames: `package.json`, `folder/package.json` and `deep/nested/folder/package.json`.\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:write",
1913919456
"responses": {
1914019457
"200": {
1914119458
"content": {
@@ -19187,6 +19504,7 @@
1918719504
"Project Reports"
1918819505
],
1918919506
"summary": "View a report",
19507+
"deprecated": true,
1919019508
"operationId": "getReport",
1919119509
"parameters": [
1919219510
{
@@ -19206,7 +19524,7 @@
1920619524
]
1920719525
}
1920819526
],
19209-
"description": "Get all the issues, packages, and scores related to an specific project report.\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:read",
19527+
"description": "Deprecated: Use `/orgs/{org_slug}/full-scans` instead. Get all the issues, packages, and scores related to an specific project report.\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- report:read",
1921019528
"responses": {
1921119529
"200": {
1921219530
"content": {
@@ -19267,7 +19585,7 @@
1926719585
]
1926819586
}
1926919587
],
19270-
"description": "Get all GitHub repositories associated with a Socket org.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- repo:list",
19588+
"description": "Deprecated: Use `/orgs/{org_slug}/repos` instead. Get all GitHub repositories associated with a Socket org.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- repo:list",
1927119589
"responses": {
1927219590
"200": {
1927319591
"content": {

0 commit comments

Comments
 (0)