From a0da0e7f0286a766b7a42e3cd87df2ae7c4457ed Mon Sep 17 00:00:00 2001 From: lena-larionova Date: Mon, 10 Feb 2025 10:20:05 -0800 Subject: [PATCH 1/2] fix versioning issues with specs and insomnia buttons --- api-specs/Gateway-EE/3.9/kong-ee.yaml | 2 +- api-specs/Gateway-EE/latest/kong-ee.yaml | 2 +- api-specs/Gateway-OSS/3.9/kong-oss.yaml | 2 +- api-specs/Gateway-OSS/latest/kong-oss.yaml | 2 +- app/_data/kong_versions.yml | 7 +++++++ app/_src/gateway/admin-api/index_latest.md | 16 ++++++++++++++-- 6 files changed, 25 insertions(+), 6 deletions(-) diff --git a/api-specs/Gateway-EE/3.9/kong-ee.yaml b/api-specs/Gateway-EE/3.9/kong-ee.yaml index 0362249bd60d..01adc8cad5f6 100644 --- a/api-specs/Gateway-EE/3.9/kong-ee.yaml +++ b/api-specs/Gateway-EE/3.9/kong-ee.yaml @@ -6236,7 +6236,7 @@ info: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' title: Enterprise Kong Admin API - version: 3.8.0 + version: 3.9.0 openapi: 3.0.0 paths: /: diff --git a/api-specs/Gateway-EE/latest/kong-ee.yaml b/api-specs/Gateway-EE/latest/kong-ee.yaml index ad4c82b380dd..3f71208fdc86 100644 --- a/api-specs/Gateway-EE/latest/kong-ee.yaml +++ b/api-specs/Gateway-EE/latest/kong-ee.yaml @@ -6112,7 +6112,7 @@ info: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' title: Enterprise Kong Admin API - version: 3.8.0 + version: 3.9.0 openapi: 3.0.0 paths: /: diff --git a/api-specs/Gateway-OSS/3.9/kong-oss.yaml b/api-specs/Gateway-OSS/3.9/kong-oss.yaml index de2567efbedc..19e56c624b99 100644 --- a/api-specs/Gateway-OSS/3.9/kong-oss.yaml +++ b/api-specs/Gateway-OSS/3.9/kong-oss.yaml @@ -3622,7 +3622,7 @@ info: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' title: Kong Admin API - version: 3.8.0 + version: 3.9.0 openapi: 3.0.0 paths: /: diff --git a/api-specs/Gateway-OSS/latest/kong-oss.yaml b/api-specs/Gateway-OSS/latest/kong-oss.yaml index 51674705c513..d689ea42e9f7 100644 --- a/api-specs/Gateway-OSS/latest/kong-oss.yaml +++ b/api-specs/Gateway-OSS/latest/kong-oss.yaml @@ -3622,7 +3622,7 @@ info: name: Apache 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0.html' title: Kong Admin API - version: 3.8.0 + version: 3.9.0 openapi: 3.0.0 paths: /: diff --git a/app/_data/kong_versions.yml b/app/_data/kong_versions.yml index 6e63eb50c181..659f86b5df6e 100644 --- a/app/_data/kong_versions.yml +++ b/app/_data/kong_versions.yml @@ -57,6 +57,7 @@ pcre: 8.45 lua_doc: true - release: "3.4.x" + short-version: "3.4" ee-version: "3.4.3.16" ce-version: "3.4.2" edition: "gateway" @@ -72,6 +73,7 @@ lua_doc: true lts: true - release: "3.5.x" + short-version: "3.5" ee-version: "3.5.0.7" ce-version: "3.5.0" edition: "gateway" @@ -86,6 +88,7 @@ pcre: 8.45 lua_doc: true - release: "3.6.x" + short-version: "3.6" ee-version: "3.6.1.8" ce-version: "3.6.1" edition: "gateway" @@ -100,6 +103,7 @@ pcre: 8.45 lua_doc: true - release: "3.7.x" + short-version: "3.7" ee-version: "3.7.1.3" ce-version: "3.7.1" edition: "gateway" @@ -114,6 +118,7 @@ pcre: 8.45 lua_doc: true - release: "3.8.x" + short-version: "3.8" ee-version: "3.8.1.0" ce-version: "3.8.1" edition: "gateway" @@ -128,6 +133,7 @@ pcre: 8.45 lua_doc: true - release: "3.9.x" + short-version: "3.9" ee-version: "3.9.0.1" ce-version: "3.9.0" edition: "gateway" @@ -143,6 +149,7 @@ lua_doc: true latest: true - release: "3.10.x" + short-version: "3.10" ee-version: "3.10.0.0" ce-version: "3.10.0" edition: "gateway" diff --git a/app/_src/gateway/admin-api/index_latest.md b/app/_src/gateway/admin-api/index_latest.md index 2a3fe8143042..174eef109007 100644 --- a/app/_src/gateway/admin-api/index_latest.md +++ b/app/_src/gateway/admin-api/index_latest.md @@ -20,10 +20,22 @@ title: Kong Gateway Admin API The Kong Admin API is documented in OpenAPI format: +{% if_version lte:3.7.x %} + +| Spec | Insomnia link | +|-------|---------------| +| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} | Run in Insomnia | +| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia | + +{% endif_version %} +{% if_version gte:3.8.x %} + | Spec | Insomnia link | |-------|---------------| -| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} |Run in Insomnia | -| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia| +| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} |Run in Insomnia | +| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia | + +{% endif_version %} See the following links for individual entity documentation: From 43be2939ec22af48ffc797a6a23f53f11e8f0619 Mon Sep 17 00:00:00 2001 From: lena-larionova Date: Mon, 10 Feb 2025 10:39:49 -0800 Subject: [PATCH 2/2] dynamically generate short version --- app/_data/kong_versions.yml | 7 ------- app/_plugins/generators/pages/version_data.rb | 3 +++ app/_src/gateway/admin-api/index_latest.md | 8 ++++---- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/app/_data/kong_versions.yml b/app/_data/kong_versions.yml index 659f86b5df6e..6e63eb50c181 100644 --- a/app/_data/kong_versions.yml +++ b/app/_data/kong_versions.yml @@ -57,7 +57,6 @@ pcre: 8.45 lua_doc: true - release: "3.4.x" - short-version: "3.4" ee-version: "3.4.3.16" ce-version: "3.4.2" edition: "gateway" @@ -73,7 +72,6 @@ lua_doc: true lts: true - release: "3.5.x" - short-version: "3.5" ee-version: "3.5.0.7" ce-version: "3.5.0" edition: "gateway" @@ -88,7 +86,6 @@ pcre: 8.45 lua_doc: true - release: "3.6.x" - short-version: "3.6" ee-version: "3.6.1.8" ce-version: "3.6.1" edition: "gateway" @@ -103,7 +100,6 @@ pcre: 8.45 lua_doc: true - release: "3.7.x" - short-version: "3.7" ee-version: "3.7.1.3" ce-version: "3.7.1" edition: "gateway" @@ -118,7 +114,6 @@ pcre: 8.45 lua_doc: true - release: "3.8.x" - short-version: "3.8" ee-version: "3.8.1.0" ce-version: "3.8.1" edition: "gateway" @@ -133,7 +128,6 @@ pcre: 8.45 lua_doc: true - release: "3.9.x" - short-version: "3.9" ee-version: "3.9.0.1" ce-version: "3.9.0" edition: "gateway" @@ -149,7 +143,6 @@ lua_doc: true latest: true - release: "3.10.x" - short-version: "3.10" ee-version: "3.10.0.0" ce-version: "3.10.0" edition: "gateway" diff --git a/app/_plugins/generators/pages/version_data.rb b/app/_plugins/generators/pages/version_data.rb index b2a45e0ee77b..c9b6b6b99ab2 100644 --- a/app/_plugins/generators/pages/version_data.rb +++ b/app/_plugins/generators/pages/version_data.rb @@ -49,6 +49,9 @@ def set_release_data # rubocop:disable Metrics/AbcSize # Add a `major_minor_version` property which is used for cloudsmith install pages @page.data['major_minor_version'] = release.value.gsub('.x', '').gsub('.', '') + + # Add a `short_version` property which is used for spec filenames + @page.data['short_version'] = release.value.gsub('.x', '') end def release diff --git a/app/_src/gateway/admin-api/index_latest.md b/app/_src/gateway/admin-api/index_latest.md index 174eef109007..4fc806fad087 100644 --- a/app/_src/gateway/admin-api/index_latest.md +++ b/app/_src/gateway/admin-api/index_latest.md @@ -24,16 +24,16 @@ The Kong Admin API is documented in OpenAPI format: | Spec | Insomnia link | |-------|---------------| -| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} | Run in Insomnia | -| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia | +| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} | Run in Insomnia | +| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia | {% endif_version %} {% if_version gte:3.8.x %} | Spec | Insomnia link | |-------|---------------| -| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} |Run in Insomnia | -| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia | +| [Enterprise API](/gateway/api/admin-ee/latest/){:target="_blank"} |Run in Insomnia | +| [Open source API](/gateway/api/admin-oss/latest/){:target="_blank"} | Run in Insomnia | {% endif_version %}