Skip to content

Commit 6649b11

Browse files
nginx-nickcnginx-nickc
committed
docs: update nginx-one api spec
1 parent 186043f commit 6649b11

File tree

1 file changed

+101
-7
lines changed

1 file changed

+101
-7
lines changed

‎static/nginx-one/api/one.json

Lines changed: 101 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2201,7 +2201,7 @@
22012201
],
22022202
"responses": {
22032203
"200": {
2204-
"description": "Successfully retrieved the list of instances affected by the CVE",
2204+
"description": "Successfully retrieved the list of instances affected by the CVE.",
22052205
"content": {
22062206
"application/json": {
22072207
"schema": {
@@ -6431,6 +6431,7 @@
64316431
"required": [
64326432
"object_id",
64336433
"name",
6434+
"created_at",
64346435
"instances_count",
64356436
"config_status"
64366437
],
@@ -6442,6 +6443,11 @@
64426443
"description": "Name of the Nginx config sync group.",
64436444
"type": "string"
64446445
},
6446+
"created_at": {
6447+
"description": "The date and time when the config sync group was created.",
6448+
"type": "string",
6449+
"format": "date-time"
6450+
},
64456451
"instances_count": {
64466452
"description": "Number of instances in the Nginx config sync group.",
64476453
"type": "integer"
@@ -6485,6 +6491,7 @@
64856491
{
64866492
"object_id": "csg_-uvR3F2TQGm18jnl7bpaGw",
64876493
"name": "test-config-sync-group",
6494+
"created_at": "2023-12-05T22:30:20.220114Z",
64886495
"config_status": "in_sync",
64896496
"instances_count": 1
64906497
}
@@ -6603,7 +6610,8 @@
66036610
"example": {
66046611
"object_id": "csg_-uvR3F2TQGm18jnl7bpaGw",
66056612
"name": "test-config-sync-group",
6606-
"last_publication": "2023-12-06T22:37:24.120114Z"
6613+
"last_publication": "2023-12-06T22:37:24.120114Z",
6614+
"created_at": "2023-12-05T22:30:20.220114Z"
66076615
}
66086616
},
66096617
"InstanceObjectID": {
@@ -7184,6 +7192,7 @@
71847192
"example": {
71857193
"object_id": "csg_-uvR3F2TQGm18jnl7bpaGw",
71867194
"name": "test-config-sync-group",
7195+
"created_at": "2023-12-06T22:37:24.120114Z",
71877196
"config_status": "in_sync",
71887197
"config_version": "uvR3F2TQGm18jnl7bpaGw",
71897198
"instances": [
@@ -7874,6 +7883,13 @@
78747883
"online_instances_count": {
78757884
"description": "Total number of online instances in the control plane.",
78767885
"type": "integer"
7886+
},
7887+
"cve_severity": {
7888+
"type": "array",
7889+
"description": "An array summarizing identified Common Vulnerabilities and Exposures (CVEs) across the NGINX control plane.",
7890+
"items": {
7891+
"$ref": "#/components/schemas/CveDetails"
7892+
}
78777893
}
78787894
}
78797895
}
@@ -7911,15 +7927,37 @@
79117927
"object_id": "ecp_tgfVM3KQTxCyiDXgV38G7A",
79127928
"name": "nginx-ingress-001",
79137929
"product_version": "nginx-ingress-controller-4.0.1",
7930+
"created_at": "2023-12-06T22:37:24.120114Z",
79147931
"instances_count": 5,
7915-
"online_instances_count": 3
7932+
"online_instances_count": 3,
7933+
"cve_severity": [
7934+
{
7935+
"count": 6,
7936+
"type": "medium"
7937+
},
7938+
{
7939+
"count": 1,
7940+
"type": "high"
7941+
}
7942+
]
79167943
},
79177944
{
79187945
"object_id": "ecp_-bRQlhscTKmbUIdJaYhGJA",
79197946
"name": "nginx-ingress-002",
7947+
"created_at": "2023-12-06T22:37:24.120114Z",
79207948
"product_version": "nginx-ingress-controller-4.0.1",
79217949
"instances_count": 3,
7922-
"online_instances_count": 1
7950+
"online_instances_count": 1,
7951+
"cve_severity": [
7952+
{
7953+
"count": 2,
7954+
"type": "medium"
7955+
},
7956+
{
7957+
"count": 3,
7958+
"type": "high"
7959+
}
7960+
]
79237961
}
79247962
]
79257963
}
@@ -8002,6 +8040,7 @@
80028040
"deployment_uuid": "b9b00e37-5ee4-4361-8c61-1329f3828dd3",
80038041
"key_object_id": "key_6AT9LXyUQHyhC8kF7bVMgg",
80048042
"kubernetes_namespace": "nginx-ingress-controller",
8043+
"created_at": "2023-12-06T22:37:24.120114Z",
80058044
"cert_summary": {
80068045
"total": 9,
80078046
"valid": 1,
@@ -8045,12 +8084,41 @@
80458084
"$ref": "#/components/schemas/SummaryDisplayCount"
80468085
}
80478086
},
8087+
"CveControlPlaneSummary": {
8088+
"description": "A summary of Common Vulnerabilities and Exposures (CVEs) across the NGINX control plane.",
8089+
"type": "object",
8090+
"required": [
8091+
"severity",
8092+
"count",
8093+
"affected_control_planes"
8094+
],
8095+
"properties": {
8096+
"severity": {
8097+
"$ref": "#/components/schemas/CveSeverityType"
8098+
},
8099+
"count": {
8100+
"description": "The number of CVEs at each severity level.",
8101+
"type": "integer"
8102+
},
8103+
"affected_control_planes": {
8104+
"description": "The number of control planes affected by each CVE.",
8105+
"type": "integer"
8106+
}
8107+
}
8108+
},
80488109
"ControlPlaneSummary": {
80498110
"description": "A summary of control planes including their product names/version details.",
80508111
"type": "object",
80518112
"properties": {
80528113
"product_versions": {
80538114
"$ref": "#/components/schemas/ControlPlaneProductVersionSummary"
8115+
},
8116+
"cves": {
8117+
"description": "An array summarizing identified Common Vulnerabilities and Exposures (CVEs) across the NGINX control plane.",
8118+
"type": "array",
8119+
"items": {
8120+
"$ref": "#/components/schemas/CveControlPlaneSummary"
8121+
}
80548122
}
80558123
},
80568124
"example": {
@@ -8059,6 +8127,18 @@
80598127
"count": 10,
80608128
"name": "nginx-ingress-controller-1.0.0"
80618129
}
8130+
],
8131+
"cves": [
8132+
{
8133+
"affected_control_planes": 3,
8134+
"count": 13,
8135+
"severity": "medium"
8136+
},
8137+
{
8138+
"affected_control_planes": 2,
8139+
"count": 2,
8140+
"severity": "high"
8141+
}
80628142
]
80638143
}
80648144
},
@@ -8087,6 +8167,10 @@
80878167
"description": "Number of instances impacted by the security advisory",
80888168
"type": "integer"
80898169
},
8170+
"control_planes_impacted": {
8171+
"description": "Number of control planes impacted by the security advisory",
8172+
"type": "integer"
8173+
},
80908174
"published_at": {
80918175
"description": "The date and time when the cve was published",
80928176
"type": "string",
@@ -8119,15 +8203,17 @@
81198203
},
81208204
"NginxProduct": {
81218205
"type": "string",
8122-
"description": "NGINX product :\n * `noss` - NGINX Open Source.\n * `nplus` - NGINX PLUS.\n",
8206+
"description": "NGINX product :\n * `noss` - NGINX Open Source.\n * `nplus` - NGINX PLUS.\n * `nic` - NGINX Ingress Controller.\n",
81238207
"enum": [
81248208
"noss",
81258209
"nplus",
8210+
"nic",
81268211
"unknown"
81278212
],
81288213
"x-enum-varnames": [
81298214
"nginx_product_noss",
81308215
"nginx_product_nplus",
8216+
"nginx_product_nic",
81318217
"nginx_product_unknown"
81328218
]
81338219
},
@@ -8193,6 +8279,13 @@
81938279
"1.20.2",
81948280
"1.19.9"
81958281
]
8282+
},
8283+
{
8284+
"name": "nic",
8285+
"versions": [
8286+
"1.0.0",
8287+
"2.1.0"
8288+
]
81968289
}
81978290
],
81988291
"info": "Memory disclosure in the ngx_http_mp4_module",
@@ -8694,7 +8787,8 @@
86948787
"control_plane": {
86958788
"object_id": "ecp_CO1DdBxZToWmr3pTcaQ8QA",
86968789
"name": "nginx-ingress-001",
8697-
"product_version": "nginx-ingress-controller-4.0.1"
8790+
"product_version": "nginx-ingress-controller-4.0.1",
8791+
"created_at": "2023-12-06T22:37:24.120114Z"
86988792
},
86998793
"last_reported": "2023-12-06T22:37:24.120114Z",
87008794
"nginx_build": {
@@ -10670,9 +10764,9 @@
1067010764
"value": {
1067110765
"object_id": "csg_-uvR3F2TQGm18jnl7bpaGw",
1067210766
"name": "test-config-sync-group",
10673-
"last_reported": "2023-12-06T22:37:24.120114Z",
1067410767
"config_status": "in_sync",
1067510768
"config_version": "uvR3F2TQGm18jnl7bpaGw",
10769+
"created_at": "2023-12-06T22:37:24.120114Z",
1067610770
"instances": [
1067710771
{
1067810772
"object_id": "inst_-uvR3F2TQGm18jnl7bpaGw",

0 commit comments

Comments
 (0)