Skip to content

Commit c994e29

Browse files
github-actions[bot]github-actions[bot]
authored
docs: synchronizing api spec with user-docs
1 parent 3c38e7a commit c994e29

File tree

3 files changed

+203
-18
lines changed

3 files changed

+203
-18
lines changed

‎docs/.gitbook/assets/rest-spec.json‎

Lines changed: 129 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@
318318
},
319319
"VersionRequestedResponseHeader": {
320320
"description": "A header containing the version of the endpoint requested by the caller.",
321-
"example": "2025-11-05",
321+
"example": "2026-03-25",
322322
"schema": {
323323
"$ref": "#/components/schemas/QueryVersion"
324324
}
@@ -334,7 +334,7 @@
334334
},
335335
"VersionServedResponseHeader": {
336336
"description": "A header containing the version of the endpoint that was served by the API.",
337-
"example": "2025-11-05",
337+
"example": "2026-03-25",
338338
"schema": {
339339
"$ref": "#/components/schemas/ActualVersion"
340340
}
@@ -1917,7 +1917,7 @@
19171917
},
19181918
"Version": {
19191919
"description": "The requested version of the endpoint to process the request",
1920-
"example": "2025-11-05",
1920+
"example": "2026-03-25",
19211921
"in": "query",
19221922
"name": "version",
19231923
"required": true,
@@ -3206,7 +3206,7 @@
32063206
},
32073207
"ActualVersion": {
32083208
"description": "Resolved API version",
3209-
"example": "2025-11-05",
3209+
"example": "2026-03-25",
32103210
"pattern": "^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$",
32113211
"type": "string"
32123212
},
@@ -19047,6 +19047,101 @@
1904719047
"type": "object"
1904819048
},
1904919049
"PolicyActionIgnoreData": {
19050+
"discriminator": {
19051+
"mapping": {
19052+
"not-vulnerable": "#/components/schemas/PolicyActionIgnoreDataNotVulnerable",
19053+
"temporary-ignore": "#/components/schemas/PolicyActionIgnoreDataTemporaryIgnore",
19054+
"wont-fix": "#/components/schemas/PolicyActionIgnoreDataWontFix"
19055+
},
19056+
"propertyName": "ignore_type"
19057+
},
19058+
"oneOf": [
19059+
{
19060+
"$ref": "#/components/schemas/PolicyActionIgnoreDataWontFix"
19061+
},
19062+
{
19063+
"$ref": "#/components/schemas/PolicyActionIgnoreDataTemporaryIgnore"
19064+
},
19065+
{
19066+
"$ref": "#/components/schemas/PolicyActionIgnoreDataNotVulnerable"
19067+
}
19068+
],
19069+
"type": "object"
19070+
},
19071+
"PolicyActionIgnoreDataNotVulnerable": {
19072+
"additionalProperties": false,
19073+
"properties": {
19074+
"expires": {
19075+
"example": "2024-03-16T00:00:00Z",
19076+
"format": "date-time",
19077+
"type": "string"
19078+
},
19079+
"ignore_type": {
19080+
"enum": [
19081+
"not-vulnerable"
19082+
],
19083+
"type": "string"
19084+
},
19085+
"reason": {
19086+
"maxLength": 10000,
19087+
"type": "string"
19088+
}
19089+
},
19090+
"required": [
19091+
"ignore_type"
19092+
],
19093+
"type": "object"
19094+
},
19095+
"PolicyActionIgnoreDataTemporaryIgnore": {
19096+
"additionalProperties": false,
19097+
"properties": {
19098+
"expires": {
19099+
"example": "2024-03-16T00:00:00Z",
19100+
"format": "date-time",
19101+
"type": "string"
19102+
},
19103+
"ignore_type": {
19104+
"enum": [
19105+
"temporary-ignore"
19106+
],
19107+
"type": "string"
19108+
},
19109+
"reason": {
19110+
"maxLength": 10000,
19111+
"type": "string"
19112+
}
19113+
},
19114+
"required": [
19115+
"ignore_type",
19116+
"expires"
19117+
],
19118+
"type": "object"
19119+
},
19120+
"PolicyActionIgnoreDataWontFix": {
19121+
"additionalProperties": false,
19122+
"properties": {
19123+
"expires": {
19124+
"example": "2024-03-16T00:00:00Z",
19125+
"format": "date-time",
19126+
"type": "string"
19127+
},
19128+
"ignore_type": {
19129+
"enum": [
19130+
"wont-fix"
19131+
],
19132+
"type": "string"
19133+
},
19134+
"reason": {
19135+
"maxLength": 10000,
19136+
"type": "string"
19137+
}
19138+
},
19139+
"required": [
19140+
"ignore_type"
19141+
],
19142+
"type": "object"
19143+
},
19144+
"PolicyActionIgnoreData__0": {
1905019145
"additionalProperties": false,
1905119146
"properties": {
1905219147
"expires": {
@@ -19072,6 +19167,18 @@
1907219167
],
1907319168
"type": "object"
1907419169
},
19170+
"PolicyActionIgnore__0": {
19171+
"additionalProperties": false,
19172+
"properties": {
19173+
"data": {
19174+
"$ref": "#/components/schemas/PolicyActionIgnoreData__0"
19175+
}
19176+
},
19177+
"required": [
19178+
"data"
19179+
],
19180+
"type": "object"
19181+
},
1907519182
"PolicyAttributes": {
1907619183
"additionalProperties": false,
1907719184
"properties": {
@@ -19222,7 +19329,7 @@
1922219329
"additionalProperties": false,
1922319330
"properties": {
1922419331
"new_action": {
19225-
"$ref": "#/components/schemas/PolicyActionIgnore"
19332+
"$ref": "#/components/schemas/PolicyActionIgnore__0"
1922619333
},
1922719334
"new_conditions_group": {
1922819335
"$ref": "#/components/schemas/PolicyConditionsGroup"
@@ -19234,7 +19341,7 @@
1923419341
"$ref": "#/components/schemas/PolicyReview"
1923519342
},
1923619343
"old_action": {
19237-
"$ref": "#/components/schemas/PolicyActionIgnore"
19344+
"$ref": "#/components/schemas/PolicyActionIgnore__0"
1923819345
},
1923919346
"old_conditions_group": {
1924019347
"$ref": "#/components/schemas/PolicyConditionsGroup"
@@ -20894,7 +21001,7 @@
2089421001
},
2089521002
"QueryVersion": {
2089621003
"description": "Requested API version",
20897-
"example": "2025-11-05",
21004+
"example": "2026-03-25",
2089821005
"pattern": "^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$",
2089921006
"type": "string"
2090021007
},
@@ -49957,11 +50064,12 @@
4995750064
],
4995850065
"x-snyk-api-lifecycle": "released",
4995950066
"x-snyk-api-releases": [
49960-
"2024-10-15"
50067+
"2024-10-15",
50068+
"2026-03-25"
4996150069
],
4996250070
"x-snyk-api-resource": "policies",
4996350071
"x-snyk-api-stability": "ga",
49964-
"x-snyk-api-version": "2024-10-15",
50072+
"x-snyk-api-version": "2026-03-25",
4996550073
"x-stability-level": "stable"
4996650074
},
4996750075
"post": {
@@ -50065,11 +50173,12 @@
5006550173
],
5006650174
"x-snyk-api-lifecycle": "released",
5006750175
"x-snyk-api-releases": [
50068-
"2024-10-15"
50176+
"2024-10-15",
50177+
"2026-03-25"
5006950178
],
5007050179
"x-snyk-api-resource": "policies",
5007150180
"x-snyk-api-stability": "ga",
50072-
"x-snyk-api-version": "2024-10-15",
50181+
"x-snyk-api-version": "2026-03-25",
5007350182
"x-stability-level": "stable"
5007450183
}
5007550184
},
@@ -50121,11 +50230,12 @@
5012150230
],
5012250231
"x-snyk-api-lifecycle": "released",
5012350232
"x-snyk-api-releases": [
50124-
"2024-10-15"
50233+
"2024-10-15",
50234+
"2026-03-25"
5012550235
],
5012650236
"x-snyk-api-resource": "policies",
5012750237
"x-snyk-api-stability": "ga",
50128-
"x-snyk-api-version": "2024-10-15",
50238+
"x-snyk-api-version": "2026-03-25",
5012950239
"x-stability-level": "stable"
5013050240
},
5013150241
"get": {
@@ -50215,11 +50325,12 @@
5021550325
],
5021650326
"x-snyk-api-lifecycle": "released",
5021750327
"x-snyk-api-releases": [
50218-
"2024-10-15"
50328+
"2024-10-15",
50329+
"2026-03-25"
5021950330
],
5022050331
"x-snyk-api-resource": "policies",
5022150332
"x-snyk-api-stability": "ga",
50222-
"x-snyk-api-version": "2024-10-15",
50333+
"x-snyk-api-version": "2026-03-25",
5022350334
"x-stability-level": "stable"
5022450335
},
5022550336
"patch": {
@@ -50326,11 +50437,12 @@
5032650437
],
5032750438
"x-snyk-api-lifecycle": "released",
5032850439
"x-snyk-api-releases": [
50329-
"2024-10-15"
50440+
"2024-10-15",
50441+
"2026-03-25"
5033050442
],
5033150443
"x-snyk-api-resource": "policies",
5033250444
"x-snyk-api-stability": "ga",
50333-
"x-snyk-api-version": "2024-10-15",
50445+
"x-snyk-api-version": "2026-03-25",
5033450446
"x-stability-level": "stable"
5033550447
}
5033650448
},

