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.

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

feat: swaggerhub integration #8038

Merged
merged 4 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions app/_data/docs_nav_konnect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand Down
4 changes: 4 additions & 0 deletions app/_data/tables/konnect/integrations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions app/assets/images/icons/third-party/swaggerhub.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion app/konnect/service-catalog/integrations/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand Down
2 changes: 1 addition & 1 deletion app/konnect/service-catalog/integrations/pagerduty.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand Down
60 changes: 60 additions & 0 deletions app/konnect/service-catalog/integrations/swaggerhub.md
Original file line number Diff line number Diff line change
@@ -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](https://app.swaggerhub.com/settings/apiKey) to authenticate your SwaggerHub account with {{site.konnect_short_name}}.
cloudjumpercat marked this conversation as resolved.
Show resolved Hide resolved

## Authenticate the SwaggerHub integration

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**.

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 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

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.

<!-- vale off-->

{% include_cached service-catalog-discovery.html
discovery_support=page.discovery_support
discovery_default=page.discovery_default
bindable_entities=page.bindable_entities
mechanism=page.mechanism %}

<!-- vale on-->



2 changes: 1 addition & 1 deletion app/konnect/service-catalog/integrations/traceable.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand Down