Skip to content

Commit 70629f2

Browse files
fix(openapi): sync with openapi definition (#521)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 0ecc2b4 commit 70629f2

2 files changed

Lines changed: 10 additions & 3 deletions

File tree

openapi.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12039,6 +12039,11 @@
1203912039
"type": "string",
1204012040
"description": "",
1204112041
"default": ""
12042+
},
12043+
"workspace": {
12044+
"type": "string",
12045+
"description": "",
12046+
"default": ""
1204212047
}
1204312048
},
1204412049
"required": [
@@ -38430,7 +38435,7 @@
3843038435
]
3843138436
}
3843238437
],
38433-
"description": "This API endpoint is used to start a historical snapshot job.\nWhile snapshots are typically taken at least once a day, this endpoint can be used to start an \"on demand\" snapshot job to ensure the latest data is collected and stored for historical purposes.\n\nAn historical snapshot will contain details and raw data for the following resources:\n\n- Repositories\n- Alerts\n- Dependencies\n- Artifacts\n- Users\n- Settings\n\nHistorical snapshot data is bucketed to the nearest day which is described in more detail at: [Historical Data Endpoints](/reference/historical-data-endpoints)\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- historical:snapshots-start",
38438+
"description": "This API endpoint is used to start a historical snapshot job.\nWhile snapshots are typically taken multiple times a day for paid plans and once a day for free plans, this endpoint can be used to start an \"on demand\" snapshot job to ensure the latest data is collected and stored for historical purposes.\n\nAn historical snapshot will contain details and raw data for the following resources:\n\n- Repositories\n- Alerts\n- Dependencies\n- Artifacts\n- Users\n- Settings\n\nHistorical snapshot data is bucketed to the nearest day which is described in more detail at: [Historical Data Endpoints](/reference/historical-data-endpoints)\n\nThis endpoint consumes 10 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- historical:snapshots-start",
3843438439
"responses": {
3843538440
"200": {
3843638441
"content": {

types/api.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,7 @@ export interface paths {
896896
/**
897897
* Start historical data snapshot job (Beta)
898898
* @description This API endpoint is used to start a historical snapshot job.
899-
* While snapshots are typically taken at least once a day, this endpoint can be used to start an "on demand" snapshot job to ensure the latest data is collected and stored for historical purposes.
899+
* While snapshots are typically taken multiple times a day for paid plans and once a day for free plans, this endpoint can be used to start an "on demand" snapshot job to ensure the latest data is collected and stored for historical purposes.
900900
*
901901
* An historical snapshot will contain details and raw data for the following resources:
902902
*
@@ -5598,6 +5598,8 @@ export interface operations {
55985598
version?: string
55995599
/** @default */
56005600
release?: string
5601+
/** @default */
5602+
workspace?: string
56015603
}>
56025604
}
56035605
}
@@ -15243,7 +15245,7 @@ export interface operations {
1524315245
/**
1524415246
* Start historical data snapshot job (Beta)
1524515247
* @description This API endpoint is used to start a historical snapshot job.
15246-
* While snapshots are typically taken at least once a day, this endpoint can be used to start an "on demand" snapshot job to ensure the latest data is collected and stored for historical purposes.
15248+
* While snapshots are typically taken multiple times a day for paid plans and once a day for free plans, this endpoint can be used to start an "on demand" snapshot job to ensure the latest data is collected and stored for historical purposes.
1524715249
*
1524815250
* An historical snapshot will contain details and raw data for the following resources:
1524915251
*

0 commit comments

Comments
 (0)