メニュー
Update Book Corners API behavior and documentation. Use when changing API endpoints, API schemas, API URL routing, search behavior used by the API, OpenAPI output, or API-facing request/response shapes.
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
SOC 職業分類に基づく
| name | book-corners-api-workflow |
| description | Update Book Corners API behavior and documentation. Use when changing API endpoints, API schemas, API URL routing, search behavior used by the API, OpenAPI output, or API-facing request/response shapes. |
Use this workflow for API-facing changes in libraries/api.py, libraries/api_schemas.py, libraries/search.py, URL routing, or related docs.
When any API endpoint, parameter, request schema, response schema, or API search behavior changes:
docs/.docs/changelog.md with a brief entry under a version heading.For list and search changes, the usual docs file is docs/libraries/list-and-search.md.
docs/openapi.json is generated and gitignored. Do not commit it. The docs CI workflow regenerates it automatically on push.
Export the generated OpenAPI schema when you need to inspect it locally:
python manage.py export_openapi_schema > docs/openapi.json
Build and preview docs locally:
zensical serve
zensical build
If an API change mirrors a website feature, coordinate with the website behavior:
If the user requests a website-only feature, ask whether API parity is needed before implementing the website change.
Before finishing API work:
docs/changelog.md includes API feature additions, changes, or removals.docs/openapi.json uncommitted.Apply Book Corners Django/PostGIS domain knowledge. Use when changing models, migrations, queries, admin behavior, seed data, fixtures, geospatial behavior, slug generation, dependencies, or core library/user app architecture.
Run Book Corners local development commands. Use when starting services, running tests, applying migrations, building CSS, running the dev server, seeding demo data, or building local docs.
Handle Book Corners website UI work and validation. Use when changing Django templates, views, forms, JavaScript, HTMX interactions, static assets, CSS/Tailwind, browser behavior, or user-facing website text.
Create a GitHub issue/ticket for the Book Corners backend/web repo. Use whenever the user wants to file a bug, create a ticket, open an issue, report a problem, or request a feature/enhancement/documentation change for andreagrandi/book-corners.
Create Book Corners GitHub issues and add them to the Book Corners GitHub Project. Use when the user asks to add a ticket, create an issue, file a bug, or record an enhancement/documentation work item for this repository.
Handle Book Corners deployment, hosting, production logs, infrastructure, and environment configuration. Use for Dokku, VPS, DNS, SSL, Grafana Loki, production debugging, deploys, rollbacks, backups, or operational commands.