From 2279b12d7389969f3d6c5a893a3ae764e3397da4 Mon Sep 17 00:00:00 2001 From: lena-larionova Date: Wed, 9 Oct 2024 15:47:45 -0700 Subject: [PATCH 1/3] add swaggerhub integration entry --- app/_data/docs_nav_konnect.yml | 2 + app/_data/tables/konnect/integrations.yml | 4 ++ .../images/icons/third-party/swaggerhub.svg | 4 ++ .../service-catalog/integrations/github.md | 2 +- .../service-catalog/integrations/pagerduty.md | 2 +- .../integrations/swaggerhub.md | 60 +++++++++++++++++++ .../service-catalog/integrations/traceable.md | 2 +- 7 files changed, 73 insertions(+), 3 deletions(-) create mode 100644 app/assets/images/icons/third-party/swaggerhub.svg create mode 100644 app/konnect/service-catalog/integrations/swaggerhub.md diff --git a/app/_data/docs_nav_konnect.yml b/app/_data/docs_nav_konnect.yml index 347fcb628c58..33449cc1964c 100644 --- a/app/_data/docs_nav_konnect.yml +++ b/app/_data/docs_nav_konnect.yml @@ -136,6 +136,8 @@ url: /service-catalog/integrations/github/ - text: PagerDuty url: /service-catalog/integrations/pagerduty/ + - text: SwaggerHub + url: /service-catalog/integrations/swaggerhub/ - text: Traceable url: /service-catalog/integrations/traceable/ diff --git a/app/_data/tables/konnect/integrations.yml b/app/_data/tables/konnect/integrations.yml index f95c3199c4f0..961badc6ec8d 100644 --- a/app/_data/tables/konnect/integrations.yml +++ b/app/_data/tables/konnect/integrations.yml @@ -11,6 +11,10 @@ integrations: icon: traceable.svg slug: traceable description: Manage and secure services that Traceable discovers by analyzing API traffic across your entire application landscape + - name: SwaggerHub + icon: swaggerhub.svg + slug: swaggerhub + description: Expand Service Catalog functionality with SwaggerHub to visualize OpenAPI specs ##### Using this file ###### # - name: Name of the integration diff --git a/app/assets/images/icons/third-party/swaggerhub.svg b/app/assets/images/icons/third-party/swaggerhub.svg new file mode 100644 index 000000000000..5159dc794aeb --- /dev/null +++ b/app/assets/images/icons/third-party/swaggerhub.svg @@ -0,0 +1,4 @@ + + + + diff --git a/app/konnect/service-catalog/integrations/github.md b/app/konnect/service-catalog/integrations/github.md index 10045ad15ab6..e1cf2ea9671f 100644 --- a/app/konnect/service-catalog/integrations/github.md +++ b/app/konnect/service-catalog/integrations/github.md @@ -17,7 +17,7 @@ For each linked Repository, the UI can show a **Repository Summary** with simple ## Authorize the GitHub integration -1. From {{site.konnect_product_name}} select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. +1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. 2. Select **GitHub**, then **Install Github**. 3. Select **Authorize**. diff --git a/app/konnect/service-catalog/integrations/pagerduty.md b/app/konnect/service-catalog/integrations/pagerduty.md index 7a67582315cb..2716f70bbc5d 100644 --- a/app/konnect/service-catalog/integrations/pagerduty.md +++ b/app/konnect/service-catalog/integrations/pagerduty.md @@ -16,7 +16,7 @@ For each linked PagerDuty service, a summary will be provided on the Service Cat ## Authenticate the PagerDuty integration -1. From {{site.konnect_product_name}} select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. +1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. 2. Select **PagerDuty**, then **Install PagerDuty**. 3. Select **Authorize**. diff --git a/app/konnect/service-catalog/integrations/swaggerhub.md b/app/konnect/service-catalog/integrations/swaggerhub.md new file mode 100644 index 000000000000..270440d945af --- /dev/null +++ b/app/konnect/service-catalog/integrations/swaggerhub.md @@ -0,0 +1,60 @@ +--- +title: SwaggerHub Integration +content-type: reference +beta: true +discovery_support: true +discovery_default: true +bindable_entities: "SwaggerHub API version" +mechanism: "pull/ingestion model" +--- + +_Type: External_ + +The SwaggerHub integration lets you connect SwaggerHub API specs directly to your Service Catalog services. + +## Prerequisites + +You need a SwaggerHub API key to authenticate your SwaggerHub account with {{site.konnect_short_name}}. + +## Authenticate the SwaggerHub integration + +1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. +2. Select **SwaggerHub**, then **Install SwaggerHub**. +3. Select **Authorize**. + +This will take you to SwaggerHub, where you can use your SwaggerHub API key to grant {{site.konnect_short_name}} access to your account. + +## View SwaggerHub specs in Service Catalog + +You can map specs to a Service Catalog service and view them in {{site.konnect_short_name}}. + +1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Services](https://cloud.konghq.com/us/service-catalog)**. +2. Select a service, then open the **API Specs** tab. +2. Select **Add API Spec**. +3. Choose SwaggerHub as the **Source**, then pick your spec and name it. + +Once uploaded, you can view the rendered spec on the API Specs tab in structured, YAML, or JSON format, and download it in that format. + +## Resources + +Entity | Description +-------|------------- +{{page.bindable_entities}} | A [SwaggerHub API version](https://support.smartbear.com/swaggerhub/docs/en/manage-apis/versioning.html?sbsearch=API%20Versions), which is the unique version identifier for a specific API spec. + +## Discovery information + +{:.note} +> This integration will discover both public and private SwaggerHub APIs in the linked account. + + + +{% include_cached service-catalog-discovery.html + discovery_support=page.discovery_support + discovery_default=page.discovery_default + bindable_entities=page.bindable_entities + mechanism=page.mechanism %} + + + + + diff --git a/app/konnect/service-catalog/integrations/traceable.md b/app/konnect/service-catalog/integrations/traceable.md index 5d71a72cbfc3..85808f1ff063 100644 --- a/app/konnect/service-catalog/integrations/traceable.md +++ b/app/konnect/service-catalog/integrations/traceable.md @@ -14,7 +14,7 @@ The Traceable integration lets you connect Traceable entities directly to your S ## Authenticate the Traceable integration -1. From {{site.konnect_product_name}} select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. +1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. 2. Select **Traceable**, then **Install Traceable**. 3. Select **Authorize**. From c254f8ea7604b5a6321c74d44d386b06086ff4da Mon Sep 17 00:00:00 2001 From: lena-larionova <54370747+lena-larionova@users.noreply.github.com> Date: Mon, 14 Oct 2024 15:51:59 -0700 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --- app/konnect/service-catalog/integrations/swaggerhub.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/konnect/service-catalog/integrations/swaggerhub.md b/app/konnect/service-catalog/integrations/swaggerhub.md index 270440d945af..8ebd85b5bcd2 100644 --- a/app/konnect/service-catalog/integrations/swaggerhub.md +++ b/app/konnect/service-catalog/integrations/swaggerhub.md @@ -14,11 +14,11 @@ The SwaggerHub integration lets you connect SwaggerHub API specs directly to you ## Prerequisites -You need a SwaggerHub API key to authenticate your SwaggerHub account with {{site.konnect_short_name}}. +You need a [SwaggerHub API key](https://app.swaggerhub.com/settings/apiKey) to authenticate your SwaggerHub account with {{site.konnect_short_name}}. ## Authenticate the SwaggerHub integration -1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/us/service-catalog/integrations)**. +1. From the **{% konnect_icon servicehub %} Service Catalog** in {{site.konnect_product_name}}, select **[Integrations](https://cloud.konghq.com/service-catalog/integrations)**. 2. Select **SwaggerHub**, then **Install SwaggerHub**. 3. Select **Authorize**. @@ -33,7 +33,7 @@ You can map specs to a Service Catalog service and view them in {{site.konnect_s 2. Select **Add API Spec**. 3. Choose SwaggerHub as the **Source**, then pick your spec and name it. -Once uploaded, you can view the rendered spec on the API Specs tab in structured, YAML, or JSON format, and download it in that format. +Once it's uploaded, you can view the rendered spec on the API Specs tab in structured (UI), YAML, or JSON format, and download it in either YAML or JSON format. ## Resources From 56dde225d73978d59c78b6cd951a2c86e89a5974 Mon Sep 17 00:00:00 2001 From: Diana <75819066+cloudjumpercat@users.noreply.github.com> Date: Fri, 18 Oct 2024 13:42:46 -0500 Subject: [PATCH 3/3] fix broken link --- app/konnect/service-catalog/integrations/swaggerhub.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/konnect/service-catalog/integrations/swaggerhub.md b/app/konnect/service-catalog/integrations/swaggerhub.md index 8ebd85b5bcd2..e8fe4604e48d 100644 --- a/app/konnect/service-catalog/integrations/swaggerhub.md +++ b/app/konnect/service-catalog/integrations/swaggerhub.md @@ -14,7 +14,7 @@ The SwaggerHub integration lets you connect SwaggerHub API specs directly to you ## Prerequisites -You need a [SwaggerHub API key](https://app.swaggerhub.com/settings/apiKey) to authenticate your SwaggerHub account with {{site.konnect_short_name}}. +You need a SwaggerHub API key to authenticate your SwaggerHub account with {{site.konnect_short_name}}. ## Authenticate the SwaggerHub integration