Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix: Add missing items from changelog to API specs [skip-ci] #6942

Merged
merged 9 commits into from Feb 12, 2024
Merged

Fix: Add missing items from changelog to API specs [skip-ci] #6942

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5c2fbe3
Enabled on by default.
Guaris Feb 12, 2024
f9278f0
kong instance info
Guaris Feb 12, 2024
2e37c47
pattern to format, add to OSS
Guaris Feb 12, 2024
ad1e73e
update endpoitn with example
Guaris Feb 12, 2024
1ba4e71
OSS different response for endpoint
Guaris Feb 12, 2024
5e9bc53
readd edition
Guaris Feb 12, 2024
00c733e
Apply suggestions from code review
Guaris Feb 12, 2024
08084f6
update description
Guaris Feb 12, 2024
1e97a16
Apply suggestions from code review
Guaris Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
149 changes: 149 additions & 0 deletions api-specs/Gateway-EE/latest/kong-ee.yaml
View file
Open in desktop
Expand Up @@ -5777,6 +5777,153 @@ info:
version: 3.6.0
openapi: 3.0.0
paths:
/:
get:
summary: Get Kong's instance information
tags:
- Information
operationId: geInfo
description: |
Returns detailed information about the Kong gateway instance, including the full Kong configuration, available and unavailable plugins, version, edition (enterprise or community), a tagline, the unique node identifier, and other metadata.
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
version:
type: string
description: The version number of the Kong instance.
example: "2.3.3"
edition:
type: string
description: Indicates whether the Kong instance is the Community or Enterprise edition.
example: "enterprise"
tagline:
type: string
description: A tagline or slogan for the Kong instance.
example: "Welcome to Kong"
node_id:
type: string
description: A unique identifier for the node, in UUID format.
format: uuid
example: "a74d7c4f-ef83-4bbe-a5e7-3f5409f4a0b9"
hostname:
type: string
description: The hostname of the Kong node.
example: "kong-node.example.com"
timers:
type: object
description: Information about running and pending timers.
properties:
running:
type: integer
description: The number of running timers.
example: 5
pending:
type: integer
description: The number of pending timers.
example: 2
plugins:
type: object
description: Information about plugins.
properties:
available_on_server:
type: object
additionalProperties:
type: object
properties:
version:
type: string
description: The version of the plugin.
priority:
type: integer
description: The priority of the plugin.
enabled_in_cluster:
type: array
items:
type: string
description: A list of distinct plugin names enabled in the cluster.
example: ["jwt", "acl"]
lua_version:
type: string
description: The version of Lua used by the Kong instance.
example: "LuaJIT 2.1.0-beta3"
configuration:
type: object
description: A sanitized version of the Kong configuration, excluding sensitive values.
additionalProperties: true
pids:
type: object
description: Process IDs for the master process and worker processes.
properties:
master:
type: integer
description: The PID of the master process.
example: 4321
workers:
type: array
items:
type: integer
description: An array of worker process PIDs.
example: [1234, 5678]
examples:
fullExample:
summary: Example response
value:
configuration:
_debug_pg_ttl_cleanup_interval: 300
admin_acc_logs: "/usr/local/kong/logs/admin_access.log"
admin_access_log: "/dev/stdout"
admin_approved_email: "true"
admin_emails_from: "\"\""
admin_error_log: "/dev/stderr"
admin_gui_access_log: "logs/admin_gui_access.log"
admin_gui_auth_header: "******"
admin_gui_auth_login_attempts: 0
admin_gui_error_log: "logs/admin_gui_error.log"
admin_gui_flags: "{}"
admin_gui_listen:
- "0.0.0.0:8002"
- "0.0.0.0:8445 ssl"
admin_gui_origin: "http://localhost:8002"
edition: "enterprise"
hostname: "8a487998603b"
lua_version: "LuaJIT 2.1.0-20231117"
node_id: "1f257156-5e44-46e2-a618-767f5c7529e3"
pids:
master: 1
workers:
- 2382
- 2383
plugins:
available_on_server:
acl: true
acme: true
disabled_on_server:
application-registration: true
enabled_in_cluster: []
tagline: "Welcome to kong"
timers:
pending: 1
running: 1128
version: "3.6.0.0"
'401':
$ref: '#/components/responses/HTTP401Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
headers:
Server:
description: Kong's server tokens.
schema:
type: string
example: "kong/2.3.3"
/ca_certificates:
get:
description: Retrieve a list of all available Certificate Authority (CA) certificates, including the certificate ID, creation date, and other details. You can use query parameters to filter the results by size or tags, for example `/ca-certificates?size=50&tags=enterprise`.
Expand Down Expand Up @@ -11444,6 +11591,8 @@ paths:
description: |-
Retrieve usage information about a node, with some basic information about the connections being processed by the underlying nginx process, the status of the database connection, and node's memory usage.

