Skip to content

fix(api): remove incorrect 양정 default on GET /school - #9

Merged
injoon5 merged 2 commits into
mainfrom
cursor/fix-school-default-docs-fa5f
May 26, 2026
Merged

injoon5 merged 2 commits into
mainfrom
cursor/fix-school-default-docs-fa5f

Conversation

@injoon5

@injoon5 injoon5 commented May 26, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Removes the incorrect claim and behavior that GET /school defaults to 양정고등학교 when schoolname is omitted
  • Adds Fumadocs layout tabs for Client and HTTP API via root: true on folder meta.json files
  • Updates docs and OpenAPI examples to use 목운중학교 and states that school identifiers are required (no default school)

Changes

API

  • schoolname required on GET /school
  • OpenAPI + Scalar description updated

Docs site

  • content/docs/meta.json: index, client, api only (tabs replace ---Client--- / ---HTTP API--- separators)
  • client/meta.json + api/meta.json: "root": true for sidebar layout tabs
  • Intro + client overview: required schoolname / schoolcode, no default school
  • Client examples: 목운중학교 instead of 양정고등학교

Schemas

  • SchoolName examples/descriptions updated; response examples use 목운중학교

Verification

  • npm run openapi:sync
  • npm run build:docs
  • npm test
Open in Web Open in Cursor 

The OpenAPI description claimed schoolname defaulted to 양정고등학교
when omitted. schoolname is now required in the schema and handler,
matching other endpoints.

Co-authored-by: Injoon Oh <injoon5@icloud.com>
@vercel

vercel Bot commented May 26, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
school-api Ready Ready Preview, Comment May 26, 2026 4:15pm
school-api-docs Ready Ready Preview, Comment May 26, 2026 4:15pm

- Mark client/ and api/ as Fumadocs root folders for layout tabs
- Document required schoolname/schoolcode; no default school
- Replace 양정 examples with 목운중학교 in client docs and OpenAPI schemas

Co-authored-by: Injoon Oh <injoon5@icloud.com>
@injoon5
injoon5 marked this pull request as ready for review May 26, 2026 16:14
@injoon5
injoon5 merged commit 91599c3 into main May 26, 2026
5 checks passed

This branch was successfully deployed

2 active deployments
Preview – school-api-docs — 116ad93e Deployed May 26, 2026 by vercel[bot]
Preview – school-api — 116ad93e Deployed May 26, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants