Skip to content

Commit ccea869

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

File tree

2 files changed

+440
-0
lines changed

2 files changed

+440
-0
lines changed

‎openapi.json‎

Lines changed: 312 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,21 @@
353353
],
354354
"default": "miscellaneous"
355355
},
356+
"SocketBatchPURLFetch": {
357+
"type": "object",
358+
"additionalProperties": false,
359+
"properties": {
360+
"components": {
361+
"type": "array",
362+
"items": {
363+
"$ref": "#/components/schemas/SocketBatchPURLRequest"
364+
}
365+
}
366+
},
367+
"required": [
368+
"components"
369+
]
370+
},
356371
"SocketIssue": {
357372
"anyOf": [
358373
{
@@ -5239,6 +5254,19 @@
52395254
"score"
52405255
]
52415256
},
5257+
"SocketBatchPURLRequest": {
5258+
"type": "object",
5259+
"additionalProperties": false,
5260+
"properties": {
5261+
"purl": {
5262+
"type": "string",
5263+
"default": ""
5264+
}
5265+
},
5266+
"required": [
5267+
"purl"
5268+
]
5269+
},
52425270
"SocketIssueBasics": {
52435271
"type": "object",
52445272
"additionalProperties": false,
@@ -8307,6 +8335,290 @@
83078335
},
83088336
"x-readme": {}
83098337
}
8338+
},
8339+
"/purl": {
8340+
"post": {
8341+
"tags": [
8342+
"Artifacts"
8343+
],
8344+
"summary": "Get Packages (unstable)",
8345+
"operationId": "batchArtifactFetch",
8346+
"requestBody": {
8347+
"content": {
8348+
"application/json": {
8349+
"schema": {
8350+
"$ref": "#/components/schemas/SocketBatchPURLFetch"
8351+
}
8352+
}
8353+
},
8354+
"required": false
8355+
},
8356+
"security": [
8357+
{
8358+
"basicAuth": [
8359+
"artifacts:list"
8360+
]
8361+
}
8362+
],
8363+
"description": "Batch retrieval of package metadata and alerts by PURL strings\n\nThis endpoint consumes 100 units of your quota.",
8364+
"responses": {
8365+
"200": {
8366+
"content": {
8367+
"application/x-ndjson": {
8368+
"schema": {
8369+
"type": "object",
8370+
"additionalProperties": false,
8371+
"properties": {
8372+
"type": {
8373+
"type": "string",
8374+
"enum": [
8375+
"unknown",
8376+
"npm",
8377+
"pypi",
8378+
"golang"
8379+
],
8380+
"default": "unknown"
8381+
},
8382+
"namespace": {
8383+
"type": "string",
8384+
"default": ""
8385+
},
8386+
"name": {
8387+
"type": "string",
8388+
"default": ""
8389+
},
8390+
"version": {
8391+
"type": "string",
8392+
"default": ""
8393+
},
8394+
"subpath": {
8395+
"type": "string",
8396+
"default": ""
8397+
},
8398+
"release": {
8399+
"type": "string",
8400+
"default": ""
8401+
},
8402+
"id": {
8403+
"type": "string",
8404+
"default": ""
8405+
},
8406+
"direct": {
8407+
"type": "boolean",
8408+
"default": false
8409+
},
8410+
"manifestFiles": {
8411+
"type": "array",
8412+
"items": {
8413+
"type": "object",
8414+
"additionalProperties": false,
8415+
"properties": {
8416+
"file": {
8417+
"type": "string",
8418+
"default": ""
8419+
},
8420+
"start": {
8421+
"type": "integer",
8422+
"default": 0
8423+
},
8424+
"end": {
8425+
"type": "integer",
8426+
"default": 0
8427+
}
8428+
},
8429+
"required": [
8430+
"file"
8431+
]
8432+
}
8433+
},
8434+
"topLevelAncestors": {
8435+
"type": "array",
8436+
"items": {
8437+
"type": "string",
8438+
"default": ""
8439+
}
8440+
},
8441+
"dependencies": {
8442+
"type": "array",
8443+
"items": {
8444+
"type": "string",
8445+
"default": ""
8446+
}
8447+
},
8448+
"artifact": {
8449+
"type": "object",
8450+
"additionalProperties": false,
8451+
"properties": {
8452+
"type": {
8453+
"type": "string",
8454+
"enum": [
8455+
"unknown",
8456+
"npm",
8457+
"pypi",
8458+
"golang"
8459+
],
8460+
"default": "unknown"
8461+
},
8462+
"namespace": {
8463+
"type": "string",
8464+
"default": ""
8465+
},
8466+
"name": {
8467+
"type": "string",
8468+
"default": ""
8469+
},
8470+
"version": {
8471+
"type": "string",
8472+
"default": ""
8473+
},
8474+
"subpath": {
8475+
"type": "string",
8476+
"default": ""
8477+
},
8478+
"release": {
8479+
"type": "string",
8480+
"default": ""
8481+
},
8482+
"id": {
8483+
"type": "string",
8484+
"default": ""
8485+
}
8486+
},
8487+
"required": [
8488+
"id",
8489+
"type"
8490+
]
8491+
},
8492+
"license": {
8493+
"type": "string",
8494+
"default": ""
8495+
},
8496+
"author": {
8497+
"type": "array",
8498+
"items": {
8499+
"type": "string",
8500+
"default": ""
8501+
}
8502+
},
8503+
"size": {
8504+
"type": "number",
8505+
"default": 0
8506+
},
8507+
"score": {
8508+
"type": "object",
8509+
"additionalProperties": false,
8510+
"properties": {
8511+
"supplyChain": {
8512+
"type": "number",
8513+
"default": 0
8514+
},
8515+
"quality": {
8516+
"type": "number",
8517+
"default": 0
8518+
},
8519+
"maintenance": {
8520+
"type": "number",
8521+
"default": 0
8522+
},
8523+
"vulnerability": {
8524+
"type": "number",
8525+
"default": 0
8526+
},
8527+
"license": {
8528+
"type": "number",
8529+
"default": 0
8530+
},
8531+
"overall": {
8532+
"type": "number",
8533+
"default": 0
8534+
}
8535+
},
8536+
"required": [
8537+
"license",
8538+
"maintenance",
8539+
"overall",
8540+
"quality",
8541+
"supplyChain",
8542+
"vulnerability"
8543+
]
8544+
},
8545+
"alerts": {
8546+
"type": "array",
8547+
"items": {
8548+
"type": "object",
8549+
"additionalProperties": false,
8550+
"properties": {
8551+
"key": {
8552+
"type": "string",
8553+
"default": ""
8554+
},
8555+
"type": {
8556+
"type": "string",
8557+
"default": ""
8558+
},
8559+
"severity": {
8560+
"$ref": "#/components/schemas/SocketIssueSeverity"
8561+
},
8562+
"category": {
8563+
"$ref": "#/components/schemas/SocketCategory"
8564+
},
8565+
"file": {
8566+
"type": "string",
8567+
"default": ""
8568+
},
8569+
"start": {
8570+
"type": "integer",
8571+
"default": 0
8572+
},
8573+
"end": {
8574+
"type": "integer",
8575+
"default": 0
8576+
},
8577+
"props": {
8578+
"type": "object",
8579+
"default": null
8580+
}
8581+
},
8582+
"required": [
8583+
"category",
8584+
"key",
8585+
"severity",
8586+
"type"
8587+
]
8588+
}
8589+
},
8590+
"batchIndex": {
8591+
"type": "integer",
8592+
"default": 0
8593+
}
8594+
},
8595+
"required": [
8596+
"id",
8597+
"type"
8598+
]
8599+
}
8600+
}
8601+
},
8602+
"description": "Socket issue lists and scores for all packages"
8603+
},
8604+
"400": {
8605+
"$ref": "#/components/responses/SocketBadRequest"
8606+
},
8607+
"401": {
8608+
"$ref": "#/components/responses/SocketUnauthorized"
8609+
},
8610+
"403": {
8611+
"$ref": "#/components/responses/SocketForbidden"
8612+
},
8613+
"404": {
8614+
"$ref": "#/components/responses/SocketNotFoundResponse"
8615+
},
8616+
"429": {
8617+
"$ref": "#/components/responses/SocketTooManyRequestsResponse"
8618+
}
8619+
},
8620+
"x-readme": {}
8621+
}
83108622
}
83118623
}
83128624
}

0 commit comments

Comments
 (0)