‎docs/snyk-api/changelog.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,76 @@
1+
## 2026-03-25
2+
3+
### POST - `/orgs/{org_id}/policies` - Updated
4+
- removed the required property `data/attributes/action/data/ignore_type` from the response with the `201` status
5+
![Badge](https://img.shields.io/badge/Breaking-yellow)
6+
- removed the request property `data/attributes/action/data/expires`
7+
![Badge](https://img.shields.io/badge/Breaking-yellow)
8+
- removed the request property `data/attributes/action/data/ignore_type`
9+
![Badge](https://img.shields.io/badge/Breaking-yellow)
10+
- removed the request property `data/attributes/action/data/reason`
11+
![Badge](https://img.shields.io/badge/Breaking-yellow)
12+
- removed the optional property `data/attributes/action/data/expires` from the response with the `201` status
13+
![Badge](https://img.shields.io/badge/Breaking-yellow)
14+
- removed the optional property `data/attributes/action/data/reason` from the response with the `201` status
15+
![Badge](https://img.shields.io/badge/Breaking-yellow)
16+
- added discriminator to `data/attributes/action/data` request property
17+
18+
- added `#/components/schemas/PolicyActionIgnoreDataWontFix, #/components/schemas/PolicyActionIgnoreDataTemporaryIgnore, #/components/schemas/PolicyActionIgnoreDataNotVulnerable` to the `data/attributes/action/data` request property `oneOf` list
19+
20+
- added discriminator to `data/attributes/action/data` response property for the response status `201`
21+
22+
- added `#/components/schemas/PolicyActionIgnoreDataWontFix, #/components/schemas/PolicyActionIgnoreDataTemporaryIgnore, #/components/schemas/PolicyActionIgnoreDataNotVulnerable` to the `data/attributes/action/data` response property `oneOf` list for the response status `201`
23+
24+
25+
26+
### GET - `/orgs/{org_id}/policies` - Updated
27+
- removed the required property `data/items/attributes/action/data/ignore_type` from the response with the `200` status
28+
![Badge](https://img.shields.io/badge/Breaking-yellow)
29+
- removed the optional property `data/items/attributes/action/data/expires` from the response with the `200` status
30+
![Badge](https://img.shields.io/badge/Breaking-yellow)
31+
- removed the optional property `data/items/attributes/action/data/reason` from the response with the `200` status
32+
![Badge](https://img.shields.io/badge/Breaking-yellow)
33+
- added discriminator to `data/items/attributes/action/data` response property for the response status `200`
34+
35+
- added `#/components/schemas/PolicyActionIgnoreDataWontFix, #/components/schemas/PolicyActionIgnoreDataTemporaryIgnore, #/components/schemas/PolicyActionIgnoreDataNotVulnerable` to the `data/items/attributes/action/data` response property `oneOf` list for the response status `200`
36+
37+
38+
39+
### PATCH - `/orgs/{org_id}/policies/{policy_id}` - Updated
40+
- removed the required property `data/attributes/action/data/ignore_type` from the response with the `200` status
41+
![Badge](https://img.shields.io/badge/Breaking-yellow)
42+
- removed the request property `data/attributes/action/data/expires`
43+
![Badge](https://img.shields.io/badge/Breaking-yellow)
44+
- removed the request property `data/attributes/action/data/ignore_type`
45+
![Badge](https://img.shields.io/badge/Breaking-yellow)
46+
- removed the request property `data/attributes/action/data/reason`
47+
![Badge](https://img.shields.io/badge/Breaking-yellow)
48+
- removed the optional property `data/attributes/action/data/expires` from the response with the `200` status
49+
![Badge](https://img.shields.io/badge/Breaking-yellow)
50+
- removed the optional property `data/attributes/action/data/reason` from the response with the `200` status
51+
![Badge](https://img.shields.io/badge/Breaking-yellow)
52+
- added discriminator to `data/attributes/action/data` request property
53+
54+
- added `#/components/schemas/PolicyActionIgnoreDataWontFix, #/components/schemas/PolicyActionIgnoreDataTemporaryIgnore, #/components/schemas/PolicyActionIgnoreDataNotVulnerable` to the `data/attributes/action/data` request property `oneOf` list
55+
56+
- added discriminator to `data/attributes/action/data` response property for the response status `200`
57+
58+
- added `#/components/schemas/PolicyActionIgnoreDataWontFix, #/components/schemas/PolicyActionIgnoreDataTemporaryIgnore, #/components/schemas/PolicyActionIgnoreDataNotVulnerable` to the `data/attributes/action/data` response property `oneOf` list for the response status `200`
59+
60+
61+
62+
### GET - `/orgs/{org_id}/policies/{policy_id}` - Updated
63+
- removed the required property `data/attributes/action/data/ignore_type` from the response with the `200` status
64+
![Badge](https://img.shields.io/badge/Breaking-yellow)
65+
- removed the optional property `data/attributes/action/data/expires` from the response with the `200` status
66+
![Badge](https://img.shields.io/badge/Breaking-yellow)
67+
- removed the optional property `data/attributes/action/data/reason` from the response with the `200` status
68+
![Badge](https://img.shields.io/badge/Breaking-yellow)
69+
- added discriminator to `data/attributes/action/data` response property for the response status `200`
70+
71+
- added `#/components/schemas/PolicyActionIgnoreDataWontFix, #/components/schemas/PolicyActionIgnoreDataTemporaryIgnore, #/components/schemas/PolicyActionIgnoreDataNotVulnerable` to the `data/attributes/action/data` response property `oneOf` list for the response status `200`
72+
73+
174
## 2025-11-05 - Updated 2026-03-31
275

376
### POST - `/orgs/{org_id}/export` - Updated

‎tools/api-docs-generator/sync-state.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
lastSyncedVersion: "2025-11-05"
1+
lastSyncedVersion: "2026-03-25"

0 commit comments

Comments
 (0)