Skip to content

Commit 8fa5690

Browse files
committed
docs: fix casing for NGINX
1 parent 79fd181 commit 8fa5690

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

static/nginx-one/api/one.json

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
},
5959
{
6060
"name": "Control Planes",
61-
"description": "The `Control Planes` object represents an external control plane such as NGINX Ingress Controller.\nFrom this endpoint, you can get detailed information about each control plane, including its Nginx instances, configurations, security advisories, and operational status.\n",
61+
"description": "The `Control Planes` object represents an external control plane such as NGINX Ingress Controller.\nFrom this endpoint, you can get detailed information about each control plane, including its NGINX instances, configurations, security advisories, and operational status.\n",
6262
"x-displayName": "Control Planes"
6363
},
6464
{
@@ -1736,7 +1736,7 @@
17361736
"Config Sync Groups"
17371737
],
17381738
"summary": "Retrieves stored NGINX configurations for a NGINX config sync group",
1739-
"description": "Returns a list of all configurations for a NGINX config sync group. Only the last 5 are kept on the NGINX One Console for a NGINX config sync group.",
1739+
"description": "Returns a list of all configurations for a NGINX config sync group. Only the last 10 are kept on the NGINX One Console for a NGINX config sync group.",
17401740
"operationId": "listConfigSyncGroupConfigurations",
17411741
"responses": {
17421742
"200": {
@@ -2990,7 +2990,7 @@
29902990
"Instances"
29912991
],
29922992
"summary": "Retrieves the stored NGINX configurations for an instance",
2993-
"description": "Returns a list of all configurations for a NGINX instance. Only the last 5 are kept on the NGINX One Console for a NGINX instance.",
2993+
"description": "Returns a list of all configurations for a NGINX instance. Only the last 10 are kept on the NGINX One Console for a NGINX instance.",
29942994
"operationId": "listInstanceConfigurations",
29952995
"responses": {
29962996
"200": {
@@ -6378,7 +6378,7 @@
63786378
},
63796379
"ConfigSyncStatus": {
63806380
"type": "string",
6381-
"description": "The current config sync status of the NGINX config sync group, with the following possible values:\n* `unknown` - The status cannot be determined at this moment.\n* `in_sync` - All Nginx instances in config sync group have same config as indicated by config_version.\n* `out_of_sync` - Some Nginx instances in config sync group have config different than indicated by config_version.\n* `sync_in_progress` - The operation of applying config_version to all Nginx instances in config sync group is in progress.\n",
6381+
"description": "The current config sync status of the NGINX config sync group, with the following possible values:\n* `unknown` - The status cannot be determined at this moment.\n* `in_sync` - All NGINX instances in config sync group have same config as indicated by config_version.\n* `out_of_sync` - Some NGINX instances in config sync group have config different than indicated by config_version.\n* `sync_in_progress` - The operation of applying config_version to all NGINX instances in config sync group is in progress.\n",
63826382
"enum": [
63836383
"unknown",
63846384
"in_sync",
@@ -6440,7 +6440,7 @@
64406440
"$ref": "#/components/schemas/ConfigSyncGroupObjectID"
64416441
},
64426442
"name": {
6443-
"description": "Name of the Nginx config sync group.",
6443+
"description": "Name of the NGINX config sync group.",
64446444
"type": "string"
64456445
},
64466446
"created_at": {
@@ -6449,7 +6449,7 @@
64496449
"format": "date-time"
64506450
},
64516451
"instances_count": {
6452-
"description": "Number of instances in the Nginx config sync group.",
6452+
"description": "Number of instances in the NGINX config sync group.",
64536453
"type": "integer"
64546454
},
64556455
"config_status": {
@@ -6467,7 +6467,7 @@
64676467
},
64686468
{
64696469
"type": "object",
6470-
"description": "List of Nginx config sync groups.",
6470+
"description": "List of NGINX config sync groups.",
64716471
"required": [
64726472
"items"
64736473
],
@@ -6499,14 +6499,14 @@
64996499
}
65006500
},
65016501
"ConfigSyncGroupCreateRequest": {
6502-
"description": "Body to create a Nginx config sync group.",
6502+
"description": "Body to create a NGINX config sync group.",
65036503
"required": [
65046504
"name"
65056505
],
65066506
"properties": {
65076507
"name": {
65086508
"type": "string",
6509-
"description": "A name to uniquely identify the Nginx config sync group in a given tenant namespace.",
6509+
"description": "A name to uniquely identify the NGINX config sync group in a given tenant namespace.",
65106510
"minLength": 1,
65116511
"maxLength": 256
65126512
}
@@ -6516,7 +6516,7 @@
65166516
}
65176517
},
65186518
"ConfigSyncGroupCreateResponse": {
6519-
"description": "Response to a create Nginx config sync group request.",
6519+
"description": "Response to a create NGINX config sync group request.",
65206520
"required": [
65216521
"object_id",
65226522
"name"
@@ -6526,7 +6526,7 @@
65266526
"$ref": "#/components/schemas/ConfigSyncGroupObjectID"
65276527
},
65286528
"name": {
6529-
"description": "Name of the Nginx config sync group.",
6529+
"description": "Name of the NGINX config sync group.",
65306530
"type": "string"
65316531
}
65326532
},
@@ -6593,7 +6593,7 @@
65936593
"$ref": "#/components/schemas/ConfigSyncGroupObjectID"
65946594
},
65956595
"name": {
6596-
"description": "Name of the Nginx config sync group.",
6596+
"description": "Name of the NGINX config sync group.",
65976597
"type": "string"
65986598
},
65996599
"last_publication": {
@@ -8307,7 +8307,7 @@
83078307
"$ref": "#/components/schemas/NginxProduct"
83088308
},
83098309
"version": {
8310-
"description": "version of the Nginx product installed on the instance.",
8310+
"description": "version of the NGINX product installed on the instance.",
83118311
"type": "string"
83128312
}
83138313
}
@@ -8988,7 +8988,7 @@
89888988
],
89898989
"properties": {
89908990
"total": {
8991-
"description": "Total count of certificates used as `payloads` in Nginx config.",
8991+
"description": "Total count of certificates used as `payloads` in NGINX config.",
89928992
"type": "integer"
89938993
},
89948994
"expired": {

0 commit comments

Comments
 (0)