|
38 | 38 | }, |
39 | 39 | { |
40 | 40 | "name": "Certificates", |
41 | | - "description": "The `Certificates` object in the NGINX One console represents an SSL certificate, covering both managed and unmanaged types. \nYou can view essential details like issuer, expiration status, and the instances or config sync groups where each certificate is deployed.\n", |
| 41 | + "description": "The `Certificates` object in NGINX One Console represents an SSL certificate, covering both managed and unmanaged types. \nYou can view essential details like issuer, expiration status, and the instances or config sync groups where each certificate is deployed.\n", |
42 | 42 | "x-displayName": "Certificates" |
43 | 43 | }, |
44 | 44 | { |
|
48 | 48 | }, |
49 | 49 | { |
50 | 50 | "name": "Events", |
51 | | - "description": "Get a list of system events in the NGINX One console.\n", |
| 51 | + "description": "Get a list of system events in NGINX One Console.\n", |
52 | 52 | "x-displayName": "Events" |
53 | 53 | }, |
54 | 54 | { |
|
616 | 616 | ], |
617 | 617 | "summary": "Delete an SSL certificate", |
618 | 618 | "operationId": "deleteCertificate", |
619 | | - "description": "Deletes a managed SSL certificate from the NGINX One console. This operation is disabled for unmanaged certificates, as they get cleaned up automatically when they are not used in any NGINX configuration.", |
| 619 | + "description": "Deletes a managed SSL certificate from NGINX One Console. This operation is disabled for unmanaged certificates, as they get cleaned up automatically when they are not used in any NGINX configuration.", |
620 | 620 | "responses": { |
621 | 621 | "204": { |
622 | 622 | "description": "Successfully deleted the SSL certificate." |
|
1127 | 1127 | "Config Sync Groups" |
1128 | 1128 | ], |
1129 | 1129 | "summary": "Delete an NGINX config sync group", |
1130 | | - "description": "Delete a NGINX config sync group from the NGINX One console. You can delete a config sync group, only if it contains no NGINX instances.\n", |
| 1130 | + "description": "Delete a NGINX config sync group from NGINX One Console. You can delete a config sync group, only if it contains no NGINX instances.\n", |
1131 | 1131 | "operationId": "deleteConfigSyncGroup", |
1132 | 1132 | "responses": { |
1133 | 1133 | "204": { |
|
1702 | 1702 | "Config Sync Groups" |
1703 | 1703 | ], |
1704 | 1704 | "summary": "Retrieves stored NGINX configurations for a NGINX config sync group", |
1705 | | - "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.", |
| 1705 | + "description": "Returns a list of all configurations for a NGINX config sync group. Only the last 5 are kept on NGINX One Console for a NGINX config sync group.", |
1706 | 1706 | "operationId": "listConfigSyncGroupConfigurations", |
1707 | 1707 | "responses": { |
1708 | 1708 | "200": { |
|
2811 | 2811 | "Instances" |
2812 | 2812 | ], |
2813 | 2813 | "summary": "Retrieves the stored NGINX configurations for an instance", |
2814 | | - "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.", |
| 2814 | + "description": "Returns a list of all configurations for a NGINX instance. Only the last 5 are kept on NGINX One Console for a NGINX instance.", |
2815 | 2815 | "operationId": "listInstanceConfigurations", |
2816 | 2816 | "responses": { |
2817 | 2817 | "200": { |
|
3731 | 3731 | "properties": { |
3732 | 3732 | "total": { |
3733 | 3733 | "type": "integer", |
3734 | | - "description": "The absolute total number of the resource in the NGINX One Console.\n" |
| 3734 | + "description": "The absolute total number of the resource in NGINX One Console.\n" |
3735 | 3735 | }, |
3736 | 3736 | "count": { |
3737 | 3737 | "type": "integer", |
|
4078 | 4078 | }, |
4079 | 4079 | "CertificateType": { |
4080 | 4080 | "type": "string", |
4081 | | - "description": "Certificate type:\n * `ca_bundle` - This certificate object is a CA bundle.\n * `cert_key` - This certificate object is consisted of public certificates and key.\n * `unmanaged` - This certificate is not managed by NGINX One console and its type is unmanaged.\n", |
| 4081 | + "description": "Certificate type:\n * `ca_bundle` - This certificate object is a CA bundle.\n * `cert_key` - This certificate object is consisted of public certificates and key.\n * `unmanaged` - This certificate is not managed by NGINX One Console and its type is unmanaged.\n", |
4082 | 4082 | "enum": [ |
4083 | 4083 | "ca_bundle", |
4084 | 4084 | "cert_key", |
|
5535 | 5535 | }, |
5536 | 5536 | "NginxConfigPayloads": { |
5537 | 5537 | "type": "array", |
5538 | | - "description": "An array of payloads that track the file paths of each SSL certificates and key, indicating where to deploy\nthem onto the data plane instance.\n* If the `type` is `managed_certificate` or `managed_key`, you need to specify an `object_id`.\n * The `object_id` must represent a managed certificate object, or a `400 Bad Request` is returned. \n * The `contents` field is optional and is ignored if included.\n* The NGINX One Console manages deployed file paths only for managed certificates and keys. If you don't want \nthem to be managed by NGINX One Console, `inline_content` and `inline_secret` can be used for certificates or \nkeys, respectively. When you retrieve certificate deployment details, only the file paths of managed \ncertificates and keys will be shown.\n* If you use `inline_content` and `inline_secret` in your NGINX configuration, the NGINX One Console \nwill detect them. When they are used as SSL directives of the NGINX configuration \nfor certificates and keys, the certificates will be listed as `unmanaged_certificate` in the certificate \ndeployment details.\n", |
| 5538 | + "description": "An array of payloads that track the file paths of each SSL certificates and key, indicating where to deploy\nthem onto the data plane instance.\n* If the `type` is `managed_certificate` or `managed_key`, you need to specify an `object_id`.\n * The `object_id` must represent a managed certificate object, or a `400 Bad Request` is returned. \n * The `contents` field is optional and is ignored if included.\n* NGINX One Console manages deployed file paths only for managed certificates and keys. If you don't want \nthem to be managed by NGINX One Console, `inline_content` and `inline_secret` can be used for certificates or \nkeys, respectively. When you retrieve certificate deployment details, only the file paths of managed \ncertificates and keys will be shown.\n* If you use `inline_content` and `inline_secret` in your NGINX configuration, NGINX One Console \nwill detect them. When they are used as SSL directives of the NGINX configuration \nfor certificates and keys, the certificates will be listed as `unmanaged_certificate` in the certificate \ndeployment details.\n", |
5539 | 5539 | "items": { |
5540 | 5540 | "$ref": "#/components/schemas/NginxConfigPayload" |
5541 | 5541 | }, |
|
0 commit comments