Skip to content

feat: change site.json api route #8718

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

Merged
ovflowd merged 1 commit into from
Mar 12, 2026
+3 −5
Merged

feat: change site.json api route #8718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions apps/site/app/api/site.json/route.ts → apps/site/app/site.json/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
import { NextResponse } from 'next/server';

import { siteConfig } from '#site/next.json.mjs';

export const GET = () =>
NextResponse.json(siteConfig, {
Response.json(siteConfig, {
headers: {
'Cache-Control': 'public, max-age=300, stale-while-revalidate=3600',
},
Expand Down
4 changes: 2 additions & 2 deletions docs/site-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

`apps/site/site.json` is a manually maintained JSON file that controls global site metadata, RSS feeds, and time-sensitive UI elements (banners and badges).

It is imported via `apps/site/next.json.mjs` and exposed as a read-only API endpoint at `/api/site.json`.
It is imported via `apps/site/next.json.mjs` and exposed as a read-only API endpoint at `/site.json`.

This endpoint is also consumed externally by the [doc-kit](https://github.com/nodejs/doc-kit) to display dynamic banners inside the API docs, for example security announcements or EOL notices, without requiring a doc-kit release.

Expand Down Expand Up @@ -117,7 +117,7 @@ A map of page slugs to badge definitions. Badges appear as small promotional lab
The full contents of `site.json` are available at:

```
GET /api/site.json
GET /site.json
```

The response is `application/json` and is statically cached at build time. It refreshes on each deployment.
Expand Down
Loading