<!-- Generated by scripts/generate_ai_collab_docs.py. Edit metadata in that script. -->

# Backend Service: resource

This file adds local guidance for `src/api/flaskr/service/resource`. Read the
repository root and `src/api/AGENTS.md` first, then use this file for
module-specific ownership and risk points.

## Scope

- This service owns resource metadata and resource-usage persistence,
  currently centered on the service data model layer.

- Primary checked-in entry files today:
  `src/api/flaskr/service/resource/models.py`

- Keep behavior in this module unless the concern is clearly cross-service and
  shared by multiple backend domains.

- Preferred pytest location: `src/api/tests/service/resource/` does not exist
  yet; create it when this service gains or changes behavior.

## Do

- Start from the local entry files and preserve how this service already
  structures helpers, models, routes, and DTO-like helpers.

- Keep resource and usage records aligned with business-key and index
  conventions because other modules may read them indirectly.

- Treat this directory as a data-model boundary until explicit service helpers
  or routes are introduced.

- Add new query or mutation helpers here instead of scattering raw resource
  table access through unrelated services.

## Avoid

- Do not let other modules invent incompatible meanings for resource rows or
  usage rows without updating the owning models.

- Do not grow hidden behavior in compiled artifacts or untracked files when
  the checked-in model layer is the source of truth.

- Do not skip migration review when resource columns or indexes move.

- Avoid scattering service-specific rules upward into root docs when the
  behavior only matters inside this module.

## Commands

- `rg -n "resource" src/api/flaskr/service src/api/tests` to locate all
  backend call sites and tests before editing.

- `cd src/api && pytest -q` until `src/api/tests/service/resource/` exists;
  create that directory first when this service gains behavior that needs
  focused regression coverage.

- `cd src/api && FLASK_APP=app.py flask db migrate -m "message"` and review
  the generated revision if schema or indexed business-key changes are made.

- `cd src/api && pytest -q` when a change touches shared DTOs, auth, streaming
  contracts, or other services in addition to this module.

## Tests

- Add or update focused tests around `src/api/tests/service/resource/` for the
  happy path and the highest-risk validation, permission, or failure case.

- Expand coverage when payload shapes, error codes, or shared helper contracts
  used outside this module change.

- Review persistence-related changes manually for indexing, business-key
  semantics, and migration output whenever models move.

- Document any skipped provider, network, or credential-dependent checks in
  the final task summary.

## Related Skills

- `src/api/SKILL.md`

- `SKILL.md`

- Create a new backend skill under `src/api/skills/<topic>/SKILL.md` when this
  module grows a repeatable multi-step debugging workflow.
