Skip to content

Commit 353de44

Browse files
github-actions[bot]jdalton
github-actions[bot]
and
jdalton
authored
Sync with OpenAPI definition (#316)
* Update deps * fix(openapi): sync with openapi definition --------- Co-authored-by: jdalton <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: John-David Dalton <[email protected]>
1 parent c17f29e commit 353de44

File tree

2 files changed

+393
-1
lines changed

2 files changed

+393
-1
lines changed

‎openapi.json

Lines changed: 277 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26553,7 +26553,7 @@
2655326553
"/threat-feed": {
2655426554
"get": {
2655526555
"tags": [
26556-
"Threat Feed"
26556+
"Deprecated"
2655726557
],
2655826558
"summary": "Get Threat Feed Items (Deprecated)",
2655926559
"deprecated": true,
@@ -26818,6 +26818,282 @@
2681826818
"x-readme": {}
2681926819
}
2682026820
},
26821+
"/orgs/{org_slug}/threat-feed": {
26822+
"get": {
26823+
"tags": [
26824+
"Threat Feed"
26825+
],
26826+
"summary": "Get Threat Feed Items (Beta)",
26827+
"operationId": "getOrgThreatFeedItems",
26828+
"parameters": [
26829+
{
26830+
"name": "org_slug",
26831+
"in": "path",
26832+
"required": true,
26833+
"description": "The slug of the organization",
26834+
"schema": {
26835+
"type": "string"
26836+
}
26837+
},
26838+
{
26839+
"name": "per_page",
26840+
"in": "query",
26841+
"required": false,
26842+
"description": "Number of threats per page",
26843+
"schema": {
26844+
"type": "integer",
26845+
"minimum": 1,
26846+
"maximum": 100,
26847+
"default": 30
26848+
}
26849+
},
26850+
{
26851+
"name": "page_cursor",
26852+
"in": "query",
26853+
"required": false,
26854+
"description": "Page cursor token. Pass the returned nextPageCursor to this query string to fetch the next page of the threat feed.",
26855+
"schema": {
26856+
"type": "string"
26857+
}
26858+
},
26859+
{
26860+
"name": "sort",
26861+
"in": "query",
26862+
"required": false,
26863+
"description": "Set the sort order for the threat feed items. Default is descending order by updated_at, which includes all new and updated threat feed items.",
26864+
"schema": {
26865+
"type": "string",
26866+
"enum": [
26867+
"id",
26868+
"created_at",
26869+
"updated_at"
26870+
],
26871+
"default": "updated_at"
26872+
}
26873+
},
26874+
{
26875+
"name": "updated_after",
26876+
"in": "query",
26877+
"required": false,
26878+
"description": "A Unix timestamp in seconds that filters results to items only updated after the timestamp.",
26879+
"schema": {
26880+
"type": "string"
26881+
}
26882+
},
26883+
{
26884+
"name": "created_after",
26885+
"in": "query",
26886+
"required": false,
26887+
"description": "A Unix timestamp in seconds that filters results to items only created after the date.",
26888+
"schema": {
26889+
"type": "string"
26890+
}
26891+
},
26892+
{
26893+
"name": "direction",
26894+
"in": "query",
26895+
"required": false,
26896+
"description": "Order direction of the provided sort field.",
26897+
"schema": {
26898+
"type": "string",
26899+
"enum": [
26900+
"desc",
26901+
"asc"
26902+
],
26903+
"default": "desc"
26904+
}
26905+
},
26906+
{
26907+
"name": "filter",
26908+
"in": "query",
26909+
"required": false,
26910+
"description": "Filter what type of threats to return",
26911+
"schema": {
26912+
"type": "string",
26913+
"enum": [
26914+
"u",
26915+
"c",
26916+
"fp",
26917+
"tp",
26918+
"mal",
26919+
"vuln",
26920+
"anom",
26921+
"joke",
26922+
"spy",
26923+
"typo",
26924+
"secret"
26925+
],
26926+
"default": "mal"
26927+
}
26928+
},
26929+
{
26930+
"name": "name",
26931+
"in": "query",
26932+
"required": false,
26933+
"description": "Filter threats by package name",
26934+
"schema": {
26935+
"type": "string",
26936+
"default": ""
26937+
}
26938+
},
26939+
{
26940+
"name": "version",
26941+
"in": "query",
26942+
"required": false,
26943+
"description": "Filter threats by package version.",
26944+
"schema": {
26945+
"type": "string",
26946+
"default": ""
26947+
}
26948+
},
26949+
{
26950+
"name": "is_human_reviewed",
26951+
"in": "query",
26952+
"required": false,
26953+
"description": "Only return threats which have been human-reviewed",
26954+
"schema": {
26955+
"type": "boolean",
26956+
"default": false
26957+
}
26958+
},
26959+
{
26960+
"name": "ecosystem",
26961+
"in": "query",
26962+
"required": false,
26963+
"description": "Filter threats by package ecosystem type",
26964+
"schema": {
26965+
"type": "string",
26966+
"enum": [
26967+
"github",
26968+
"golang",
26969+
"maven",
26970+
"npm",
26971+
"nuget",
26972+
"pypi",
26973+
"gem"
26974+
]
26975+
}
26976+
}
26977+
],
26978+
"security": [
26979+
{
26980+
"bearerAuth": [
26981+
"threat-feed:list"
26982+
]
26983+
},
26984+
{
26985+
"basicAuth": [
26986+
"threat-feed:list"
26987+
]
26988+
}
26989+
],
26990+
"description": "Paginated list of threats, sorted by updated_at by default. Set updated_after to the unix timestamp of your last sync while sorting by updated_at to synchronize all new or updated threats in the feed.\n\nThis endpoint requires an Enterprise Plan with Threat Feed add-on. [Contact](https://socket.dev/demo?utm_source=api-docs&utm_medium=referral&utm_campaign=tracking) our sales team for more details.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- threat-feed:list",
26991+
"responses": {
26992+
"200": {
26993+
"content": {
26994+
"application/json": {
26995+
"schema": {
26996+
"type": "object",
26997+
"additionalProperties": false,
26998+
"description": "",
26999+
"properties": {
27000+
"results": {
27001+
"type": "array",
27002+
"items": {
27003+
"type": "object",
27004+
"additionalProperties": false,
27005+
"properties": {
27006+
"createdAt": {
27007+
"type": "string",
27008+
"description": "",
27009+
"default": ""
27010+
},
27011+
"updatedAt": {
27012+
"type": "string",
27013+
"description": "",
27014+
"default": ""
27015+
},
27016+
"description": {
27017+
"type": "string",
27018+
"description": "",
27019+
"default": ""
27020+
},
27021+
"id": {
27022+
"type": "integer",
27023+
"description": "",
27024+
"default": 0
27025+
},
27026+
"locationHtmlUrl": {
27027+
"type": "string",
27028+
"description": "",
27029+
"default": ""
27030+
},
27031+
"packageHtmlUrl": {
27032+
"type": "string",
27033+
"description": "",
27034+
"default": ""
27035+
},
27036+
"purl": {
27037+
"type": "string",
27038+
"description": "",
27039+
"default": ""
27040+
},
27041+
"removedAt": {
27042+
"type": "string",
27043+
"description": "",
27044+
"default": "",
27045+
"nullable": true
27046+
},
27047+
"threatType": {
27048+
"type": "string",
27049+
"description": "",
27050+
"default": ""
27051+
},
27052+
"needsHumanReview": {
27053+
"type": "boolean",
27054+
"default": false,
27055+
"description": "Whether the threat still is in need of human review by the threat research team"
27056+
}
27057+
},
27058+
"description": ""
27059+
},
27060+
"description": ""
27061+
},
27062+
"nextPageCursor": {
27063+
"type": "string",
27064+
"description": "",
27065+
"default": "",
27066+
"nullable": true
27067+
}
27068+
},
27069+
"required": [
27070+
"nextPageCursor",
27071+
"results"
27072+
]
27073+
}
27074+
}
27075+
},
27076+
"description": "The paginated list of items in the threat feed and the next page cursor."
27077+
},
27078+
"400": {
27079+
"$ref": "#/components/responses/SocketBadRequest"
27080+
},
27081+
"401": {
27082+
"$ref": "#/components/responses/SocketUnauthorized"
27083+
},
27084+
"403": {
27085+
"$ref": "#/components/responses/SocketForbidden"
27086+
},
27087+
"404": {
27088+
"$ref": "#/components/responses/SocketNotFoundResponse"
27089+
},
27090+
"429": {
27091+
"$ref": "#/components/responses/SocketTooManyRequestsResponse"
27092+
}
27093+
},
27094+
"x-readme": {}
27095+
}
27096+
},
2682127097
"/analytics/org/{filter}": {
2682227098
"get": {
2682327099
"tags": [

0 commit comments

Comments
 (0)