Skip to content

Commit ceaa4d1

Browse files
authored
Merge pull request #181 from SocketDev/automated/open-api
2 parents edcf3ab + 7f5bf65 commit ceaa4d1

File tree

2 files changed

+22
-14
lines changed

2 files changed

+22
-14
lines changed

openapi.json

+6-6
Original file line numberDiff line numberDiff line change
@@ -8076,9 +8076,9 @@
80768076
"/analytics/org/{filter}": {
80778077
"get": {
80788078
"tags": [
8079-
""
8079+
"Analytics"
80808080
],
8081-
"summary": "Fetch the organization's analytics",
8081+
"summary": "Get organization analytics (unstable)",
80828082
"operationId": "getOrgAnalytics",
80838083
"parameters": [
80848084
{
@@ -8097,7 +8097,7 @@
80978097
]
80988098
}
80998099
],
8100-
"description": "This endpoint consumes 0 units of your quota.",
8100+
"description": "Get analytics data regarding the number of alerts found across all active repositories.\n\nThis endpoint consumes 0 units of your quota.",
81018101
"responses": {
81028102
"200": {
81038103
"content": {
@@ -8227,9 +8227,9 @@
82278227
"/analytics/repo/{name}/{filter}": {
82288228
"get": {
82298229
"tags": [
8230-
""
8230+
"Analytics"
82318231
],
8232-
"summary": "Fetch repository analytics",
8232+
"summary": "Get repository analytics",
82338233
"operationId": "getRepoAnalytics",
82348234
"parameters": [
82358235
{
@@ -8256,7 +8256,7 @@
82568256
]
82578257
}
82588258
],
8259-
"description": "This endpoint consumes 0 units of your quota.",
8259+
"description": "Get analytics data regarding the number of alerts found in a single repository.\n\nThis endpoint consumes 0 units of your quota.",
82608260
"responses": {
82618261
"200": {
82628262
"content": {

types/api.d.ts

+16-8
Original file line numberDiff line numberDiff line change
@@ -262,15 +262,19 @@ export interface paths {
262262
};
263263
"/analytics/org/{filter}": {
264264
/**
265-
* Fetch the organization's analytics
266-
* @description This endpoint consumes 0 units of your quota.
265+
* Get organization analytics (unstable)
266+
* @description Get analytics data regarding the number of alerts found across all active repositories.
267+
*
268+
* This endpoint consumes 0 units of your quota.
267269
*/
268270
get: operations["getOrgAnalytics"];
269271
};
270272
"/analytics/repo/{name}/{filter}": {
271273
/**
272-
* Fetch repository analytics
273-
* @description This endpoint consumes 0 units of your quota.
274+
* Get repository analytics
275+
* @description Get analytics data regarding the number of alerts found in a single repository.
276+
*
277+
* This endpoint consumes 0 units of your quota.
274278
*/
275279
get: operations["getRepoAnalytics"];
276280
};
@@ -2880,8 +2884,10 @@ export interface operations {
28802884
};
28812885
};
28822886
/**
2883-
* Fetch the organization's analytics
2884-
* @description This endpoint consumes 0 units of your quota.
2887+
* Get organization analytics (unstable)
2888+
* @description Get analytics data regarding the number of alerts found across all active repositories.
2889+
*
2890+
* This endpoint consumes 0 units of your quota.
28852891
*/
28862892
getOrgAnalytics: {
28872893
parameters: {
@@ -2940,8 +2946,10 @@ export interface operations {
29402946
};
29412947
};
29422948
/**
2943-
* Fetch repository analytics
2944-
* @description This endpoint consumes 0 units of your quota.
2949+
* Get repository analytics
2950+
* @description Get analytics data regarding the number of alerts found in a single repository.
2951+
*
2952+
* This endpoint consumes 0 units of your quota.
29452953
*/
29462954
getRepoAnalytics: {
29472955
parameters: {

0 commit comments

Comments
 (0)