Skip to main content

Entity Documentation Index

This document provides comprehensive documentation for all entities in the FishingLog system.

Documentation Files​

Entity documentation files are located in the source code repository:

Entity Categories​

Core User & Authentication​

See User & Authentication Entities for:

  • User, UserFriend, UserFollow, Circle, CircleMember, UserFavoriteSpecies

Fishing Logs & Sessions​

See Fishing Log & Session Entities for:

  • FishingSession, FishingLogEntry, CatchDetail, Telemetry, SessionTelemetry, Weather, Current

Fish Species & Taxonomy​

See Fish Species & Taxonomy for:

  • FishSpecies, FishSpeciesRelationship, TaxonomicRank

Gear Management​

See Gear Management Entities for:

  • Brand, BrandOwnershipHistory, Rod, Reel, Lure, Line, GearSetup, GearVariant, GearCategory, GearImage, GearTag, RetailLink

Data Sharing & Compliance​

See Quick Logging & DNR Access for:

  • DataSharingAgreement, DnrAccessLog

Additional Entities​

For other entities (Social Features, Media, Charters, Reviews, Groups, Events, Achievements, Marketplace, Notifications), see the entity source files in FishingLog.Infrastructure/Entities/.

Detailed Entity Documentation​

Each entity is documented with:

  • Purpose: What the entity represents
  • Key Fields: Important properties and their meanings
  • Relationships: How it connects to other entities
  • Usage Patterns: Common ways to use this entity
  • Considerations: Important notes and future-proofing considerations