Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion .github/workflows/sync-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,17 @@ on:
- "apps/docs/scripts/**"
- ".github/workflows/sync-docs.yml"

# Least privilege by default; only the auto-commit job elevates to write.
permissions:
contents: write
contents: read

jobs:
pr-check:
name: Verify OpenAPI docs are up to date
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v4

Expand All @@ -46,6 +49,12 @@ jobs:
name: Auto-commit OpenAPI docs on main
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions:
contents: write
# Serialize auto-commits so concurrent merges to main can't race on the push.
concurrency:
group: sync-docs-main
cancel-in-progress: false
steps:
- uses: actions/checkout@v4
with:
Expand Down
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,10 @@ __pycache__/
.env
.env.local
.DS_Store

# Editor state
.idea/
.vscode/

# Local Comcigan debug dump (not a source artifact)
timetable.json
6 changes: 0 additions & 6 deletions .idea/inspectionProfiles/profiles_settings.xml

This file was deleted.

7 changes: 0 additions & 7 deletions .idea/misc.xml

This file was deleted.

8 changes: 0 additions & 8 deletions .idea/modules.xml

This file was deleted.

11 changes: 0 additions & 11 deletions .idea/mogun_api.iml

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/vcs.xml

This file was deleted.

166 changes: 0 additions & 166 deletions .idea/workspace.xml

This file was deleted.

15 changes: 0 additions & 15 deletions .vscode/launch.json

This file was deleted.

2 changes: 1 addition & 1 deletion apps/docs/app/docs/[[...slug]]/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export default async function Page(props: PageProps<'/docs/[[...slug]]'>) {
<MarkdownCopyButton markdownUrl={markdownUrl} />
<ViewOptionsPopover
markdownUrl={markdownUrl}
githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/content/docs/${page.path}`}
githubUrl={`https://github.com/${gitConfig.user}/${gitConfig.repo}/blob/${gitConfig.branch}/apps/docs/content/docs/${page.path}`}
/>
</div>
<DocsBody>
Expand Down
19 changes: 10 additions & 9 deletions apps/docs/openapi/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,12 @@
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
Expand All @@ -712,15 +718,14 @@
"$id": "#/components/schemas/ApiError"
},
"SchoolInfoList": {
"minItems": 1,
"examples": [
[
{
"ATPT_OFCDC_SC_CODE": "B10",
"ATPT_OFCDC_SC_NM": "서울특별시교육청",
"SD_SCHUL_CODE": "7010208",
"SCHUL_NM": "목운중학교",
"ENG_SCHUL_NM": "Yangchung High School",
"SCHUL_NM": "양정고등학교",
"ENG_SCHUL_NM": "Yangjeong High School",
"SCHUL_KND_SC_NM": "고등학교",
"LCTN_SC_NM": "서울특별시",
"JU_ORG_NM": "서울특별시교육청",
Expand Down Expand Up @@ -796,14 +801,14 @@
"SCHUL_NM": {
"description": "School name",
"examples": [
"목운중학교"
"양정고등학교"
],
"type": "string"
},
"ENG_SCHUL_NM": {
"description": "English school name",
"examples": [
"Yangchung High School"
"Yangjeong High School"
],
"type": "string"
},
Expand Down Expand Up @@ -972,7 +977,6 @@
],
"properties": {
"day_time": {
"minItems": 1,
"examples": [
[
"09:00",
Expand All @@ -989,7 +993,6 @@
}
},
"timetable": {
"minItems": 1,
"examples": [
[
[
Expand Down Expand Up @@ -1123,7 +1126,6 @@
"$id": "#/components/schemas/TimetableResponse"
},
"MealList": {
"minItems": 1,
"examples": [
[
{
Expand Down Expand Up @@ -1276,7 +1278,6 @@
"$id": "#/components/schemas/MealList"
},
"ScheduleList": {
"minItems": 1,
"examples": [
[
{
Expand Down
Loading
Loading