Skip to content

Update OpenAPI schema#25

Merged
kantacky merged 3 commits intomainfrom
update-openapi-schema
Apr 4, 2026
Merged

Update OpenAPI schema#25
kantacky merged 3 commits intomainfrom
update-openapi-schema

Conversation

@dotto-api-schema-updater
Copy link
Copy Markdown
Contributor

This PR updates the OpenAPI schema from dotto-typespec.

Triggered by: fun-dotto/dotto-typespec@f631c30

@kantacky kantacky self-assigned this Apr 3, 2026
@kantacky kantacky marked this pull request as ready for review April 4, 2026 12:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR syncs the repository’s OpenAPI specifications and generated clients/handlers with the latest dotto-typespec updates, expanding the Admin BFF surface area for irregularity notifications, reservations, and user/FCM-token management.

Changes:

  • Updated OpenAPI specs to add endpoints/schemas for cancelled classes, makeup classes, room changes, irregularity notifications, reservations, and user/FCM token APIs (plus search params like q / floors).
  • Updated/added Gin handlers to proxy the newly introduced endpoints to upstream academic_api / user_api services.
  • Regenerated the external user_api Go client to match the new schema (FCM tokens + users list).

Reviewed changes

Copilot reviewed 13 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
openapi/openapi.yaml Main Admin BFF OpenAPI updated with new paths/tags/schemas and parameter changes.
openapi/external/user_api/openapi.yaml External user service OpenAPI updated (FCM tokens + users list).
openapi/external/academic_api/openapi.yaml External academic service OpenAPI updated (irregularities, reservations, room/cancel/makeup changes, search params).
internal/handler/user.go Added Users list + upsert handlers using the user service client.
internal/handler/fcm_token.go Added FCM token list + upsert handlers proxying to user service.
internal/handler/faculty.go Updated faculties list handler to accept q query parameter.
internal/handler/room.go Updated rooms list handler to use q + floors; removed old room-scoped reservations handler.
internal/handler/reservation.go Added reservations list/create/detail/delete handlers for new /v1/reservations routes.
internal/handler/cancelled_class.go Added cancelled classes list/create/fetch/delete handlers.
internal/handler/makeup_class.go Added makeup classes list/create/fetch/delete handlers.
internal/handler/room_change.go Added room changes list/create/fetch/delete handlers.
internal/handler/notify_irregularity.go Added irregularity notification handler.
internal/handler/subject.go Removed Subjects upsert handler to match schema removal.
generated/external/user_api/client.gen.go Regenerated user_api client with FCM token models/endpoints and users list support.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

parameters:
- name: id
in: path
required: true
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

POST /v1/users/{id} の path parameter iddescription が無く、同じパスの GET では description: ユーザーID が定義されています。OpenAPI 上の一貫性/可読性のため、POST 側にも同様の description を追加してください。

Suggested change
required: true
required: true
description: ユーザーID

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor

@hikaru-0602 hikaru-0602 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

動けば大丈夫そう

@kantacky kantacky merged commit f00c6b3 into main Apr 4, 2026
9 checks passed
@kantacky kantacky deleted the update-openapi-schema branch April 4, 2026 12:28
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.

3 participants