Skip to content

fix API reference formatting #609

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.

Sign up for GitHub

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

Open
maciaszczykm wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix API reference formatting #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
369f368
fix API reference formatting
maciaszczykm Jun 11, 2026
1d75764
fix lint
maciaszczykm Jun 11, 2026
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
30 changes: 15 additions & 15 deletions generated/routes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
},
"/getting-started/advanced-config/private-ca": {
"relPath": "/getting-started/advanced-config/private-ca.md",
"lastmod": "2025-03-12T14:59:41.000Z"
"lastmod": "2026-06-02T22:54:32.000Z"
},
"/api-reference": {
"relPath": "/api-reference/index.md",
Expand All @@ -105,11 +105,11 @@
},
"/api-reference/kubernetes/management-api-reference": {
"relPath": "/api-reference/kubernetes/management-api-reference.md",
"lastmod": "2026-05-26T01:35:03.000Z"
"lastmod": "2026-06-10T12:45:04.000Z"
},
"/api-reference/kubernetes/agent-api-reference": {
"relPath": "/api-reference/kubernetes/agent-api-reference.md",
"lastmod": "2026-05-26T01:35:03.000Z"
"lastmod": "2026-06-10T12:45:04.000Z"
},
"/api-reference/graphql": {
"relPath": "/api-reference/graphql.md",
Expand Down Expand Up @@ -153,11 +153,11 @@
},
"/plural-features/continuous-deployment/service-templating": {
"relPath": "/plural-features/continuous-deployment/service-templating/index.md",
"lastmod": "2026-05-27T14:33:34.869Z"
"lastmod": "2026-06-11T11:13:44.082Z"
},
"/plural-features/continuous-deployment/service-templating/supporting-liquid-filters": {
"relPath": "/plural-features/continuous-deployment/service-templating/supporting-liquid-filters.md",
"lastmod": "2026-05-27T14:33:34.891Z"
"lastmod": "2026-06-11T11:13:44.104Z"
},
"/plural-features/continuous-deployment/lua": {
"relPath": "/plural-features/continuous-deployment/lua.md",
Expand Down Expand Up @@ -321,31 +321,31 @@
},
"/plural-features/workbenches": {
"relPath": "/plural-features/workbenches/index.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/workbenches/configuration": {
"relPath": "/plural-features/workbenches/configuration.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/workbenches/coding-agent": {
"relPath": "/plural-features/workbenches/coding-agent.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/workbenches/tools": {
"relPath": "/plural-features/workbenches/tools.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/workbenches/running-jobs": {
"relPath": "/plural-features/workbenches/running-jobs.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/workbenches/automation": {
"relPath": "/plural-features/workbenches/automation.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/workbenches/use-cases": {
"relPath": "/plural-features/workbenches/use-cases.md",
"lastmod": "2026-05-27T14:33:27.000Z"
"lastmod": "2026-05-27T21:33:58.000Z"
},
"/plural-features/observability": {
"relPath": "/plural-features/observability/index.md",
Expand Down Expand Up @@ -533,7 +533,7 @@
},
"/deployments/private-ca": {
"relPath": "/getting-started/advanced-config/private-ca.md",
"lastmod": "2025-03-12T14:59:41.000Z"
"lastmod": "2026-06-02T22:54:32.000Z"
},
"/deployments/operator/architecture": {
"relPath": "/plural-features/continuous-deployment/deployment-operator.md",
Expand Down Expand Up @@ -661,10 +661,10 @@
},
"/management-api-reference": {
"relPath": "/api-reference/kubernetes/management-api-reference.md",
"lastmod": "2026-05-26T01:35:03.000Z"
"lastmod": "2026-06-10T12:45:04.000Z"
},
"/agent-api-reference": {
"relPath": "/api-reference/kubernetes/agent-api-reference.md",
"lastmod": "2026-05-26T01:35:03.000Z"
"lastmod": "2026-06-10T12:45:04.000Z"
}
}
14 changes: 12 additions & 2 deletions src/components/RestApiReference/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { useMemo, useState } from 'react'
import { Breadcrumbs, CheckIcon, CopyIcon, Tab } from '@pluralsh/design-system'
import { useRouter } from 'next/router'

import styled from 'styled-components'

import { mqs } from '@src/components/Breakpoints'
import { PageDivider } from '@src/components/MainContent'
import {
ContentContainer,
Expand Down Expand Up @@ -43,6 +46,13 @@ import type {
Parameter,
} from '@src/lib/openapi-rest'

// REST API has no right TOC column; SideNavContainer's auto margin is for centering regular docs.
const RestSideNavContainer = styled(SideNavContainer)({
[mqs.twoColumn]: {
marginRight: 0,
},
})

type TabId = 'query' | 'responses'

export type RestApiReferenceProps = {
Expand Down Expand Up @@ -94,12 +104,12 @@ export function RestApiReference({

return (
<PageGrid>
<SideNavContainer>
<RestSideNavContainer>
<SidebarNav
sections={apiSections}
selectedId={selectedId}
/>
</SideNavContainer>
</RestSideNavContainer>
<ContentContainer>
<RestContentWrapper>
<BreadcrumbsWrapper>
Expand Down
Loading