This endpoint now listens on `127.0.0.1:8007` by default for status checks. It provides detailed metrics regarding memory usage, worker process stats, database connection status, and server connection metrics.

If you want to monitor the Kong process, since Kong is built on top of nginx, every existing nginx monitoring tool or agent can be used.
'401':
$ref: '#/components/responses/HTTP401Error'
Expand Down
132 changes: 132 additions & 0 deletions api-specs/Gateway-OSS/latest/kong-oss.yaml
View file
Open in desktop
Expand Up @@ -3563,6 +3563,138 @@ info:
version: 3.6.0
openapi: 3.0.0
paths:
/:
get:
summary: Get Kong's instance information
tags:
- Information
operationId: geInfo
description: |
Returns detailed information about the Kong gateway instance, including the full Kong configuration, available and unavailable plugins, version, edition (enterprise or community), a tagline, the unique node identifier, and other metadata.
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
version:
type: string
description: The version number of the Kong instance.
example: "2.3.3"
edition:
type: string
description: Indicates whether the Kong instance is the Community or Enterprise edition.
example: "Community"
tagline:
type: string
description: A tagline or slogan for the Kong instance.
example: "Welcome to Kong"
node_id:
type: string
description: A unique identifier for the node, in UUID format.
format: uuid
example: "a74d7c4f-ef83-4bbe-a5e7-3f5409f4a0b9"
hostname:
type: string
description: The hostname of the Kong node.
example: "kong-node.example.com"
timers:
type: object
description: Information about running and pending timers.
properties:
running:
type: integer
description: The number of running timers.
example: 5
pending:
type: integer
description: The number of pending timers.
example: 2
plugins:
type: object
description: Information about plugins.
properties:
available_on_server:
type: object
additionalProperties:
type: object
properties:
version:
type: string
description: The version of the plugin.
priority:
type: integer
description: The priority of the plugin.
enabled_in_cluster:
type: array
items:
type: string
description: A list of distinct plugin names enabled in the cluster.
example: ["jwt", "acl"]
lua_version:
type: string
description: The version of Lua used by the Kong instance.
example: "LuaJIT 2.1.0-beta3"
configuration:
type: object
description: A sanitized version of the Kong configuration, excluding sensitive values.
additionalProperties: true
pids:
type: object
description: Process IDs for the master process and worker processes.
properties:
master:
type: integer
description: The PID of the master process.
example: 4321
workers:
type: array
items:
type: integer
description: An array of worker process PIDs.
example: [1234, 5678]
examples:
openSourceExample:
summary: Open Source Edition Example Response
value:
configuration:
_debug_pg_ttl_cleanup_interval: 300
admin_acc_logs: "/usr/local/kong/logs/admin_access.log"
admin_access_log: "/dev/stdout"
edition: "enterprise"
Guaris marked this conversation as resolved.
Show resolved Hide resolved
hostname: "b8f553cfbd0c"
lua_version: "LuaJIT 2.1.0-20230410"
node_id: "39bfa49d-3394-4f8e-b9db-94b786bc4e5f"
pids:
master: 1
workers: [1278, 1279, 1280, 1281, 1282, 1283, 1284, 1285]
plugins:
available_on_server:
acl:
priority: 950
version: "3.6.0"
enabled_in_cluster: []
tagline: "Welcome to kong"
timers:
pending: 1
running: 145
version: "3.6.0"
'401':
$ref: '#/components/responses/HTTP401Error'
'405':
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
headers:
Server:
description: Kong's server tokens.
schema:
type: string
example: "kong/2.3.3"
/ca_certificates:
get:
description: Retrieve a list of all available Certificate Authority (CA) certificates, including the certificate ID, creation date, and other details. You can use query parameters to filter the results by size or tags, for example `/ca-certificates?size=50&tags=enterprise`.
Expand Down