Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-04-01 01:18:10 +02: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
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}
This describes the API provided to unleash-clients.

32
website/sidebars.js
View File

@ -181,11 +181,28 @@ module.exports = {
},
{
type: 'category',
label: 'APIs',
items: [
{
label: 'OpenAPI docs',
collapsed: true,
type: 'category',
link: {
title: 'Unleash Server APIs',
type: 'generated-index',
description:
'Generated API docs based on the Unleash OpenAPI schema. For the time being, some additional info can also be found in the older API docs.',
slug: '/reference/api/unleash',
},
items: require('./docs/reference/api/unleash/sidebar.js'),
},
{
type: 'category',
label: 'Legacy API docs',
link: {
type: 'doc',
id: 'reference/api/legacy/unleash/index',
},
label: 'APIs',
items: [
{
'Admin API': [
@ -214,18 +231,7 @@ module.exports = {
'reference/api/legacy/unleash/internal/health',
],
},
{
label: 'OpenAPI docs',
collapsed: true,
type: 'category',
link: {
title: 'Unleash Server APIs',
type: 'generated-index',
description:
'Generated API docs based on the Unleash OpenAPI schema. For the time being, some additional info can also be found in the older API docs.',
slug: '/reference/api/unleash',
},
items: require('./docs/reference/api/unleash/sidebar.js'),
],
},
],
},