igny8/master-docs/20-api/ENDPOINTS/linker.md

Linker Endpoints

Purpose

Document linker API endpoints for internal linking operations.

Code Locations (exact paths)

• Routing: backend/igny8_core/modules/linker/urls.py
• Views: backend/igny8_core/modules/linker/views.py
• Services: backend/igny8_core/business/linking/services/*

High-Level Responsibilities

• Provide linker-related endpoints (as defined in LinkerViewSet) for managing internal linking logic.

Detailed Behavior

• Base path: /api/v1/linker/
• Router registers root LinkerViewSet (see module code for actions/fields).
• Inherits base viewset scoping, unified responses, permissions, throttling defined in module views.

Data Structures / Models Involved (no code)

• Linking-related models/services (see business/linking).

Execution Flow

• Requests → DRF auth → LinkerViewSet → service logic → unified response.

Cross-Module Interactions

• May consume writer content to generate linking recommendations; interacts with linker services.

State Transitions

• As defined by LinkerViewSet actions (not detailed in code snippet).

Error Handling

• Standard unified responses and throttling.

Tenancy Rules

• Inherits account/site scoping from base classes.

Billing Rules

• None specified.

Background Tasks / Schedulers

• None specified in endpoints.

Key Design Considerations

• Endpoint actions rely on business/linking services; keep scoping intact.

How Developers Should Work With This Module

• Extend LinkerViewSet/actions as needed; ensure base scoping and unified responses remain consistent.