Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-20 00:08:02 +01:00
Code Issues Projects Releases Wiki Activity

docs: switch order of api doc sidebar items; put legacy docs under legacy header (#4135)

Browse Source 
Also adds a caution admonition to the legacy doc index page
This commit is contained in:
Thomas Heartman 2023-07-04 14:19:34 +02:00 committed by GitHub
parent 1bee81b475
commit 9c7eadded0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/docs/reference/api/legacy/unleash/index.md
View File

@ -1,8 +1,14 @@
--- ---
id: index id: index
title: API Documentation title: Legacy API Documentation
--- ---
:::caution
The docs in this category are legacy documentation. You should prefer to use the [Unleash OpenAPI docs](/reference/api/unleash) instead whenever possible.
:::
## Client API {#client-api} ## Client API {#client-api}
This describes the API provided to unleash-clients. This describes the API provided to unleash-clients.

68
website/sidebars.js
View File

@ -181,39 +181,8 @@ module.exports = {
}, },
{ {
type: 'category', type: 'category',
link: {
type: 'doc',
id: 'reference/api/legacy/unleash/index',
},
label: 'APIs', label: 'APIs',
items: [ items: [
{
'Admin API': [
'reference/api/legacy/unleash/admin/addons',
'reference/api/legacy/unleash/admin/context',
'reference/api/legacy/unleash/admin/events',
'reference/api/legacy/unleash/admin/features-v2',
'reference/api/legacy/unleash/admin/feature-types',
'reference/api/legacy/unleash/admin/features',
'reference/api/legacy/unleash/admin/archive',
'reference/api/legacy/unleash/admin/metrics',
'reference/api/legacy/unleash/admin/projects',
'reference/api/legacy/unleash/admin/segments',
'reference/api/legacy/unleash/admin/state',
'reference/api/legacy/unleash/admin/strategies',
'reference/api/legacy/unleash/admin/tags',
'reference/api/legacy/unleash/admin/user-admin',
],
'Client API': [
'reference/api/legacy/unleash/client/features',
'reference/api/legacy/unleash/client/metrics',
'reference/api/legacy/unleash/client/register',
],
'System API': [
'reference/api/legacy/unleash/internal/prometheus',
'reference/api/legacy/unleash/internal/health',
],
},
{ {
label: 'OpenAPI docs', label: 'OpenAPI docs',
collapsed: true, collapsed: true,
@ -227,6 +196,43 @@ module.exports = {
}, },
items: require('./docs/reference/api/unleash/sidebar.js'), items: require('./docs/reference/api/unleash/sidebar.js'),
}, },
{
type: 'category',
label: 'Legacy API docs',
link: {
type: 'doc',
id: 'reference/api/legacy/unleash/index',
},
items: [
{
'Admin API': [
'reference/api/legacy/unleash/admin/addons',
'reference/api/legacy/unleash/admin/context',
'reference/api/legacy/unleash/admin/events',
'reference/api/legacy/unleash/admin/features-v2',
'reference/api/legacy/unleash/admin/feature-types',
'reference/api/legacy/unleash/admin/features',
'reference/api/legacy/unleash/admin/archive',
'reference/api/legacy/unleash/admin/metrics',
'reference/api/legacy/unleash/admin/projects',
'reference/api/legacy/unleash/admin/segments',
'reference/api/legacy/unleash/admin/state',
'reference/api/legacy/unleash/admin/strategies',
'reference/api/legacy/unleash/admin/tags',
'reference/api/legacy/unleash/admin/user-admin',
],
'Client API': [
'reference/api/legacy/unleash/client/features',
'reference/api/legacy/unleash/client/metrics',
'reference/api/legacy/unleash/client/register',
],
'System API': [
'reference/api/legacy/unleash/internal/prometheus',
'reference/api/legacy/unleash/internal/health',
],
},
],
},
], ],
}, },
{ {