data-api-builder-relations

Define reciprocal relationships in Data API Builder dab-config.json files.

1|1|Updated Feb 26, 2026
One-click install
npx skills add https://github.com/JerryNixon/vslive-2026-las-demos --skill data-api-builder-relations
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: data-api-builder-relations
Source: https://github.com/JerryNixon/vslive-2026-las-demos/tree/main/.github/skills/data-api-builder-relations
Command: npx skills add https://github.com/JerryNixon/vslive-2026-las-demos --skill data-api-builder-relations

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Define and manage reciprocal relationships in Data API Builder (DAB) configuration files to enable bidirectional navigation and consistent APIs across REST and GraphQL.

Core Features & Use Cases

  • Reciprocal Pair Pattern: always create inverse relationships to keep both sides in sync
  • Explicit field mappings: require source.fields and target.fields for clarity and reliability
  • Many-to-many support: handle linking.object for join tables and ensure consistency
  • Use cases: when asked to connect tables, define navigation properties, or enforce bidirectional API consistency

Quick Start

Create or update dab-config.json entries to define reciprocal relationships for neighboring entities.

Frequently Asked Questions about data-api-builder-relations

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I define reciprocal relationships in a Data API Builder configuration?

To define reciprocal relationships in Data API Builder, you create inverse relationship pairs for entities within your dab-config.json file. This ensures explicit source and target fields are mapped to support bidirectional navigation in both REST and GraphQL endpoints.

How do I configure many-to-many linking objects for DAB REST and GraphQL endpoints?

Configuring many-to-many linking objects for DAB endpoints requires defining the joining table within your dab-config.json. You must ensure consistent reciprocal pairs and explicit field mappings to properly support navigation across both REST and GraphQL APIs.

Why do I need explicit source and target fields for Data API Builder relationships?

Explicit source and target fields are required for Data API Builder relationships to guarantee clarity and reliability. Defining source.fields and target.fields ensures that reciprocal pairs remain synchronized for accurate bidirectional navigation in REST and GraphQL.

When should I enforce bidirectional navigation in dab-config.json?

You should enforce bidirectional navigation in dab-config.json whenever you connect tables or define navigation properties. Applying reciprocal relationships ensures consistent API behavior and allows clients to traverse data seamlessly across REST and GraphQL endpoints.

Does Data API Builder support automatic reciprocal pairs for GraphQL APIs?

Data API Builder supports reciprocal pairs for GraphQL APIs by enforcing them within your dab-config.json configuration. Applying this pattern ensures that both sides of a relationship remain in sync for consistent bidirectional data navigation.