Skip to content

Commit

Permalink
chore: Remove deprecated APIs (#8229)
Browse files Browse the repository at this point in the history
* remove deprecated APIs

* comment out the deprecated section on API specs page until we need it again

* update links
  • Loading branch information
lena-larionova authored Dec 9, 2024
1 parent b09f567 commit 56a4eb0
Show file tree
Hide file tree
Showing 13 changed files with 17 additions and 5,355 deletions.
3,770 changes: 0 additions & 3,770 deletions api-specs/Konnect/v2/yaml/portal-api.yaml

This file was deleted.

1,462 changes: 0 additions & 1,462 deletions api-specs/Konnect/v2/yaml/portal-rbac.yaml

This file was deleted.

4 changes: 0 additions & 4 deletions app/_api/konnect/portal/_index.md

This file was deleted.

3 changes: 0 additions & 3 deletions app/_api/konnect/runtime-groups-configuration/_index.md

This file was deleted.

3 changes: 0 additions & 3 deletions app/_api/konnect/runtime-groups/_index.md

This file was deleted.

21 changes: 1 addition & 20 deletions app/_data/docs_nav_konnect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@
- text: Portal Client API
items:
- text: API Spec
url: /konnect/api/portal/latest/
url: /konnect-portal/api/latest/
absolute_url: true
generate: false
target_blank: true
Expand All @@ -397,25 +397,6 @@
absolute_url: true
generate: false
target_blank: true
- text: Portal RBAC API
items:
- text: API Spec
url: /konnect/api/portal-rbac/latest/
absolute_url: true
generate: false
target_blank: true
- text: Deprecated APIs
items:
- text: (Deprecated) Runtime Configuration API
url: /konnect/api/runtime-groups-configuration/latest/
absolute_url: true
generate: false
target_blank: true
- text: (Deprecated) Runtime Groups API
url: /konnect/api/runtime-groups/latest/
absolute_url: true
generate: false
target_blank: true
- text: Reference
items:
- text: Filtering
Expand Down
84 changes: 0 additions & 84 deletions app/_data/konnect_oas_data.json
Original file line number Diff line number Diff line change
Expand Up @@ -310,27 +310,6 @@
}
]
},
{
"id": "2aad2bcb-8d82-43b3-abdd-1d5e6e84dbd6",
"title": "Konnect Customizable Portal",
"latestVersion": {
"name": "v2",
"id": "b4539157-4ced-4df5-affa-7d790baee356"
},
"description": "Customize your self-hosted developer portal experience.",
"documentCount": 0,
"versionCount": 1,
"versions": [
{
"id": "b4539157-4ced-4df5-affa-7d790baee356",
"created_at": "2023-04-29T22:35:19.274Z",
"updated_at": "2023-06-28T03:09:02.039Z",
"name": "v2",
"deprecated": false,
"registration_configs": []
}
]
},
{
"id": "295fef86-02f3-438a-ada1-256680ba6424",
"title": "Konnect Developer Portal",
Expand Down Expand Up @@ -423,69 +402,6 @@
}
]
},
{
"id": "2dad627f-7269-40db-ab14-01264379cec7",
"title": "Konnect Portal RBAC",
"latestVersion": {
"name": "v2",
"id": "0ecb66fc-0049-414a-a1f9-f29e8a02c696"
},
"description": "Portal RBAC can be used to create teams, collect developers into teams, and assign roles to give those teams functionality in the developer portal.",
"documentCount": 0,
"versionCount": 1,
"versions": [
{
"id": "0ecb66fc-0049-414a-a1f9-f29e8a02c696",
"created_at": "2023-01-24T20:12:45.051Z",
"updated_at": "2023-02-24T17:04:31.582Z",
"name": "v2",
"deprecated": false,
"registration_configs": []
}
]
},
{
"id": "3c38bff8-3b7b-4323-8e2e-690d35ef97e0",
"title": "Konnect Runtime Group Config (Deprecated)",
"latestVersion": {
"name": "v2",
"id": "16adcd15-493a-49b2-ad53-8c73891e29bf"
},
"description": "(Deprecated) Manage Kong Gateway services, routes, certificates, consumer and global configuration within Konnect.",
"documentCount": 0,
"versionCount": 1,
"versions": [
{
"id": "16adcd15-493a-49b2-ad53-8c73891e29bf",
"created_at": "2022-12-15T21:13:44.308Z",
"updated_at": "2023-09-19T20:52:16.144Z",
"name": "v2",
"deprecated": true,
"registration_configs": []
}
]
},
{
"id": "cd849478-4628-4bc2-abcd-5d8a83d3b5f2",
"title": "Konnect Runtime Groups (Deprecated)",
"latestVersion": {
"name": "v2",
"id": "24c1f98b-ea51-4277-9178-ca28a6aa85d9"
},
"description": "(Deprecated) Manage the runtime group entity in Konnect.",
"documentCount": 0,
"versionCount": 1,
"versions": [
{
"id": "24c1f98b-ea51-4277-9178-ca28a6aa85d9",
"created_at": "2022-11-17T20:00:05.266Z",
"updated_at": "2023-09-20T15:35:47.234Z",
"name": "v2",
"deprecated": true,
"registration_configs": []
}
]
},
{
"id": "97cb97c2-0824-4e87-a13f-2fad352d698f",
"title": "Konnect Search",
Expand Down
4 changes: 2 additions & 2 deletions app/_layouts/oas/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ <h3 class="feature-title feature-title-oas">Definitions</h3>
</section>


<h4 class="feature-title feature-title-oas feature-title-oas-deprecated">Deprecated</h4>
<!-- <h4 class="feature-title feature-title-oas feature-title-oas-deprecated">Deprecated</h4>
<section class="features">
<div class="cards-container">
{% assign deprecated_oas_pages = site.data.ssg_oas_pages | where_exp: "oas_page", "oas_page.product.deprecated?" %}
{% for oas_page in deprecated_oas_pages %}
{% include oas/card.html oas_page=oas_page %}
{% endfor %}
</div>
</section>
</section> -->
</div>
</div>
9 changes: 8 additions & 1 deletion app/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,14 @@
# API

/konnect/api/portal-rbac/latest/* /konnect/api/portal-management/latest/
/konnect/api/portal-rbac/:version/* /konnect/api/portal-management/latest/
/konnect/api/portal-rbac/:version/* /konnect/api/portal-management/latest/
/konnect/api/portal/latest/* /konnect-portal/api/latest/
/konnect/api/portal/:version/* /konnect-portal/api/latest/
/konnect/api/runtime-groups/latest/* /konnect/api/control-planes/latest/
/konnect/api/runtime-groups-configuration/latest/* /konnect/api/control-plane-configuration/latest/
/konnect/api/runtime-groups/:version/* /konnect/api/control-planes/latest/
/konnect/api/runtime-groups-configuration/:version/* /konnect/api/control-plane-configuration/latest/


# Konnect plugins

Expand Down
4 changes: 2 additions & 2 deletions app/konnect/dev-portal/customization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ You can completely customize the Dev Portal using the [open source Dev Portal cl

This self-hosted portal provides the following benefits:

* **Fully customizable:** Use the [example frontend Dev Portal application](https://github.com/Kong/konnect-portal) as a starting point and then customize Dev Portal for your needs using the [Portal API](/konnect/api/portal/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js). You can also integrate the API specs with workflows tailored to your organization's own processes.
* **Fully customizable:** Use the [example frontend Dev Portal application](https://github.com/Kong/konnect-portal) as a starting point and then customize Dev Portal for your needs using the [Portal API](/konnect-portal/api/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js). You can also integrate the API specs with workflows tailored to your organization's own processes.
* **Hosting service choice:** When you self-host, you also get to choose which hosting service you use to deploy your Dev Portal.
* **Range of customization options:** With the self-hosted Dev Portal, you determine how much you want to customize. You can choose to use the example application right out of the box, or you can use the [Portal API](/konnect/api/portal/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js) for more fine-grained control.
* **Range of customization options:** With the self-hosted Dev Portal, you determine how much you want to customize. You can choose to use the example application right out of the box, or you can use the [Portal API](/konnect-portal/api/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js) for more fine-grained control.

## Custom Dev Portal URL

Expand Down
2 changes: 1 addition & 1 deletion app/konnect/dev-portal/customization/netlify.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Once your name servers are propagated (this may take a few minutes), your Dev Po

If you want to further customize the example self-hosted Dev Portal, you can edit the settings in your forked copy of the open source {{site.konnect_short_name}} Dev Portal repository. For more information, see the [{{site.konnect_short_name}} Portal repository](https://github.com/Kong/konnect-portal).

You can also customize your Dev Portal using the [Portal API](/konnect/api/portal/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js).
You can also customize your Dev Portal using the [Portal API](/konnect-portal/api/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js).

## More information

Expand Down
4 changes: 2 additions & 2 deletions app/konnect/dev-portal/customization/self-hosted-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ You can use the open source Dev Portal to display your APIs to developers on a s

There are several benefits to keep in mind when deciding whether to use a {{site.konnect_short_name}}-hosted or self-hosted Dev Portal. The self-hosted portal provides the following benefits:

* **Fully customizable:** Use the [example frontend Dev Portal application](https://github.com/Kong/konnect-portal) as a starting point and then customize Dev Portal for your needs using the [Portal API](/konnect/api/portal/latest/). You can also integrate the API specs with workflows tailored to your organization's own processes.
* **Fully customizable:** Use the [example frontend Dev Portal application](https://github.com/Kong/konnect-portal) as a starting point and then customize Dev Portal for your needs using the [Portal API](/konnect-portal/api/latest/). You can also integrate the API specs with workflows tailored to your organization's own processes.
* **Hosting platform choice:** When you self-host, you also get to choose which hosting platform you use to deploy your Dev Portal.
* **Range of customization options:** With the self-hosted Dev Portal, you determine how much you want to customize. You can choose to use the example application right out of the box, or you can use the [Portal API](/konnect/api/portal/latest/) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js) for more fine-grained control.
* **Range of customization options:** With the self-hosted Dev Portal, you determine how much you want to customize. You can choose to use the example application right out of the box, or you can use the [Portal API](/konnect-portal/api/latest//) and [Portal SDK](https://www.npmjs.com/package/@kong/sdk-portal-js) for more fine-grained control.

## How the self-hosted Dev Portal works

Expand Down
2 changes: 1 addition & 1 deletion app/konnect/updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@ For more information, see [About Self-Hosted Dev Portal](/konnect/dev-portal/cus

**Portal Client API**
: {{site.konnect_short_name}} now supports customers' integration with Dev Portal workflows via public APIs.
For more information, see the [Portal Client API spec](/konnect/api/portal/latest/).
For more information, see the [Portal Client API spec](/konnect-portal/api/latest/).

**Audit logging**
: Konnect now provides audit logging capability, designed to enhance the security, compliance, debugging and risk management of your core infrastructure.
Expand Down

0 comments on commit 56a4eb0

Please sign in to comment.